KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class QAudio

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, State, QFlags_State

Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description

Public constructors

new QAudio ptr

new

Creates a new object of this class

Public methods

	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

Public static methods and constants

[static,const]	QAudio_State	ActiveState	Enum constant QAudio::ActiveState
[static,const]	QAudio_Mode	AudioInput	Enum constant QAudio::AudioInput
[static,const]	QAudio_Mode	AudioOutput	Enum constant QAudio::AudioOutput
[static,const]	QAudio_Error	FatalError	Enum constant QAudio::FatalError
[static,const]	QAudio_Error	IOError	Enum constant QAudio::IOError
[static,const]	QAudio_State	IdleState	Enum constant QAudio::IdleState
[static,const]	QAudio_Error	NoError	Enum constant QAudio::NoError
[static,const]	QAudio_Error	OpenError	Enum constant QAudio::OpenError
[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

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

	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

Detailed description

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.
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.
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.
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.
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.
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.
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.
_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.

API reference - Class QAudio

Public constructors

Public methods

Public static methods and constants

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

Detailed description

ActiveState

AudioInput

AudioOutput

FatalError

IOError

IdleState

NoError

OpenError

StoppedState

SuspendedState

UnderrunError

_create

_destroy

_destroyed?

_is_const_object?

_manage

_unmanage

assign

create

destroy

destroyed?

dup

is_const_object?

new