API reference - Class QMultimedia

Notation used in Ruby API documentation

Module: QtMultimedia

Description: This class represents the QMultimedia namespace

Sub-classes: AvailabilityStatus, QFlags_AvailabilityStatus, EncodingMode, QFlags_EncodingMode, EncodingQuality, QFlags_EncodingQuality, SupportEstimate, QFlags_SupportEstimate

Public constructors

new QMultimedia ptrnewCreates a new object of this class

Public methods

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 QMultimedia other)Assigns another object to self
[const]new QMultimedia ptrdupCreates a copy of self

Public static methods and constants

[static,const]QMultimedia_AvailabilityStatusAvailableEnum constant QMultimedia::Available
[static,const]QMultimedia_EncodingModeAverageBitRateEncodingEnum constant QMultimedia::AverageBitRateEncoding
[static,const]QMultimedia_AvailabilityStatusBusyEnum constant QMultimedia::Busy
[static,const]QMultimedia_EncodingModeConstantBitRateEncodingEnum constant QMultimedia::ConstantBitRateEncoding
[static,const]QMultimedia_EncodingModeConstantQualityEncodingEnum constant QMultimedia::ConstantQualityEncoding
[static,const]QMultimedia_EncodingQualityHighQualityEnum constant QMultimedia::HighQuality
[static,const]QMultimedia_EncodingQualityLowQualityEnum constant QMultimedia::LowQuality
[static,const]QMultimedia_SupportEstimateMaybeSupportedEnum constant QMultimedia::MaybeSupported
[static,const]QMultimedia_EncodingQualityNormalQualityEnum constant QMultimedia::NormalQuality
[static,const]QMultimedia_SupportEstimateNotSupportedEnum constant QMultimedia::NotSupported
[static,const]QMultimedia_SupportEstimatePreferredServiceEnum constant QMultimedia::PreferredService
[static,const]QMultimedia_SupportEstimateProbablySupportedEnum constant QMultimedia::ProbablySupported
[static,const]QMultimedia_AvailabilityStatusResourceErrorEnum constant QMultimedia::ResourceError
[static,const]QMultimedia_AvailabilityStatusServiceMissingEnum constant QMultimedia::ServiceMissing
[static,const]QMultimedia_EncodingModeTwoPassEncodingEnum constant QMultimedia::TwoPassEncoding
[static,const]QMultimedia_EncodingQualityVeryHighQualityEnum constant QMultimedia::VeryHighQuality
[static,const]QMultimedia_EncodingQualityVeryLowQualityEnum constant QMultimedia::VeryLowQuality

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

Available

Signature: [static,const] QMultimedia_AvailabilityStatus Available

Description: Enum constant QMultimedia::Available

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

AverageBitRateEncoding

Signature: [static,const] QMultimedia_EncodingMode AverageBitRateEncoding

Description: Enum constant QMultimedia::AverageBitRateEncoding

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

Busy

Signature: [static,const] QMultimedia_AvailabilityStatus Busy

Description: Enum constant QMultimedia::Busy

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

ConstantBitRateEncoding

Signature: [static,const] QMultimedia_EncodingMode ConstantBitRateEncoding

Description: Enum constant QMultimedia::ConstantBitRateEncoding

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

ConstantQualityEncoding

Signature: [static,const] QMultimedia_EncodingMode ConstantQualityEncoding

Description: Enum constant QMultimedia::ConstantQualityEncoding

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

HighQuality

Signature: [static,const] QMultimedia_EncodingQuality HighQuality

Description: Enum constant QMultimedia::HighQuality

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

LowQuality

Signature: [static,const] QMultimedia_EncodingQuality LowQuality

Description: Enum constant QMultimedia::LowQuality

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

MaybeSupported

Signature: [static,const] QMultimedia_SupportEstimate MaybeSupported

Description: Enum constant QMultimedia::MaybeSupported

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

NormalQuality

Signature: [static,const] QMultimedia_EncodingQuality NormalQuality

Description: Enum constant QMultimedia::NormalQuality

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

NotSupported

Signature: [static,const] QMultimedia_SupportEstimate NotSupported

Description: Enum constant QMultimedia::NotSupported

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

PreferredService

Signature: [static,const] QMultimedia_SupportEstimate PreferredService

Description: Enum constant QMultimedia::PreferredService

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

ProbablySupported

Signature: [static,const] QMultimedia_SupportEstimate ProbablySupported

Description: Enum constant QMultimedia::ProbablySupported

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

ResourceError

Signature: [static,const] QMultimedia_AvailabilityStatus ResourceError

Description: Enum constant QMultimedia::ResourceError

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

ServiceMissing

Signature: [static,const] QMultimedia_AvailabilityStatus ServiceMissing

Description: Enum constant QMultimedia::ServiceMissing

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

TwoPassEncoding

Signature: [static,const] QMultimedia_EncodingMode TwoPassEncoding

Description: Enum constant QMultimedia::TwoPassEncoding

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

VeryHighQuality

Signature: [static,const] QMultimedia_EncodingQuality VeryHighQuality

Description: Enum constant QMultimedia::VeryHighQuality

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

VeryLowQuality

Signature: [static,const] QMultimedia_EncodingQuality VeryLowQuality

Description: Enum constant QMultimedia::VeryLowQuality

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

Description: Creates a new object of this class

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