API reference - Class QMediaPlayerControl

_const_cast

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

audioAvailableChanged

Signature: [signal] void audioAvailableChanged (bool audioAvailable)

Description: Signal declaration for QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)

You can bind a procedure to this signal.

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

availablePlaybackRanges

Signature: [const] QMediaTimeRange availablePlaybackRanges

Description: Virtual method QMediaTimeRange QMediaPlayerControl::availablePlaybackRanges()

This method can be reimplemented in a derived class.

availablePlaybackRangesChanged

Signature: [signal] void availablePlaybackRangesChanged (const QMediaTimeRange ranges)

Description: Signal declaration for QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &ranges)

You can bind a procedure to this signal.

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

bufferStatus

Signature: [const] int bufferStatus

Description: Virtual method int QMediaPlayerControl::bufferStatus()

This method can be reimplemented in a derived class.

bufferStatusChanged

Signature: [signal] void bufferStatusChanged (int percentFilled)

Description: Signal declaration for QMediaPlayerControl::bufferStatusChanged(int percentFilled)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QMediaPlayerControl::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 QMediaPlayerControl::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

duration

Signature: [const] long long duration

Description: Virtual method qint64 QMediaPlayerControl::duration()

This method can be reimplemented in a derived class.

durationChanged

Signature: [signal] void durationChanged (long long duration)

Description: Signal declaration for QMediaPlayerControl::durationChanged(qint64 duration)

You can bind a procedure to this signal.

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

emit_audioAvailableChanged

Signature: void emit_audioAvailableChanged (bool audioAvailable)

Description: Emitter for signal void QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)

Call this method to emit this signal.

emit_availablePlaybackRangesChanged

Signature: void emit_availablePlaybackRangesChanged (const QMediaTimeRange ranges)

Description: Emitter for signal void QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &ranges)

Call this method to emit this signal.

emit_bufferStatusChanged

Signature: void emit_bufferStatusChanged (int percentFilled)

Description: Emitter for signal void QMediaPlayerControl::bufferStatusChanged(int percentFilled)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_durationChanged

Signature: void emit_durationChanged (long long duration)

Description: Emitter for signal void QMediaPlayerControl::durationChanged(qint64 duration)

Call this method to emit this signal.

emit_error

Signature: void emit_error (int error, string errorString)

Description: Emitter for signal void QMediaPlayerControl::error(int error, const QString &errorString)

Call this method to emit this signal.

emit_mediaChanged

Signature: void emit_mediaChanged (const QMediaContent content)

Description: Emitter for signal void QMediaPlayerControl::mediaChanged(const QMediaContent &content)

Call this method to emit this signal.

emit_mediaStatusChanged

Signature: void emit_mediaStatusChanged (const QMediaPlayer_MediaStatus status)

Description: Emitter for signal void QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)

Call this method to emit this signal.

emit_mutedChanged

Signature: void emit_mutedChanged (bool mute)

Description: Emitter for signal void QMediaPlayerControl::mutedChanged(bool mute)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_playbackRateChanged

Signature: void emit_playbackRateChanged (double rate)

Description: Emitter for signal void QMediaPlayerControl::playbackRateChanged(double rate)

Call this method to emit this signal.

emit_positionChanged

Signature: void emit_positionChanged (long long position)

Description: Emitter for signal void QMediaPlayerControl::positionChanged(qint64 position)

Call this method to emit this signal.

emit_seekableChanged

Signature: void emit_seekableChanged (bool seekable)

Description: Emitter for signal void QMediaPlayerControl::seekableChanged(bool seekable)

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QMediaPlayer_State newState)

Description: Emitter for signal void QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)

Call this method to emit this signal.

emit_videoAvailableChanged

Signature: void emit_videoAvailableChanged (bool videoAvailable)

Description: Emitter for signal void QMediaPlayerControl::videoAvailableChanged(bool videoAvailable)

Call this method to emit this signal.

emit_volumeChanged

Signature: void emit_volumeChanged (int volume)

Description: Emitter for signal void QMediaPlayerControl::volumeChanged(int volume)

Call this method to emit this signal.

error

Signature: [signal] void error (int error, string errorString)

Description: Signal declaration for QMediaPlayerControl::error(int error, const QString &errorString)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QMediaPlayerControl::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 QMediaPlayerControl::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isAudioAvailable

Signature: [const] bool isAudioAvailable

Description: Virtual method bool QMediaPlayerControl::isAudioAvailable()

This method can be reimplemented in a derived class.

isAudioAvailable?

Signature: [const] bool isAudioAvailable?

Description: Method bool QMediaPlayerControl::isAudioAvailable()

isMuted

Signature: [const] bool isMuted

Description: Virtual method bool QMediaPlayerControl::isMuted()

This method can be reimplemented in a derived class.

isMuted?

Signature: [const] bool isMuted?

Description: Method bool QMediaPlayerControl::isMuted()

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

isSeekable

Signature: [const] bool isSeekable

Description: Virtual method bool QMediaPlayerControl::isSeekable()

This method can be reimplemented in a derived class.

isSeekable?

Signature: [const] bool isSeekable?

Description: Method bool QMediaPlayerControl::isSeekable()

isSignalConnected

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

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

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

isVideoAvailable

Signature: [const] bool isVideoAvailable

Description: Virtual method bool QMediaPlayerControl::isVideoAvailable()

This method can be reimplemented in a derived class.

isVideoAvailable?

Signature: [const] bool isVideoAvailable?

Description: Method bool QMediaPlayerControl::isVideoAvailable()

media

Signature: [const] QMediaContent media

Description: Virtual method QMediaContent QMediaPlayerControl::media()

This method can be reimplemented in a derived class.

mediaChanged

Signature: [signal] void mediaChanged (const QMediaContent content)

Description: Signal declaration for QMediaPlayerControl::mediaChanged(const QMediaContent &content)

You can bind a procedure to this signal.

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

mediaStatus

Signature: [const] QMediaPlayer_MediaStatus mediaStatus

Description: Virtual method QMediaPlayer::MediaStatus QMediaPlayerControl::mediaStatus()

This method can be reimplemented in a derived class.

mediaStatusChanged

Signature: [signal] void mediaStatusChanged (const QMediaPlayer_MediaStatus status)

Description: Signal declaration for QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)

You can bind a procedure to this signal.

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

mediaStream

Signature: [const] const QIODevice ptr mediaStream

Description: Virtual method const QIODevice *QMediaPlayerControl::mediaStream()

This method can be reimplemented in a derived class.

muted

Signature: [const] bool muted

Description: Method bool QMediaPlayerControl::isMuted()

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

muted=

Signature: void muted= (bool mute)

Description: Method void QMediaPlayerControl::setMuted(bool mute)

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

mutedChanged

Signature: [signal] void mutedChanged (bool mute)

Description: Signal declaration for QMediaPlayerControl::mutedChanged(bool mute)

You can bind a procedure to this signal.

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

new

Signature: [static] new QMediaPlayerControl new

Description: Constructor QMediaPlayerControl::QMediaPlayerControl()

This method creates an object of class QMediaPlayerControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QMediaPlayerControl::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.

pause

Signature: void pause

Description: Virtual method void QMediaPlayerControl::pause()

This method can be reimplemented in a derived class.

play

Signature: void play

Description: Virtual method void QMediaPlayerControl::play()

This method can be reimplemented in a derived class.

playbackRate

Signature: [const] double playbackRate

Description: Virtual method double QMediaPlayerControl::playbackRate()

This method can be reimplemented in a derived class.

playbackRate=

Signature: void playbackRate= (double rate)

Description: Method void QMediaPlayerControl::setPlaybackRate(double rate)

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

playbackRateChanged

Signature: [signal] void playbackRateChanged (double rate)

Description: Signal declaration for QMediaPlayerControl::playbackRateChanged(double rate)

You can bind a procedure to this signal.

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

position

Signature: [const] long long position

Description: Virtual method qint64 QMediaPlayerControl::position()

This method can be reimplemented in a derived class.

position=

Signature: void position= (long long position)

Description: Method void QMediaPlayerControl::setPosition(qint64 position)

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

positionChanged

Signature: [signal] void positionChanged (long long position)

Description: Signal declaration for QMediaPlayerControl::positionChanged(qint64 position)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

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

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

seekableChanged

Signature: [signal] void seekableChanged (bool seekable)

Description: Signal declaration for QMediaPlayerControl::seekableChanged(bool seekable)

You can bind a procedure to this signal.

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMediaPlayerControl::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaPlayerControl::senderSignalIndex()

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

setMedia

Signature: void setMedia (const QMediaContent media, QIODevice ptr stream)

Description: Virtual method void QMediaPlayerControl::setMedia(const QMediaContent &media, QIODevice *stream)

This method can be reimplemented in a derived class.

setMuted

Signature: void setMuted (bool mute)

Description: Virtual method void QMediaPlayerControl::setMuted(bool mute)

This method can be reimplemented in a derived class.

setPlaybackRate

Signature: void setPlaybackRate (double rate)

Description: Virtual method void QMediaPlayerControl::setPlaybackRate(double rate)

This method can be reimplemented in a derived class.

setPosition

Signature: void setPosition (long long position)

Description: Virtual method void QMediaPlayerControl::setPosition(qint64 position)

This method can be reimplemented in a derived class.

setVolume

Signature: void setVolume (int volume)

Description: Virtual method void QMediaPlayerControl::setVolume(int volume)

This method can be reimplemented in a derived class.

state

Signature: [const] QMediaPlayer_State state

Description: Virtual method QMediaPlayer::State QMediaPlayerControl::state()

This method can be reimplemented in a derived class.

stateChanged

Signature: [signal] void stateChanged (const QMediaPlayer_State newState)

Description: Signal declaration for QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Virtual method void QMediaPlayerControl::stop()

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMediaPlayerControl::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 QMediaPlayerControl::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 QMediaPlayerControl::trUtf8(const char *s, const char *c, int n)

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

videoAvailableChanged

Signature: [signal] void videoAvailableChanged (bool videoAvailable)

Description: Signal declaration for QMediaPlayerControl::videoAvailableChanged(bool videoAvailable)

You can bind a procedure to this signal.

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

volume

Signature: [const] int volume

Description: Virtual method int QMediaPlayerControl::volume()

This method can be reimplemented in a derived class.

volume=

Signature: void volume= (int volume)

Description: Method void QMediaPlayerControl::setVolume(int volume)

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

volumeChanged

Signature: [signal] void volumeChanged (int volume)

Description: Signal declaration for QMediaPlayerControl::volumeChanged(int volume)

You can bind a procedure to this signal.

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