QMediaPlayerControl Class▲
-
Header: QMediaPlayerControl
-
qmake: QT += multimedia
-
Inherits: QMediaControl
-
Inherited By:
-
Group: QMediaPlayerControl is part of multimedia_control
Detailed Description▲
If a QMediaService can play media is will implement QMediaPlayerControl. This control provides a means to set the media to play, start, pause and stop playback, seek, and control the volume. It also provides feedback on the duration of the media, the current position, and buffering progress.
The functionality provided by this control is exposed to application code through the QMediaPlayer class.
The interface name of QMediaPlayerControl is org.qt-project.qt.mediaplayercontrol/5.0 as defined in QMediaPlayerControl_iid.
See Also▲
See also QMediaService::requestControl(), QMediaPlayer
Member Function Documentation▲
[explicit protected] QMediaPlayerControl::QMediaPlayerControl(QObject *parent = nullptr)▲
Constructs a new media player control with the given parent.
[virtual] QMediaPlayerControl::~QMediaPlayerControl()▲
Destroys a media player control.
void QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)▲
Signals that there has been a change in the availability of audio output audioAvailable.
See Also▲
See also isAudioAvailable()
[pure virtual] QMediaTimeRange QMediaPlayerControl::availablePlaybackRanges() const▲
Returns a range of times in milliseconds that can be played back.
Usually for local files this is a continuous interval equal to [0..duration()] or an empty time range if seeking is not supported, but for network sources it refers to the buffered parts of the media.
void QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &ranges)▲
Signals that the available media playback ranges have changed.
See Also▲
See also QMediaPlayerControl::availablePlaybackRanges()
[pure virtual] int QMediaPlayerControl::bufferStatus() const▲
Returns the buffering progress of the current media. Progress is measured in the percentage of the buffer filled.
void QMediaPlayerControl::bufferStatusChanged(int percentFilled)▲
Signal the amount of the local buffer filled as a percentage by percentFilled.
See Also▲
See also bufferStatus()
[pure virtual] qint64 QMediaPlayerControl::duration() const▲
Returns the duration of the current media in milliseconds.
void QMediaPlayerControl::durationChanged(qint64 duration)▲
void QMediaPlayerControl::error(int error, const QString &errorString)▲
Signals that an error has occurred. The errorString provides a more detailed explanation.
[pure virtual] bool QMediaPlayerControl::isAudioAvailable() const▲
Identifies if there is audio output available for the current media.
Returns true if audio output is available and false otherwise.
[pure virtual] bool QMediaPlayerControl::isMuted() const▲
Returns the mute state of a player control.
[pure virtual] bool QMediaPlayerControl::isSeekable() const▲
Identifies if the current media is seekable.
Returns true if it possible to seek within the current media, and false otherwise.
[pure virtual] bool QMediaPlayerControl::isVideoAvailable() const▲
Identifies if there is video output available for the current media.
Returns true if video output is available and false otherwise.
[pure virtual] QMediaContent QMediaPlayerControl::media() const▲
void QMediaPlayerControl::mediaChanged(const QMediaContent &content)▲
Signals that the current media content has changed.
[pure virtual] QMediaPlayer::MediaStatus QMediaPlayerControl::mediaStatus() const▲
Returns the status of the current media.
void QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)▲
[pure virtual] const QIODevice *QMediaPlayerControl::mediaStream() const▲
Returns the current media stream. This is only a valid if a stream was passed to setMedia().
See Also▲
See also setMedia()
void QMediaPlayerControl::mutedChanged(bool mute)▲
[pure virtual] void QMediaPlayerControl::pause()▲
Pauses playback of the current media.
If successful the player control will immediately enter the paused state.
See Also▲
[pure virtual] void QMediaPlayerControl::play()▲
Starts playback of the current media.
If successful the player control will immediately enter the playing state.
See Also▲
See also state()
[pure virtual] qreal QMediaPlayerControl::playbackRate() const▲
void QMediaPlayerControl::playbackRateChanged(qreal rate)▲
Signal emitted when playback rate changes to rate.
[pure virtual] qint64 QMediaPlayerControl::position() const▲
void QMediaPlayerControl::positionChanged(qint64 position)▲
Signals the playback position has changed.
This is only emitted in when there has been a discontinous change in the playback postion, such as a seek or the position being reset.
See Also▲
See also position()
void QMediaPlayerControl::seekableChanged(bool seekable)▲
[pure virtual] void QMediaPlayerControl::setMedia(const QMediaContent &media, QIODevice *stream)▲
Sets the current media source. If a stream is supplied; data will be read from that instead of attempting to resolve the media source. The media source may still be used to supply media information such as mime type.
Setting the media to a null QMediaContent will cause the control to discard all information relating to the current media source and to cease all I/O operations related to that media.
Qt resource files are never passed as is. If the service supports QMediaServiceProviderHint::StreamPlayback, a stream is supplied, pointing to an opened QFile. Otherwise, the resource is copied into a temporary file and media contains the url to that file.
See Also▲
See also media()
[pure virtual] void QMediaPlayerControl::setMuted(bool mute)▲
[pure virtual] void QMediaPlayerControl::setPlaybackRate(qreal rate)▲
[pure virtual] void QMediaPlayerControl::setPosition(qint64 position)▲
Sets the playback position of the current media. This will initiate a seek and it may take some time for playback to reach the position set.
See Also▲
See also position()
[pure virtual] void QMediaPlayerControl::setVolume(int volume)▲
Sets the audio volume of a player control.
The volume is scaled linearly, ranging from 0 (silence) to 100 (full volume).
See Also▲
See also volume()
[pure virtual] QMediaPlayer::State QMediaPlayerControl::state() const▲
Returns the state of a player control.
void QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)▲
[pure virtual] void QMediaPlayerControl::stop()▲
Stops playback of the current media.
If successful the player control will immediately enter the stopped state.
void QMediaPlayerControl::videoAvailableChanged(bool videoAvailable)▲
Signal that the availability of visual content has changed to videoAvailable.
See Also▲
See also isVideoAvailable()
[pure virtual] int QMediaPlayerControl::volume() const▲
void QMediaPlayerControl::volumeChanged(int volume)▲
Macro Documentation▲
QMediaPlayerControl_iid▲
org.qt-project.qt.mediaplayercontrol/5.0
Defines the interface name of the QMediaPlayerControl class.