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

API reference - Class QMediaStreamsControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaStreamsControl

Class hierarchy: QMediaStreamsControl » QMediaControl » QObject

Sub-classes: StreamType, QFlags_StreamType

Public constructors

new QMediaStreamsControlnewConstructor QMediaStreamsControl::QMediaStreamsControl()

Public methods

[const]QMediaStreamsControl 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.
[signal]voidactiveStreamsChangedSignal declaration for QMediaStreamsControl::activeStreamsChanged()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QMediaStreamsControl::destroyed(QObject *)
voidemit_activeStreamsChangedEmitter for signal void QMediaStreamsControl::activeStreamsChanged()
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QMediaStreamsControl::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QMediaStreamsControl::objectNameChanged(const QString &objectName)
voidemit_streamsChangedEmitter for signal void QMediaStreamsControl::streamsChanged()
boolevent(QEvent ptr event)Virtual method bool QMediaStreamsControl::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QMediaStreamsControl::eventFilter(QObject *watched, QEvent *event)
boolisActive(int streamNumber)Virtual method bool QMediaStreamsControl::isActive(int streamNumber)
boolisActive?(int streamNumber)Method bool QMediaStreamsControl::isActive(int streamNumber)
variantmetaData(int streamNumber,
string key)
Virtual method QVariant QMediaStreamsControl::metaData(int streamNumber, const QString &key)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QMediaStreamsControl::objectNameChanged(const QString &objectName)
voidsetActive(int streamNumber,
bool state)
Virtual method void QMediaStreamsControl::setActive(int streamNumber, bool state)
intstreamCountVirtual method int QMediaStreamsControl::streamCount()
QMediaStreamsControl_StreamTypestreamType(int streamNumber)Virtual method QMediaStreamsControl::StreamType QMediaStreamsControl::streamType(int streamNumber)
[signal]voidstreamsChangedSignal declaration for QMediaStreamsControl::streamsChanged()

Public static methods and constants

[static,const]QMediaStreamsControl_StreamTypeAudioStreamEnum constant QMediaStreamsControl::AudioStream
[static,const]QMediaStreamsControl_StreamTypeDataStreamEnum constant QMediaStreamsControl::DataStream
[static,const]QMediaStreamsControl_StreamTypeSubPictureStreamEnum constant QMediaStreamsControl::SubPictureStream
[static,const]QMediaStreamsControl_StreamTypeUnknownStreamEnum constant QMediaStreamsControl::UnknownStream
[static,const]QMediaStreamsControl_StreamTypeVideoStreamEnum constant QMediaStreamsControl::VideoStream
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QMediaStreamsControl::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QMediaStreamsControl::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QMediaStreamsControl::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QMediaStreamsControl::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QMediaStreamsControl::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QMediaStreamsControl::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QMediaStreamsControl::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QMediaStreamsControl::sender()
[const]intsenderSignalIndexMethod int QMediaStreamsControl::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QMediaStreamsControl::timerEvent(QTimerEvent *event)

Detailed description

AudioStream

Signature: [static,const] QMediaStreamsControl_StreamType AudioStream

Description: Enum constant QMediaStreamsControl::AudioStream

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

DataStream

Signature: [static,const] QMediaStreamsControl_StreamType DataStream

Description: Enum constant QMediaStreamsControl::DataStream

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

SubPictureStream

Signature: [static,const] QMediaStreamsControl_StreamType SubPictureStream

Description: Enum constant QMediaStreamsControl::SubPictureStream

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

UnknownStream

Signature: [static,const] QMediaStreamsControl_StreamType UnknownStream

Description: Enum constant QMediaStreamsControl::UnknownStream

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

VideoStream

Signature: [static,const] QMediaStreamsControl_StreamType VideoStream

Description: Enum constant QMediaStreamsControl::VideoStream

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

_const_cast

Signature: [const] QMediaStreamsControl 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.

activeStreamsChanged

Signature: [signal] void activeStreamsChanged

Description: Signal declaration for QMediaStreamsControl::activeStreamsChanged()

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QMediaStreamsControl::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QMediaStreamsControl::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QMediaStreamsControl::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QMediaStreamsControl::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_activeStreamsChanged

Signature: void emit_activeStreamsChanged

Description: Emitter for signal void QMediaStreamsControl::activeStreamsChanged()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QMediaStreamsControl::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QMediaStreamsControl::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_streamsChanged

Signature: void emit_streamsChanged

Description: Emitter for signal void QMediaStreamsControl::streamsChanged()

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QMediaStreamsControl::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QMediaStreamsControl::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isActive

Signature: bool isActive (int streamNumber)

Description: Virtual method bool QMediaStreamsControl::isActive(int streamNumber)

This method can be reimplemented in a derived class.

isActive?

Signature: bool isActive? (int streamNumber)

Description: Method bool QMediaStreamsControl::isActive(int streamNumber)

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QMediaStreamsControl::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

metaData

Signature: variant metaData (int streamNumber, string key)

Description: Virtual method QVariant QMediaStreamsControl::metaData(int streamNumber, const QString &key)

This method can be reimplemented in a derived class.

new

Signature: [static] new QMediaStreamsControl new

Description: Constructor QMediaStreamsControl::QMediaStreamsControl()

This method creates an object of class QMediaStreamsControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QMediaStreamsControl::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QMediaStreamsControl::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMediaStreamsControl::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaStreamsControl::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setActive

Signature: void setActive (int streamNumber, bool state)

Description: Virtual method void QMediaStreamsControl::setActive(int streamNumber, bool state)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

streamCount

Signature: int streamCount

Description: Virtual method int QMediaStreamsControl::streamCount()

This method can be reimplemented in a derived class.

streamType

Signature: QMediaStreamsControl_StreamType streamType (int streamNumber)

Description: Virtual method QMediaStreamsControl::StreamType QMediaStreamsControl::streamType(int streamNumber)

This method can be reimplemented in a derived class.

streamsChanged

Signature: [signal] void streamsChanged

Description: Signal declaration for QMediaStreamsControl::streamsChanged()

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMediaStreamsControl::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QMediaStreamsControl::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QMediaStreamsControl::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.