KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMediaServiceProviderHint

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaServiceProviderHint

Sub-classes: Feature, QFlags_Feature, Type, QFlags_Type

Public constructors

new QMediaServiceProviderHintnewConstructor QMediaServiceProviderHint::QMediaServiceProviderHint()
new QMediaServiceProviderHintnew(string mimeType,
string[] codecs)
Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(const QString &mimeType, const QStringList &codecs)
new QMediaServiceProviderHintnew(bytes device)Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(const QByteArray &device)
new QMediaServiceProviderHintnew(const QCamera_Position position)Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(QCamera::Position position)
new QMediaServiceProviderHintnew(QMediaServiceProviderHint_QFlags_Feature features)Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(QFlags<QMediaServiceProviderHint::Feature> features)
new QMediaServiceProviderHintnew(const QMediaServiceProviderHint other)Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(const QMediaServiceProviderHint &other)

Public methods

[const]bool!=(const QMediaServiceProviderHint other)Method bool QMediaServiceProviderHint::operator !=(const QMediaServiceProviderHint &other)
[const]bool==(const QMediaServiceProviderHint other)Method bool QMediaServiceProviderHint::operator ==(const QMediaServiceProviderHint &other)
void_assign(const QMediaServiceProviderHint other)Assigns another object to self
[const]QMediaServiceProviderHint 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.
QMediaServiceProviderHintassign(const QMediaServiceProviderHint other)Method QMediaServiceProviderHint &QMediaServiceProviderHint::operator=(const QMediaServiceProviderHint &other)
[const]QCamera_PositioncameraPositionMethod QCamera::Position QMediaServiceProviderHint::cameraPosition()
[const]string[]codecsMethod QStringList QMediaServiceProviderHint::codecs()
[const]bytesdeviceMethod QByteArray QMediaServiceProviderHint::device()
[const]new QMediaServiceProviderHint ptrdupCreates a copy of self
[const]QMediaServiceProviderHint_QFlags_FeaturefeaturesMethod QFlags<QMediaServiceProviderHint::Feature> QMediaServiceProviderHint::features()
[const]boolisNull?Method bool QMediaServiceProviderHint::isNull()
[const]stringmimeTypeMethod QString QMediaServiceProviderHint::mimeType()
[const]QMediaServiceProviderHint_TypetypeMethod QMediaServiceProviderHint::Type QMediaServiceProviderHint::type()

Public static methods and constants

[static,const]QMediaServiceProviderHint_TypeCameraPositionEnum constant QMediaServiceProviderHint::CameraPosition
[static,const]QMediaServiceProviderHint_TypeContentTypeEnum constant QMediaServiceProviderHint::ContentType
[static,const]QMediaServiceProviderHint_TypeDeviceEnum constant QMediaServiceProviderHint::Device
[static,const]QMediaServiceProviderHint_FeatureLowLatencyPlaybackEnum constant QMediaServiceProviderHint::LowLatencyPlayback
[static,const]QMediaServiceProviderHint_TypeNullEnum constant QMediaServiceProviderHint::Null
[static,const]QMediaServiceProviderHint_FeatureRecordingSupportEnum constant QMediaServiceProviderHint::RecordingSupport
[static,const]QMediaServiceProviderHint_FeatureStreamPlaybackEnum constant QMediaServiceProviderHint::StreamPlayback
[static,const]QMediaServiceProviderHint_TypeSupportedFeaturesEnum constant QMediaServiceProviderHint::SupportedFeatures
[static,const]QMediaServiceProviderHint_FeatureVideoSurfaceEnum constant QMediaServiceProviderHint::VideoSurface

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 QMediaServiceProviderHint other)

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

==

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

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

CameraPosition

Signature: [static,const] QMediaServiceProviderHint_Type CameraPosition

Description: Enum constant QMediaServiceProviderHint::CameraPosition

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

ContentType

Signature: [static,const] QMediaServiceProviderHint_Type ContentType

Description: Enum constant QMediaServiceProviderHint::ContentType

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

Device

Signature: [static,const] QMediaServiceProviderHint_Type Device

Description: Enum constant QMediaServiceProviderHint::Device

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

LowLatencyPlayback

Signature: [static,const] QMediaServiceProviderHint_Feature LowLatencyPlayback

Description: Enum constant QMediaServiceProviderHint::LowLatencyPlayback

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

Null

Signature: [static,const] QMediaServiceProviderHint_Type Null

Description: Enum constant QMediaServiceProviderHint::Null

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

RecordingSupport

Signature: [static,const] QMediaServiceProviderHint_Feature RecordingSupport

Description: Enum constant QMediaServiceProviderHint::RecordingSupport

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

StreamPlayback

Signature: [static,const] QMediaServiceProviderHint_Feature StreamPlayback

Description: Enum constant QMediaServiceProviderHint::StreamPlayback

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

SupportedFeatures

Signature: [static,const] QMediaServiceProviderHint_Type SupportedFeatures

Description: Enum constant QMediaServiceProviderHint::SupportedFeatures

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

VideoSurface

Signature: [static,const] QMediaServiceProviderHint_Feature VideoSurface

Description: Enum constant QMediaServiceProviderHint::VideoSurface

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

_assign

Signature: void _assign (const QMediaServiceProviderHint other)

Description: Assigns another object to self

_const_cast

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

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

cameraPosition

Signature: [const] QCamera_Position cameraPosition

Description: Method QCamera::Position QMediaServiceProviderHint::cameraPosition()

codecs

Signature: [const] string[] codecs

Description: Method QStringList QMediaServiceProviderHint::codecs()

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.

device

Signature: [const] bytes device

Description: Method QByteArray QMediaServiceProviderHint::device()

dup

Signature: [const] new QMediaServiceProviderHint ptr dup

Description: Creates a copy of self

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

features

Signature: [const] QMediaServiceProviderHint_QFlags_Feature features

Description: Method QFlags<QMediaServiceProviderHint::Feature> QMediaServiceProviderHint::features()

isNull?

Signature: [const] bool isNull?

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

mimeType

Signature: [const] string mimeType

Description: Method QString QMediaServiceProviderHint::mimeType()

new

(1) Signature: [static] new QMediaServiceProviderHint new

Description: Constructor QMediaServiceProviderHint::QMediaServiceProviderHint()

This method creates an object of class QMediaServiceProviderHint.

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

(2) Signature: [static] new QMediaServiceProviderHint new (string mimeType, string[] codecs)

Description: Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(const QString &mimeType, const QStringList &codecs)

This method creates an object of class QMediaServiceProviderHint.

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

(3) Signature: [static] new QMediaServiceProviderHint new (bytes device)

Description: Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(const QByteArray &device)

This method creates an object of class QMediaServiceProviderHint.

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

(4) Signature: [static] new QMediaServiceProviderHint new (const QCamera_Position position)

Description: Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(QCamera::Position position)

This method creates an object of class QMediaServiceProviderHint.

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

(5) Signature: [static] new QMediaServiceProviderHint new (QMediaServiceProviderHint_QFlags_Feature features)

Description: Constructor QMediaServiceProviderHint::QMediaServiceProviderHint(QFlags<QMediaServiceProviderHint::Feature> features)

This method creates an object of class QMediaServiceProviderHint.

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

(6) Signature: [static] new QMediaServiceProviderHint new (const QMediaServiceProviderHint other)

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

This method creates an object of class QMediaServiceProviderHint.

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

type

Signature: [const] QMediaServiceProviderHint_Type type

Description: Method QMediaServiceProviderHint::Type QMediaServiceProviderHint::type()