API reference - Class QMediaPlayer

AccessDeniedError

Signature: [static,const] QMediaPlayer_Error AccessDeniedError

Description: Enum constant QMediaPlayer::AccessDeniedError

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

BufferedMedia

Signature: [static,const] QMediaPlayer_MediaStatus BufferedMedia

Description: Enum constant QMediaPlayer::BufferedMedia

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

BufferingMedia

Signature: [static,const] QMediaPlayer_MediaStatus BufferingMedia

Description: Enum constant QMediaPlayer::BufferingMedia

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

EndOfMedia

Signature: [static,const] QMediaPlayer_MediaStatus EndOfMedia

Description: Enum constant QMediaPlayer::EndOfMedia

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

FormatError

Signature: [static,const] QMediaPlayer_Error FormatError

Description: Enum constant QMediaPlayer::FormatError

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

InvalidMedia

Signature: [static,const] QMediaPlayer_MediaStatus InvalidMedia

Description: Enum constant QMediaPlayer::InvalidMedia

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

LoadedMedia

Signature: [static,const] QMediaPlayer_MediaStatus LoadedMedia

Description: Enum constant QMediaPlayer::LoadedMedia

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

LoadingMedia

Signature: [static,const] QMediaPlayer_MediaStatus LoadingMedia

Description: Enum constant QMediaPlayer::LoadingMedia

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

LowLatency

Signature: [static,const] QMediaPlayer_Flag LowLatency

Description: Enum constant QMediaPlayer::LowLatency

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

MediaIsPlaylist

Signature: [static,const] QMediaPlayer_Error MediaIsPlaylist

Description: Enum constant QMediaPlayer::MediaIsPlaylist

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

NetworkError

Signature: [static,const] QMediaPlayer_Error NetworkError

Description: Enum constant QMediaPlayer::NetworkError

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

NoError

Signature: [static,const] QMediaPlayer_Error NoError

Description: Enum constant QMediaPlayer::NoError

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

NoMedia

Signature: [static,const] QMediaPlayer_MediaStatus NoMedia

Description: Enum constant QMediaPlayer::NoMedia

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

PausedState

Signature: [static,const] QMediaPlayer_State PausedState

Description: Enum constant QMediaPlayer::PausedState

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

PlayingState

Signature: [static,const] QMediaPlayer_State PlayingState

Description: Enum constant QMediaPlayer::PlayingState

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

ResourceError

Signature: [static,const] QMediaPlayer_Error ResourceError

Description: Enum constant QMediaPlayer::ResourceError

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

ServiceMissingError

Signature: [static,const] QMediaPlayer_Error ServiceMissingError

Description: Enum constant QMediaPlayer::ServiceMissingError

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

StalledMedia

Signature: [static,const] QMediaPlayer_MediaStatus StalledMedia

Description: Enum constant QMediaPlayer::StalledMedia

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

StoppedState

Signature: [static,const] QMediaPlayer_State StoppedState

Description: Enum constant QMediaPlayer::StoppedState

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

StreamPlayback

Signature: [static,const] QMediaPlayer_Flag StreamPlayback

Description: Enum constant QMediaPlayer::StreamPlayback

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

UnknownMediaStatus

Signature: [static,const] QMediaPlayer_MediaStatus UnknownMediaStatus

Description: Enum constant QMediaPlayer::UnknownMediaStatus

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

VideoSurface

Signature: [static,const] QMediaPlayer_Flag VideoSurface

Description: Enum constant QMediaPlayer::VideoSurface

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

addPropertyWatch

Signature: void addPropertyWatch (bytes name)

Description: Method void QMediaPlayer::addPropertyWatch(QByteArray const &name)

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

audioAvailable

Signature: [const] bool audioAvailable

Description: Method bool QMediaPlayer::isAudioAvailable()

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

audioAvailableChanged

Signature: void audioAvailableChanged (bool available)

Description: Method void QMediaPlayer::audioAvailableChanged(bool available)

availability

Signature: [const] QMultimedia_AvailabilityStatus availability

Description: Virtual method QMultimedia::AvailabilityStatus QMediaPlayer::availability()

This method can be reimplemented in a derived class.

bind

Signature: bool bind (QObject ptr arg1)

Description: Virtual method bool QMediaPlayer::bind(QObject *)

This method can be reimplemented in a derived class.

bufferStatus

Signature: [const] int bufferStatus

Description: Method int QMediaPlayer::bufferStatus()

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

bufferStatusChanged

Signature: void bufferStatusChanged (int percentFilled)

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

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

currentMedia

Signature: [const] QMediaContent currentMedia

Description: Method QMediaContent QMediaPlayer::currentMedia()

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

currentMediaChanged

Signature: void currentMediaChanged (const QMediaContent media)

Description: Method void QMediaPlayer::currentMediaChanged(const QMediaContent &media)

currentNetworkConfiguration

Signature: [const] QNetworkConfiguration currentNetworkConfiguration

Description: Method QNetworkConfiguration QMediaPlayer::currentNetworkConfiguration()

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

duration

Signature: [const] long long duration

Description: Method qint64 QMediaPlayer::duration()

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

durationChanged

Signature: void durationChanged (long long duration)

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

error

Signature: [const] QMediaPlayer_Error error

Description: Method QMediaPlayer::Error QMediaPlayer::error()

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

errorString

Signature: [const] string errorString

Description: Method QString QMediaPlayer::errorString()

error_sig

Signature: void error_sig (const QMediaPlayer_Error error)

Description: Method void QMediaPlayer::error(QMediaPlayer::Error error)

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

hasSupport

Signature: [static] QMultimedia_SupportEstimate hasSupport (string mimeType, string[] codecs = QStringList(), QMediaPlayer_QFlags_Flag flags = 0)

Description: Static method QMultimedia::SupportEstimate QMediaPlayer::hasSupport(const QString &mimeType, const QStringList &codecs, QFlags<QMediaPlayer::Flag> flags)

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

isAudioAvailable?

Signature: [const] bool isAudioAvailable?

Description: Method bool QMediaPlayer::isAudioAvailable()

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

isAvailable

Signature: [const] bool isAvailable

Description: Virtual method bool QMediaPlayer::isAvailable()

This method can be reimplemented in a derived class.

isMuted?

Signature: [const] bool isMuted?

Description: Method bool QMediaPlayer::isMuted()

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

isSeekable?

Signature: [const] bool isSeekable?

Description: Method bool QMediaPlayer::isSeekable()

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

isSignalConnected

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

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

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

isVideoAvailable?

Signature: [const] bool isVideoAvailable?

Description: Method bool QMediaPlayer::isVideoAvailable()

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

media

Signature: [const] QMediaContent media

Description: Method QMediaContent QMediaPlayer::media()

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

mediaChanged

Signature: void mediaChanged (const QMediaContent media)

Description: Method void QMediaPlayer::mediaChanged(const QMediaContent &media)

mediaStatus

Signature: [const] QMediaPlayer_MediaStatus mediaStatus

Description: Method QMediaPlayer::MediaStatus QMediaPlayer::mediaStatus()

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

mediaStatusChanged

Signature: void mediaStatusChanged (const QMediaPlayer_MediaStatus status)

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

mediaStream

Signature: [const] const QIODevice ptr mediaStream

Description: Method const QIODevice *QMediaPlayer::mediaStream()

muted

Signature: [const] bool muted

Description: Method bool QMediaPlayer::isMuted()

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

muted=

Signature: void muted= (bool muted)

Description: Method void QMediaPlayer::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 QMediaPlayer::mutedChanged(bool muted)

networkConfigurationChanged

Signature: void networkConfigurationChanged (const QNetworkConfiguration configuration)

Description: Method void QMediaPlayer::networkConfigurationChanged(const QNetworkConfiguration &configuration)

new

Signature: [static] new QMediaPlayer new (QObject ptr parent = 0, QMediaPlayer_QFlags_Flag flags = 0)

Description: Constructor QMediaPlayer::QMediaPlayer(QObject *parent, QFlags<QMediaPlayer::Flag> flags)

This method creates an object of class QMediaPlayer.

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

pause

Signature: void pause

Description: Method void QMediaPlayer::pause()

play

Signature: void play

Description: Method void QMediaPlayer::play()

playbackRate

Signature: [const] double playbackRate

Description: Method double QMediaPlayer::playbackRate()

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

playbackRate=

Signature: void playbackRate= (double rate)

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

playlist

Signature: [const] QMediaPlaylist ptr playlist

Description: Method QMediaPlaylist *QMediaPlayer::playlist()

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

playlist=

Signature: void playlist= (QMediaPlaylist ptr playlist)

Description: Method void QMediaPlayer::setPlaylist(QMediaPlaylist *playlist)

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

position

Signature: [const] long long position

Description: Method qint64 QMediaPlayer::position()

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

position=

Signature: void position= (long long position)

Description: Method void QMediaPlayer::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 QMediaPlayer::positionChanged(qint64 position)

receivers

Signature: [const] int receivers (string signal)

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

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

removePropertyWatch

Signature: void removePropertyWatch (bytes name)

Description: Method void QMediaPlayer::removePropertyWatch(QByteArray const &name)

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

seekable

Signature: [const] bool seekable

Description: Method bool QMediaPlayer::isSeekable()

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

seekableChanged

Signature: void seekableChanged (bool seekable)

Description: Method void QMediaPlayer::seekableChanged(bool seekable)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMediaPlayer::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaPlayer::senderSignalIndex()

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

service

Signature: [const] QMediaService ptr service

Description: Virtual method QMediaService *QMediaPlayer::service()

This method can be reimplemented in a derived class.

setMedia

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

Description: Method void QMediaPlayer::setMedia(const QMediaContent &media, QIODevice *stream)

setMuted

Signature: void setMuted (bool muted)

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

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

setNetworkConfigurations

Signature: void setNetworkConfigurations (QNetworkConfiguration[] configurations)

Description: Method void QMediaPlayer::setNetworkConfigurations(const QList<QNetworkConfiguration> &configurations)

setPlaybackRate

Signature: void setPlaybackRate (double rate)

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

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

setPlaylist

Signature: void setPlaylist (QMediaPlaylist ptr playlist)

Description: Method void QMediaPlayer::setPlaylist(QMediaPlaylist *playlist)

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

setPosition

Signature: void setPosition (long long position)

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

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

setVideoOutput

(1) Signature: void setVideoOutput (QVideoWidget ptr arg1)

Description: Method void QMediaPlayer::setVideoOutput(QVideoWidget *)

(2) Signature: void setVideoOutput (QGraphicsVideoItem ptr arg1)

Description: Method void QMediaPlayer::setVideoOutput(QGraphicsVideoItem *)

(3) Signature: void setVideoOutput (QAbstractVideoSurface ptr surface)

Description: Method void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)

setVolume

Signature: void setVolume (int volume)

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

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

state

Signature: [const] QMediaPlayer_State state

Description: Method QMediaPlayer::State QMediaPlayer::state()

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

stateChanged

Signature: void stateChanged (const QMediaPlayer_State newState)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Method void QMediaPlayer::stop()

supportedMimeTypes

Signature: [static] string[] supportedMimeTypes (QMediaPlayer_QFlags_Flag flags = 0)

Description: Static method QStringList QMediaPlayer::supportedMimeTypes(QFlags<QMediaPlayer::Flag> flags)

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

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

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

unbind

Signature: void unbind (QObject ptr arg1)

Description: Virtual method void QMediaPlayer::unbind(QObject *)

This method can be reimplemented in a derived class.

videoAvailable

Signature: [const] bool videoAvailable

Description: Method bool QMediaPlayer::isVideoAvailable()

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

videoAvailableChanged

Signature: void videoAvailableChanged (bool videoAvailable)

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

volume

Signature: [const] int volume

Description: Method int QMediaPlayer::volume()

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

volume=

Signature: void volume= (int volume)

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