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

API reference - Class QMediaResource

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaResource

Public constructors

new QMediaResourcenewConstructor QMediaResource::QMediaResource()
new QMediaResourcenew(const QUrl url,
string mimeType = QString())
Constructor QMediaResource::QMediaResource(const QUrl &url, const QString &mimeType)
new QMediaResourcenew(const QNetworkRequest request,
string mimeType = QString())
Constructor QMediaResource::QMediaResource(const QNetworkRequest &request, const QString &mimeType)
new QMediaResourcenew(const QMediaResource other)Constructor QMediaResource::QMediaResource(const QMediaResource &other)

Public methods

[const]bool!=(const QMediaResource other)Method bool QMediaResource::operator !=(const QMediaResource &other)
[const]bool==(const QMediaResource other)Method bool QMediaResource::operator ==(const QMediaResource &other)
void_assign(const QMediaResource other)Assigns another object to self
[const]QMediaResource 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.
QMediaResourceassign(const QMediaResource other)Method QMediaResource &QMediaResource::operator =(const QMediaResource &other)
[const]intaudioBitRateMethod int QMediaResource::audioBitRate()
voidaudioBitRate=(int rate)Method void QMediaResource::setAudioBitRate(int rate)
[const]stringaudioCodecMethod QString QMediaResource::audioCodec()
voidaudioCodec=(string codec)Method void QMediaResource::setAudioCodec(const QString &codec)
[const]intchannelCountMethod int QMediaResource::channelCount()
voidchannelCount=(int channels)Method void QMediaResource::setChannelCount(int channels)
[const]long longdataSizeMethod qint64 QMediaResource::dataSize()
voiddataSize=(long long size)Method void QMediaResource::setDataSize(const qint64 size)
[const]new QMediaResource ptrdupCreates a copy of self
[const]boolisNull?Method bool QMediaResource::isNull()
[const]stringlanguageMethod QString QMediaResource::language()
voidlanguage=(string language)Method void QMediaResource::setLanguage(const QString &language)
[const]stringmimeTypeMethod QString QMediaResource::mimeType()
[const]QNetworkRequestrequestMethod QNetworkRequest QMediaResource::request()
[const]QSizeresolutionMethod QSize QMediaResource::resolution()
voidresolution=(const QSize resolution)Method void QMediaResource::setResolution(const QSize &resolution)
[const]intsampleRateMethod int QMediaResource::sampleRate()
voidsampleRate=(int frequency)Method void QMediaResource::setSampleRate(int frequency)
voidsetAudioBitRate(int rate)Method void QMediaResource::setAudioBitRate(int rate)
voidsetAudioCodec(string codec)Method void QMediaResource::setAudioCodec(const QString &codec)
voidsetChannelCount(int channels)Method void QMediaResource::setChannelCount(int channels)
voidsetDataSize(long long size)Method void QMediaResource::setDataSize(const qint64 size)
voidsetLanguage(string language)Method void QMediaResource::setLanguage(const QString &language)
voidsetResolution(const QSize resolution)Method void QMediaResource::setResolution(const QSize &resolution)
voidsetResolution(int width,
int height)
Method void QMediaResource::setResolution(int width, int height)
voidsetSampleRate(int frequency)Method void QMediaResource::setSampleRate(int frequency)
voidsetVideoBitRate(int rate)Method void QMediaResource::setVideoBitRate(int rate)
voidsetVideoCodec(string codec)Method void QMediaResource::setVideoCodec(const QString &codec)
[const]QUrlurlMethod QUrl QMediaResource::url()
[const]intvideoBitRateMethod int QMediaResource::videoBitRate()
voidvideoBitRate=(int rate)Method void QMediaResource::setVideoBitRate(int rate)
[const]stringvideoCodecMethod QString QMediaResource::videoCodec()
voidvideoCodec=(string codec)Method void QMediaResource::setVideoCodec(const QString &codec)

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

!=

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

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

==

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

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

_assign

Signature: void _assign (const QMediaResource other)

Description: Assigns another object to self

_const_cast

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

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

audioBitRate

Signature: [const] int audioBitRate

Description: Method int QMediaResource::audioBitRate()

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

audioBitRate=

Signature: void audioBitRate= (int rate)

Description: Method void QMediaResource::setAudioBitRate(int rate)

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

audioCodec

Signature: [const] string audioCodec

Description: Method QString QMediaResource::audioCodec()

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

audioCodec=

Signature: void audioCodec= (string codec)

Description: Method void QMediaResource::setAudioCodec(const QString &codec)

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

channelCount

Signature: [const] int channelCount

Description: Method int QMediaResource::channelCount()

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

channelCount=

Signature: void channelCount= (int channels)

Description: Method void QMediaResource::setChannelCount(int channels)

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

dataSize

Signature: [const] long long dataSize

Description: Method qint64 QMediaResource::dataSize()

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

dataSize=

Signature: void dataSize= (long long size)

Description: Method void QMediaResource::setDataSize(const qint64 size)

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

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

Description: Creates a copy of self

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QMediaResource::isNull()

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.

language

Signature: [const] string language

Description: Method QString QMediaResource::language()

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

language=

Signature: void language= (string language)

Description: Method void QMediaResource::setLanguage(const QString &language)

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

mimeType

Signature: [const] string mimeType

Description: Method QString QMediaResource::mimeType()

new

(1) Signature: [static] new QMediaResource new

Description: Constructor QMediaResource::QMediaResource()

This method creates an object of class QMediaResource.

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

(2) Signature: [static] new QMediaResource new (const QUrl url, string mimeType = QString())

Description: Constructor QMediaResource::QMediaResource(const QUrl &url, const QString &mimeType)

This method creates an object of class QMediaResource.

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

(3) Signature: [static] new QMediaResource new (const QNetworkRequest request, string mimeType = QString())

Description: Constructor QMediaResource::QMediaResource(const QNetworkRequest &request, const QString &mimeType)

This method creates an object of class QMediaResource.

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

(4) Signature: [static] new QMediaResource new (const QMediaResource other)

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

This method creates an object of class QMediaResource.

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

request

Signature: [const] QNetworkRequest request

Description: Method QNetworkRequest QMediaResource::request()

resolution

Signature: [const] QSize resolution

Description: Method QSize QMediaResource::resolution()

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

resolution=

Signature: void resolution= (const QSize resolution)

Description: Method void QMediaResource::setResolution(const QSize &resolution)

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

sampleRate

Signature: [const] int sampleRate

Description: Method int QMediaResource::sampleRate()

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

sampleRate=

Signature: void sampleRate= (int frequency)

Description: Method void QMediaResource::setSampleRate(int frequency)

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

setAudioBitRate

Signature: void setAudioBitRate (int rate)

Description: Method void QMediaResource::setAudioBitRate(int rate)

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

setAudioCodec

Signature: void setAudioCodec (string codec)

Description: Method void QMediaResource::setAudioCodec(const QString &codec)

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

setChannelCount

Signature: void setChannelCount (int channels)

Description: Method void QMediaResource::setChannelCount(int channels)

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

setDataSize

Signature: void setDataSize (long long size)

Description: Method void QMediaResource::setDataSize(const qint64 size)

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

setLanguage

Signature: void setLanguage (string language)

Description: Method void QMediaResource::setLanguage(const QString &language)

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

setResolution

(1) Signature: void setResolution (const QSize resolution)

Description: Method void QMediaResource::setResolution(const QSize &resolution)

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

(2) Signature: void setResolution (int width, int height)

Description: Method void QMediaResource::setResolution(int width, int height)

setSampleRate

Signature: void setSampleRate (int frequency)

Description: Method void QMediaResource::setSampleRate(int frequency)

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

setVideoBitRate

Signature: void setVideoBitRate (int rate)

Description: Method void QMediaResource::setVideoBitRate(int rate)

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

setVideoCodec

Signature: void setVideoCodec (string codec)

Description: Method void QMediaResource::setVideoCodec(const QString &codec)

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

url

Signature: [const] QUrl url

Description: Method QUrl QMediaResource::url()

videoBitRate

Signature: [const] int videoBitRate

Description: Method int QMediaResource::videoBitRate()

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

videoBitRate=

Signature: void videoBitRate= (int rate)

Description: Method void QMediaResource::setVideoBitRate(int rate)

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

videoCodec

Signature: [const] string videoCodec

Description: Method QString QMediaResource::videoCodec()

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

videoCodec=

Signature: void videoCodec= (string codec)

Description: Method void QMediaResource::setVideoCodec(const QString &codec)

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