API reference - Class QVideoEncoderSettings

!=

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

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

==

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

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

_assign

Signature: void _assign (const QVideoEncoderSettings other)

Description: Assigns another object to self

_const_cast

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

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

bitRate

Signature: [const] int bitRate

Description: Method int QVideoEncoderSettings::bitRate()

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

bitRate=

Signature: void bitRate= (int bitrate)

Description: Method void QVideoEncoderSettings::setBitRate(int bitrate)

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

codec

Signature: [const] string codec

Description: Method QString QVideoEncoderSettings::codec()

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

codec=

Signature: void codec= (string arg1)

Description: Method void QVideoEncoderSettings::setCodec(const QString &)

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

Description: Creates a copy of self

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

encodingMode

Signature: [const] QMultimedia_EncodingMode encodingMode

Description: Method QMultimedia::EncodingMode QVideoEncoderSettings::encodingMode()

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

encodingMode=

Signature: void encodingMode= (const QMultimedia_EncodingMode arg1)

Description: Method void QVideoEncoderSettings::setEncodingMode(QMultimedia::EncodingMode)

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

encodingOption

Signature: [const] variant encodingOption (string option)

Description: Method QVariant QVideoEncoderSettings::encodingOption(const QString &option)

encodingOptions

Signature: [const] map<string,variant> encodingOptions

Description: Method QMap<QString, QVariant> QVideoEncoderSettings::encodingOptions()

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

encodingOptions=

Signature: void encodingOptions= (map<string,variant> options)

Description: Method void QVideoEncoderSettings::setEncodingOptions(const QMap<QString, QVariant> &options)

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

frameRate

Signature: [const] double frameRate

Description: Method double QVideoEncoderSettings::frameRate()

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

frameRate=

Signature: void frameRate= (double rate)

Description: Method void QVideoEncoderSettings::setFrameRate(double rate)

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QVideoEncoderSettings::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.

new

(1) Signature: [static] new QVideoEncoderSettings new

Description: Constructor QVideoEncoderSettings::QVideoEncoderSettings()

This method creates an object of class QVideoEncoderSettings.

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

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

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

This method creates an object of class QVideoEncoderSettings.

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

quality

Signature: [const] QMultimedia_EncodingQuality quality

Description: Method QMultimedia::EncodingQuality QVideoEncoderSettings::quality()

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

quality=

Signature: void quality= (const QMultimedia_EncodingQuality quality)

Description: Method void QVideoEncoderSettings::setQuality(QMultimedia::EncodingQuality quality)

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

resolution

Signature: [const] QSize resolution

Description: Method QSize QVideoEncoderSettings::resolution()

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

resolution=

Signature: void resolution= (const QSize arg1)

Description: Method void QVideoEncoderSettings::setResolution(const QSize &)

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

setBitRate

Signature: void setBitRate (int bitrate)

Description: Method void QVideoEncoderSettings::setBitRate(int bitrate)

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

setCodec

Signature: void setCodec (string arg1)

Description: Method void QVideoEncoderSettings::setCodec(const QString &)

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

setEncodingMode

Signature: void setEncodingMode (const QMultimedia_EncodingMode arg1)

Description: Method void QVideoEncoderSettings::setEncodingMode(QMultimedia::EncodingMode)

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

setEncodingOption

Signature: void setEncodingOption (string option, variant value)

Description: Method void QVideoEncoderSettings::setEncodingOption(const QString &option, const QVariant &value)

setEncodingOptions

Signature: void setEncodingOptions (map<string,variant> options)

Description: Method void QVideoEncoderSettings::setEncodingOptions(const QMap<QString, QVariant> &options)

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

setFrameRate

Signature: void setFrameRate (double rate)

Description: Method void QVideoEncoderSettings::setFrameRate(double rate)

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

setQuality

Signature: void setQuality (const QMultimedia_EncodingQuality quality)

Description: Method void QVideoEncoderSettings::setQuality(QMultimedia::EncodingQuality quality)

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

setResolution

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

Description: Method void QVideoEncoderSettings::setResolution(const QSize &)

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 QVideoEncoderSettings::setResolution(int width, int height)