API reference - Class QAudio_Role

Notation used in Ruby API documentation

Module: QtMultimedia

Description: This class represents the QAudio::Role enum

This class is equivalent to the class QAudio::Role

Public constructors

new QAudio_Role ptrnew(int i)Creates an enum from an integer value
new QAudio_Role ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QAudio_Role other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QAudio_Role other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QAudio_Role other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QAudio_Role other)Assigns another object to self
[const]new QAudio_Role ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QAudio_QFlags_Role|(const QAudio_Role other)Creates a flag set by combining the two flags
[const]QAudio_QFlags_Role|(const QAudio_QFlags_Role other)Combines the flag and the flag set

Public static methods and constants

[static,const]QAudio_RoleAccessibilityRoleEnum constant QAudio::AccessibilityRole
[static,const]QAudio_RoleAlarmRoleEnum constant QAudio::AlarmRole
[static,const]QAudio_RoleCustomRoleEnum constant QAudio::CustomRole
[static,const]QAudio_RoleGameRoleEnum constant QAudio::GameRole
[static,const]QAudio_RoleMusicRoleEnum constant QAudio::MusicRole
[static,const]QAudio_RoleNotificationRoleEnum constant QAudio::NotificationRole
[static,const]QAudio_RoleRingtoneRoleEnum constant QAudio::RingtoneRole
[static,const]QAudio_RoleSonificationRoleEnum constant QAudio::SonificationRole
[static,const]QAudio_RoleUnknownRoleEnum constant QAudio::UnknownRole
[static,const]QAudio_RoleVideoRoleEnum constant QAudio::VideoRole
[static,const]QAudio_RoleVoiceCommunicationRoleEnum constant QAudio::VoiceCommunicationRole

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

(1) Signature: [const] bool != (const QAudio_Role other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QAudio_Role other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QAudio_Role other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

AccessibilityRole

Signature: [static,const] QAudio_Role AccessibilityRole

Description: Enum constant QAudio::AccessibilityRole

Python specific notes:
The object exposes a readable attribute 'AccessibilityRole'. This is the getter.

AlarmRole

Signature: [static,const] QAudio_Role AlarmRole

Description: Enum constant QAudio::AlarmRole

Python specific notes:
The object exposes a readable attribute 'AlarmRole'. This is the getter.

CustomRole

Signature: [static,const] QAudio_Role CustomRole

Description: Enum constant QAudio::CustomRole

Python specific notes:
The object exposes a readable attribute 'CustomRole'. This is the getter.

GameRole

Signature: [static,const] QAudio_Role GameRole

Description: Enum constant QAudio::GameRole

Python specific notes:
The object exposes a readable attribute 'GameRole'. This is the getter.

MusicRole

Signature: [static,const] QAudio_Role MusicRole

Description: Enum constant QAudio::MusicRole

Python specific notes:
The object exposes a readable attribute 'MusicRole'. This is the getter.

NotificationRole

Signature: [static,const] QAudio_Role NotificationRole

Description: Enum constant QAudio::NotificationRole

Python specific notes:
The object exposes a readable attribute 'NotificationRole'. This is the getter.

RingtoneRole

Signature: [static,const] QAudio_Role RingtoneRole

Description: Enum constant QAudio::RingtoneRole

Python specific notes:
The object exposes a readable attribute 'RingtoneRole'. This is the getter.

SonificationRole

Signature: [static,const] QAudio_Role SonificationRole

Description: Enum constant QAudio::SonificationRole

Python specific notes:
The object exposes a readable attribute 'SonificationRole'. This is the getter.

UnknownRole

Signature: [static,const] QAudio_Role UnknownRole

Description: Enum constant QAudio::UnknownRole

Python specific notes:
The object exposes a readable attribute 'UnknownRole'. This is the getter.

VideoRole

Signature: [static,const] QAudio_Role VideoRole

Description: Enum constant QAudio::VideoRole

Python specific notes:
The object exposes a readable attribute 'VideoRole'. This is the getter.

VoiceCommunicationRole

Signature: [static,const] QAudio_Role VoiceCommunicationRole

Description: Enum constant QAudio::VoiceCommunicationRole

Python specific notes:
The object exposes a readable attribute 'VoiceCommunicationRole'. This is the getter.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QAudio_Role other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QAudio_Role ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QAudio_Role ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QAudio_Role ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] QAudio_QFlags_Role | (const QAudio_Role other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QAudio_QFlags_Role | (const QAudio_QFlags_Role other)

Description: Combines the flag and the flag set