API reference - Class QAudioFormat

!=

Signature: [const] bool != (const QAudioFormat other)

Description: Method bool QAudioFormat::operator!=(const QAudioFormat &other)

==

Signature: [const] bool == (const QAudioFormat other)

Description: Method bool QAudioFormat::operator==(const QAudioFormat &other)

BigEndian

Signature: [static,const] QAudioFormat_Endian BigEndian

Description: Enum constant QAudioFormat::BigEndian

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

Float

Signature: [static,const] QAudioFormat_SampleType Float

Description: Enum constant QAudioFormat::Float

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

LittleEndian

Signature: [static,const] QAudioFormat_Endian LittleEndian

Description: Enum constant QAudioFormat::LittleEndian

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

SignedInt

Signature: [static,const] QAudioFormat_SampleType SignedInt

Description: Enum constant QAudioFormat::SignedInt

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

UnSignedInt

Signature: [static,const] QAudioFormat_SampleType UnSignedInt

Description: Enum constant QAudioFormat::UnSignedInt

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

Unknown

Signature: [static,const] QAudioFormat_SampleType Unknown

Description: Enum constant QAudioFormat::Unknown

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

_assign

Signature: void _assign (const QAudioFormat other)

Description: Assigns another object to self

_const_cast

Signature: [const] QAudioFormat 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: QAudioFormat assign (const QAudioFormat other)

Description: Method QAudioFormat &QAudioFormat::operator=(const QAudioFormat &other)

byteOrder

Signature: [const] QAudioFormat_Endian byteOrder

Description: Method QAudioFormat::Endian QAudioFormat::byteOrder()

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

byteOrder=

Signature: void byteOrder= (const QAudioFormat_Endian byteOrder)

Description: Method void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)

Python specific notes:
The object exposes a writable attribute 'byteOrder'. This is the setter.

bytesForDuration

Signature: [const] int bytesForDuration (long long duration)

Description: Method qint32 QAudioFormat::bytesForDuration(qint64 duration)

bytesForFrames

Signature: [const] int bytesForFrames (int frameCount)

Description: Method qint32 QAudioFormat::bytesForFrames(qint32 frameCount)

bytesPerFrame

Signature: [const] int bytesPerFrame

Description: Method int QAudioFormat::bytesPerFrame()

channelCount

Signature: [const] int channelCount

Description: Method int QAudioFormat::channelCount()

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

channelCount=

Signature: void channelCount= (int channelCount)

Description: Method void QAudioFormat::setChannelCount(int channelCount)

Python specific notes:
The object exposes a writable attribute 'channelCount'. This is the setter.

codec

Signature: [const] string codec

Description: Method QString QAudioFormat::codec()

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

codec=

Signature: void codec= (string codec)

Description: Method void QAudioFormat::setCodec(const QString &codec)

Python specific notes:
The object exposes a writable attribute 'codec'. This is the setter.

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 QAudioFormat ptr dup

Description: Creates a copy of self

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

durationForBytes

Signature: [const] long long durationForBytes (int byteCount)

Description: Method qint64 QAudioFormat::durationForBytes(qint32 byteCount)

durationForFrames

Signature: [const] long long durationForFrames (int frameCount)

Description: Method qint64 QAudioFormat::durationForFrames(qint32 frameCount)

framesForBytes

Signature: [const] int framesForBytes (int byteCount)

Description: Method qint32 QAudioFormat::framesForBytes(qint32 byteCount)

framesForDuration

Signature: [const] int framesForDuration (long long duration)

Description: Method qint32 QAudioFormat::framesForDuration(qint64 duration)

isValid?

Signature: [const] bool isValid?

Description: Method bool QAudioFormat::isValid()

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 QAudioFormat new

Description: Constructor QAudioFormat::QAudioFormat()

This method creates an object of class QAudioFormat.

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

(2) Signature: [static] new QAudioFormat new (const QAudioFormat other)

Description: Constructor QAudioFormat::QAudioFormat(const QAudioFormat &other)

This method creates an object of class QAudioFormat.

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

sampleRate

Signature: [const] int sampleRate

Description: Method int QAudioFormat::sampleRate()

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

sampleRate=

Signature: void sampleRate= (int sampleRate)

Description: Method void QAudioFormat::setSampleRate(int sampleRate)

Python specific notes:
The object exposes a writable attribute 'sampleRate'. This is the setter.

sampleSize

Signature: [const] int sampleSize

Description: Method int QAudioFormat::sampleSize()

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

sampleSize=

Signature: void sampleSize= (int sampleSize)

Description: Method void QAudioFormat::setSampleSize(int sampleSize)

Python specific notes:
The object exposes a writable attribute 'sampleSize'. This is the setter.

sampleType

Signature: [const] QAudioFormat_SampleType sampleType

Description: Method QAudioFormat::SampleType QAudioFormat::sampleType()

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

sampleType=

Signature: void sampleType= (const QAudioFormat_SampleType sampleType)

Description: Method void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)

Python specific notes:
The object exposes a writable attribute 'sampleType'. This is the setter.

setByteOrder

Signature: void setByteOrder (const QAudioFormat_Endian byteOrder)

Description: Method void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)

Python specific notes:
The object exposes a writable attribute 'byteOrder'. This is the setter.

setChannelCount

Signature: void setChannelCount (int channelCount)

Description: Method void QAudioFormat::setChannelCount(int channelCount)

Python specific notes:
The object exposes a writable attribute 'channelCount'. This is the setter.

setCodec

Signature: void setCodec (string codec)

Description: Method void QAudioFormat::setCodec(const QString &codec)

Python specific notes:
The object exposes a writable attribute 'codec'. This is the setter.

setSampleRate

Signature: void setSampleRate (int sampleRate)

Description: Method void QAudioFormat::setSampleRate(int sampleRate)

Python specific notes:
The object exposes a writable attribute 'sampleRate'. This is the setter.

setSampleSize

Signature: void setSampleSize (int sampleSize)

Description: Method void QAudioFormat::setSampleSize(int sampleSize)

Python specific notes:
The object exposes a writable attribute 'sampleSize'. This is the setter.

setSampleType

Signature: void setSampleType (const QAudioFormat_SampleType sampleType)

Description: Method void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)

Python specific notes:
The object exposes a writable attribute 'sampleType'. This is the setter.