KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QAudio

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

Public constructors

new QAudio ptrnewCreates a new object of this class

Public methods

[const]QAudio ptr_const_castReturns a non-const reference to self.
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 other)Assigns another object to self
[const]new QAudio ptrdupCreates a copy of self

Public static methods and constants

[static,const]QAudio_RoleAccessibilityRoleEnum constant QAudio::AccessibilityRole
[static,const]QAudio_StateActiveStateEnum constant QAudio::ActiveState
[static,const]QAudio_RoleAlarmRoleEnum constant QAudio::AlarmRole
[static,const]QAudio_ModeAudioInputEnum constant QAudio::AudioInput
[static,const]QAudio_ModeAudioOutputEnum constant QAudio::AudioOutput
[static,const]QAudio_VolumeScaleCubicVolumeScaleEnum constant QAudio::CubicVolumeScale
[static,const]QAudio_RoleCustomRoleEnum constant QAudio::CustomRole
[static,const]QAudio_VolumeScaleDecibelVolumeScaleEnum constant QAudio::DecibelVolumeScale
[static,const]QAudio_ErrorFatalErrorEnum constant QAudio::FatalError
[static,const]QAudio_RoleGameRoleEnum constant QAudio::GameRole
[static,const]QAudio_ErrorIOErrorEnum constant QAudio::IOError
[static,const]QAudio_StateIdleStateEnum constant QAudio::IdleState
[static,const]QAudio_StateInterruptedStateEnum constant QAudio::InterruptedState
[static,const]QAudio_VolumeScaleLinearVolumeScaleEnum constant QAudio::LinearVolumeScale
[static,const]QAudio_VolumeScaleLogarithmicVolumeScaleEnum constant QAudio::LogarithmicVolumeScale
[static,const]QAudio_RoleMusicRoleEnum constant QAudio::MusicRole
[static,const]QAudio_ErrorNoErrorEnum constant QAudio::NoError
[static,const]QAudio_RoleNotificationRoleEnum constant QAudio::NotificationRole
[static,const]QAudio_ErrorOpenErrorEnum constant QAudio::OpenError
[static,const]QAudio_RoleRingtoneRoleEnum constant QAudio::RingtoneRole
[static,const]QAudio_RoleSonificationRoleEnum constant QAudio::SonificationRole
[static,const]QAudio_StateStoppedStateEnum constant QAudio::StoppedState
[static,const]QAudio_StateSuspendedStateEnum constant QAudio::SuspendedState
[static,const]QAudio_ErrorUnderrunErrorEnum constant QAudio::UnderrunError
[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

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.

ActiveState

Signature: [static,const] QAudio_State ActiveState

Description: Enum constant QAudio::ActiveState

Python specific notes:
The object exposes a readable attribute 'ActiveState'. 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.

AudioInput

Signature: [static,const] QAudio_Mode AudioInput

Description: Enum constant QAudio::AudioInput

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

AudioOutput

Signature: [static,const] QAudio_Mode AudioOutput

Description: Enum constant QAudio::AudioOutput

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

CubicVolumeScale

Signature: [static,const] QAudio_VolumeScale CubicVolumeScale

Description: Enum constant QAudio::CubicVolumeScale

Python specific notes:
The object exposes a readable attribute 'CubicVolumeScale'. 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.

DecibelVolumeScale

Signature: [static,const] QAudio_VolumeScale DecibelVolumeScale

Description: Enum constant QAudio::DecibelVolumeScale

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

FatalError

Signature: [static,const] QAudio_Error FatalError

Description: Enum constant QAudio::FatalError

Python specific notes:
The object exposes a readable attribute 'FatalError'. 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.

IOError

Signature: [static,const] QAudio_Error IOError

Description: Enum constant QAudio::IOError

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

IdleState

Signature: [static,const] QAudio_State IdleState

Description: Enum constant QAudio::IdleState

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

InterruptedState

Signature: [static,const] QAudio_State InterruptedState

Description: Enum constant QAudio::InterruptedState

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

LinearVolumeScale

Signature: [static,const] QAudio_VolumeScale LinearVolumeScale

Description: Enum constant QAudio::LinearVolumeScale

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

LogarithmicVolumeScale

Signature: [static,const] QAudio_VolumeScale LogarithmicVolumeScale

Description: Enum constant QAudio::LogarithmicVolumeScale

Python specific notes:
The object exposes a readable attribute 'LogarithmicVolumeScale'. 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.

NoError

Signature: [static,const] QAudio_Error NoError

Description: Enum constant QAudio::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. 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.

OpenError

Signature: [static,const] QAudio_Error OpenError

Description: Enum constant QAudio::OpenError

Python specific notes:
The object exposes a readable attribute 'OpenError'. 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.

StoppedState

Signature: [static,const] QAudio_State StoppedState

Description: Enum constant QAudio::StoppedState

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

SuspendedState

Signature: [static,const] QAudio_State SuspendedState

Description: Enum constant QAudio::SuspendedState

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

UnderrunError

Signature: [static,const] QAudio_Error UnderrunError

Description: Enum constant QAudio::UnderrunError

Python specific notes:
The object exposes a readable attribute 'UnderrunError'. 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.

_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:
This method also implements '__copy__' and '__deepcopy__'.

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:
This method is the default initializer of the object.