Notation used in Ruby API documentation
Module: QtMultimedia
Description: This class represents the QAudio namespace
Sub-classes: Error, QFlags_Error, Mode, QFlags_Mode, Role, QFlags_Role, State, QFlags_State, VolumeScale, QFlags_VolumeScale
new QAudio ptr | new | Creates a new object of this class |
[const] | QAudio ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
void | assign | (const QAudio other) | Assigns another object to self | |
[const] | new QAudio ptr | dup | Creates a copy of self |
[static,const] | QAudio_Role | AccessibilityRole | Enum constant QAudio::AccessibilityRole | |
[static,const] | QAudio_State | ActiveState | Enum constant QAudio::ActiveState | |
[static,const] | QAudio_Role | AlarmRole | Enum constant QAudio::AlarmRole | |
[static,const] | QAudio_Mode | AudioInput | Enum constant QAudio::AudioInput | |
[static,const] | QAudio_Mode | AudioOutput | Enum constant QAudio::AudioOutput | |
[static,const] | QAudio_VolumeScale | CubicVolumeScale | Enum constant QAudio::CubicVolumeScale | |
[static,const] | QAudio_Role | CustomRole | Enum constant QAudio::CustomRole | |
[static,const] | QAudio_VolumeScale | DecibelVolumeScale | Enum constant QAudio::DecibelVolumeScale | |
[static,const] | QAudio_Error | FatalError | Enum constant QAudio::FatalError | |
[static,const] | QAudio_Role | GameRole | Enum constant QAudio::GameRole | |
[static,const] | QAudio_Error | IOError | Enum constant QAudio::IOError | |
[static,const] | QAudio_State | IdleState | Enum constant QAudio::IdleState | |
[static,const] | QAudio_State | InterruptedState | Enum constant QAudio::InterruptedState | |
[static,const] | QAudio_VolumeScale | LinearVolumeScale | Enum constant QAudio::LinearVolumeScale | |
[static,const] | QAudio_VolumeScale | LogarithmicVolumeScale | Enum constant QAudio::LogarithmicVolumeScale | |
[static,const] | QAudio_Role | MusicRole | Enum constant QAudio::MusicRole | |
[static,const] | QAudio_Error | NoError | Enum constant QAudio::NoError | |
[static,const] | QAudio_Role | NotificationRole | Enum constant QAudio::NotificationRole | |
[static,const] | QAudio_Error | OpenError | Enum constant QAudio::OpenError | |
[static,const] | QAudio_Role | RingtoneRole | Enum constant QAudio::RingtoneRole | |
[static,const] | QAudio_Role | SonificationRole | Enum constant QAudio::SonificationRole | |
[static,const] | QAudio_State | StoppedState | Enum constant QAudio::StoppedState | |
[static,const] | QAudio_State | SuspendedState | Enum constant QAudio::SuspendedState | |
[static,const] | QAudio_Error | UnderrunError | Enum constant QAudio::UnderrunError | |
[static,const] | QAudio_Role | UnknownRole | Enum constant QAudio::UnknownRole | |
[static,const] | QAudio_Role | VideoRole | Enum constant QAudio::VideoRole | |
[static,const] | QAudio_Role | VoiceCommunicationRole | Enum constant QAudio::VoiceCommunicationRole |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
AccessibilityRole | Signature: [static,const] QAudio_Role AccessibilityRole Description: Enum constant QAudio::AccessibilityRole Python specific notes: |
ActiveState | Signature: [static,const] QAudio_State ActiveState Description: Enum constant QAudio::ActiveState Python specific notes: |
AlarmRole | Signature: [static,const] QAudio_Role AlarmRole Description: Enum constant QAudio::AlarmRole Python specific notes: |
AudioInput | Signature: [static,const] QAudio_Mode AudioInput Description: Enum constant QAudio::AudioInput Python specific notes: |
AudioOutput | Signature: [static,const] QAudio_Mode AudioOutput Description: Enum constant QAudio::AudioOutput Python specific notes: |
CubicVolumeScale | Signature: [static,const] QAudio_VolumeScale CubicVolumeScale Description: Enum constant QAudio::CubicVolumeScale Python specific notes: |
CustomRole | Signature: [static,const] QAudio_Role CustomRole Description: Enum constant QAudio::CustomRole Python specific notes: |
DecibelVolumeScale | Signature: [static,const] QAudio_VolumeScale DecibelVolumeScale Description: Enum constant QAudio::DecibelVolumeScale Python specific notes: |
FatalError | Signature: [static,const] QAudio_Error FatalError Description: Enum constant QAudio::FatalError Python specific notes: |
GameRole | Signature: [static,const] QAudio_Role GameRole Description: Enum constant QAudio::GameRole Python specific notes: |
IOError | Signature: [static,const] QAudio_Error IOError Description: Enum constant QAudio::IOError Python specific notes: |
IdleState | Signature: [static,const] QAudio_State IdleState Description: Enum constant QAudio::IdleState Python specific notes: |
InterruptedState | Signature: [static,const] QAudio_State InterruptedState Description: Enum constant QAudio::InterruptedState Python specific notes: |
LinearVolumeScale | Signature: [static,const] QAudio_VolumeScale LinearVolumeScale Description: Enum constant QAudio::LinearVolumeScale Python specific notes: |
LogarithmicVolumeScale | Signature: [static,const] QAudio_VolumeScale LogarithmicVolumeScale Description: Enum constant QAudio::LogarithmicVolumeScale Python specific notes: |
MusicRole | Signature: [static,const] QAudio_Role MusicRole Description: Enum constant QAudio::MusicRole Python specific notes: |
NoError | Signature: [static,const] QAudio_Error NoError Description: Enum constant QAudio::NoError Python specific notes: |
NotificationRole | Signature: [static,const] QAudio_Role NotificationRole Description: Enum constant QAudio::NotificationRole Python specific notes: |
OpenError | Signature: [static,const] QAudio_Error OpenError Description: Enum constant QAudio::OpenError Python specific notes: |
RingtoneRole | Signature: [static,const] QAudio_Role RingtoneRole Description: Enum constant QAudio::RingtoneRole Python specific notes: |
SonificationRole | Signature: [static,const] QAudio_Role SonificationRole Description: Enum constant QAudio::SonificationRole Python specific notes: |
StoppedState | Signature: [static,const] QAudio_State StoppedState Description: Enum constant QAudio::StoppedState Python specific notes: |
SuspendedState | Signature: [static,const] QAudio_State SuspendedState Description: Enum constant QAudio::SuspendedState Python specific notes: |
UnderrunError | Signature: [static,const] QAudio_Error UnderrunError Description: Enum constant QAudio::UnderrunError Python specific notes: |
UnknownRole | Signature: [static,const] QAudio_Role UnknownRole Description: Enum constant QAudio::UnknownRole Python specific notes: |
VideoRole | Signature: [static,const] QAudio_Role VideoRole Description: Enum constant QAudio::VideoRole Python specific notes: |
VoiceCommunicationRole | Signature: [static,const] QAudio_Role VoiceCommunicationRole Description: Enum constant QAudio::VoiceCommunicationRole Python specific notes: |
_const_cast | Signature: [const] QAudio ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_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 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 ptr dup Description: Creates a copy of self Python specific notes: |
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 | Signature: [static] new QAudio ptr new Description: Creates a new object of this class Python specific notes: |