API reference - Class QMediaPlayerControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaPlayerControl

Class hierarchy: QMediaPlayerControl » QMediaControl » QObject

Public constructors

new QMediaPlayerControlnewConstructor QMediaPlayerControl::QMediaPlayerControl()

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.
voidaudioAvailableChanged(bool audioAvailable)Method void QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)
[const]QMediaTimeRangeavailablePlaybackRangesVirtual method QMediaTimeRange QMediaPlayerControl::availablePlaybackRanges()
voidavailablePlaybackRangesChanged(const QMediaTimeRange arg1)Method void QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &)
[const]intbufferStatusVirtual method int QMediaPlayerControl::bufferStatus()
voidbufferStatusChanged(int percentFilled)Method void QMediaPlayerControl::bufferStatusChanged(int percentFilled)
[const]long longdurationVirtual method qint64 QMediaPlayerControl::duration()
voiddurationChanged(long long duration)Method void QMediaPlayerControl::durationChanged(qint64 duration)
voiderror(int error,
string errorString)
Method void QMediaPlayerControl::error(int error, const QString &errorString)
boolevent(QEvent ptr arg1)Virtual method bool QMediaPlayerControl::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QMediaPlayerControl::eventFilter(QObject *, QEvent *)
[const]boolisAudioAvailableVirtual method bool QMediaPlayerControl::isAudioAvailable()
[const]boolisAudioAvailable?Method bool QMediaPlayerControl::isAudioAvailable()
[const]boolisMutedVirtual method bool QMediaPlayerControl::isMuted()
[const]boolisMuted?Method bool QMediaPlayerControl::isMuted()
[const]boolisSeekableVirtual method bool QMediaPlayerControl::isSeekable()
[const]boolisSeekable?Method bool QMediaPlayerControl::isSeekable()
[const]boolisVideoAvailableVirtual method bool QMediaPlayerControl::isVideoAvailable()
[const]boolisVideoAvailable?Method bool QMediaPlayerControl::isVideoAvailable()
[const]QMediaContentmediaVirtual method QMediaContent QMediaPlayerControl::media()
voidmediaChanged(const QMediaContent content)Method void QMediaPlayerControl::mediaChanged(const QMediaContent &content)
[const]QMediaPlayer_MediaStatusmediaStatusVirtual method QMediaPlayer::MediaStatus QMediaPlayerControl::mediaStatus()
voidmediaStatusChanged(const QMediaPlayer_MediaStatus status)Method void QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)
[const]const QIODevice ptrmediaStreamVirtual method const QIODevice *QMediaPlayerControl::mediaStream()
[const]boolmutedMethod bool QMediaPlayerControl::isMuted()
voidmuted=(bool muted)Method void QMediaPlayerControl::setMuted(bool muted)
voidmutedChanged(bool muted)Method void QMediaPlayerControl::mutedChanged(bool muted)
voidpauseVirtual method void QMediaPlayerControl::pause()
voidplayVirtual method void QMediaPlayerControl::play()
[const]doubleplaybackRateVirtual method double QMediaPlayerControl::playbackRate()
voidplaybackRate=(double rate)Method void QMediaPlayerControl::setPlaybackRate(double rate)
voidplaybackRateChanged(double rate)Method void QMediaPlayerControl::playbackRateChanged(double rate)
[const]long longpositionVirtual method qint64 QMediaPlayerControl::position()
voidposition=(long long position)Method void QMediaPlayerControl::setPosition(qint64 position)
voidpositionChanged(long long position)Method void QMediaPlayerControl::positionChanged(qint64 position)
voidseekableChanged(bool arg1)Method void QMediaPlayerControl::seekableChanged(bool)
voidsetMedia(const QMediaContent media,
QIODevice ptr stream)
Virtual method void QMediaPlayerControl::setMedia(const QMediaContent &media, QIODevice *stream)
voidsetMuted(bool muted)Virtual method void QMediaPlayerControl::setMuted(bool muted)
voidsetPlaybackRate(double rate)Virtual method void QMediaPlayerControl::setPlaybackRate(double rate)
voidsetPosition(long long position)Virtual method void QMediaPlayerControl::setPosition(qint64 position)
voidsetVolume(int volume)Virtual method void QMediaPlayerControl::setVolume(int volume)
[const]QMediaPlayer_StatestateVirtual method QMediaPlayer::State QMediaPlayerControl::state()
voidstateChanged(const QMediaPlayer_State newState)Method void QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)
voidstopVirtual method void QMediaPlayerControl::stop()
voidvideoAvailableChanged(bool videoAvailable)Method void QMediaPlayerControl::videoAvailableChanged(bool videoAvailable)
[const]intvolumeVirtual method int QMediaPlayerControl::volume()
voidvolume=(int volume)Method void QMediaPlayerControl::setVolume(int volume)
voidvolumeChanged(int volume)Method void QMediaPlayerControl::volumeChanged(int volume)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QMediaPlayerControl::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QMediaPlayerControl::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

_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: void audioAvailableChanged (bool audioAvailable)

Description: Method void QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)

availablePlaybackRanges

Signature: [const] QMediaTimeRange availablePlaybackRanges

Description: Virtual method QMediaTimeRange QMediaPlayerControl::availablePlaybackRanges()

This method can be reimplemented in a derived class.

availablePlaybackRangesChanged

Signature: void availablePlaybackRangesChanged (const QMediaTimeRange arg1)

Description: Method void QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &)

bufferStatus

Signature: [const] int bufferStatus

Description: Virtual method int QMediaPlayerControl::bufferStatus()

This method can be reimplemented in a derived class.

bufferStatusChanged

Signature: void bufferStatusChanged (int percentFilled)

Description: Method void QMediaPlayerControl::bufferStatusChanged(int percentFilled)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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: void durationChanged (long long duration)

Description: Method void QMediaPlayerControl::durationChanged(qint64 duration)

error

Signature: void error (int error, string errorString)

Description: Method void QMediaPlayerControl::error(int error, const QString &errorString)

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QMediaPlayerControl::eventFilter(QObject *, QEvent *)

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: void mediaChanged (const QMediaContent content)

Description: Method void QMediaPlayerControl::mediaChanged(const QMediaContent &content)

mediaStatus

Signature: [const] QMediaPlayer_MediaStatus mediaStatus

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

This method can be reimplemented in a derived class.

mediaStatusChanged

Signature: void mediaStatusChanged (const QMediaPlayer_MediaStatus status)

Description: Method void QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)

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 muted)

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

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

mutedChanged

Signature: void mutedChanged (bool muted)

Description: Method void QMediaPlayerControl::mutedChanged(bool muted)

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.

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: void playbackRateChanged (double rate)

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

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: void positionChanged (long long position)

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

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: void seekableChanged (bool arg1)

Description: Method void QMediaPlayerControl::seekableChanged(bool)

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 muted)

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

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: void stateChanged (const QMediaPlayer_State newState)

Description: Method void QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)

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 arg1)

Description: Virtual method void QMediaPlayerControl::timerEvent(QTimerEvent *)

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: void videoAvailableChanged (bool videoAvailable)

Description: Method void QMediaPlayerControl::videoAvailableChanged(bool videoAvailable)

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: void volumeChanged (int volume)

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