QMediaPlayerControl Class | Qt Multimedia 5.6

Qt 5.6 | Qt Multimedia | C++ Classes | QMediaPlayerControl

Qt 5.6.2 Reference Documentation

# QMediaPlayerControl Class

The QMediaPlayerControl class provides access to the media playing functionality of a QMediaService. More...

Header: | #include <QMediaPlayerControl>
qmake: | QT += multimedia
Inherits: | QMediaControl

- List of all members, including inherited members

## Public Functions

| ~QMediaPlayerControl()
virtual QMediaTimeRange | availablePlaybackRanges() const = 0
virtual int | bufferStatus() const = 0
virtual qint64 | duration() const = 0
virtual bool | isAudioAvailable() const = 0
virtual bool | isMuted() const = 0
virtual bool | isSeekable() const = 0
virtual bool | isVideoAvailable() const = 0
virtual QMediaContent | media() const = 0
virtual QMediaPlayer::MediaStatus | mediaStatus() const = 0
virtual const QIODevice * | mediaStream() const = 0
virtual void | pause() = 0
virtual void | play() = 0
virtual qreal | playbackRate() const = 0
virtual qint64 | position() const = 0
virtual void | setMedia(const QMediaContent &media, QIODevice *stream) = 0
virtual void | setMuted(bool mute) = 0
virtual void | setPlaybackRate(qreal rate) = 0
virtual void | setPosition(qint64 position) = 0
virtual void | setVolume(int volume) = 0
virtual QMediaPlayer::State | state() const = 0
virtual void | stop() = 0
virtual int | volume() const = 0

- 31 public functions inherited from QObject

## Signals

void | audioAvailableChanged(bool audio)
void | availablePlaybackRangesChanged(const QMediaTimeRange &ranges)
void | bufferStatusChanged(int progress)
void | durationChanged(qint64 duration)
void | error(int error, const QString &errorString)
void | mediaChanged(const QMediaContent &content)
void | mediaStatusChanged(QMediaPlayer::MediaStatus status)
void | mutedChanged(bool mute)
void | playbackRateChanged(qreal rate)
void | positionChanged(qint64 position)
void | seekableChanged(bool seekable)
void | stateChanged(QMediaPlayer::State state)
void | videoAvailableChanged(bool video)
void | volumeChanged(int volume)

- 2 signals inherited from QObject

## Protected Functions

| QMediaPlayerControl(QObject *parent = Q_NULLPTR)

- 9 protected functions inherited from QObject

## Macros

| QMediaPlayerControl_iid

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

The QMediaPlayerControl class provides access to the media playing functionality of a QMediaService.

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 QMediaService::requestControl() and QMediaPlayer.

## Member Function Documentation

### `[protected]` QMediaPlayerControl::QMediaPlayerControl(QObject *parent = Q_NULLPTR)

Constructs a new media player control with the given parent.

### QMediaPlayerControl::~QMediaPlayerControl()

Destroys a media player control.

### `[signal]` void QMediaPlayerControl::audioAvailableChanged(bool audio)

Signals that there has been a change in the availability of audio output.

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.

### `[signal]` void QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &ranges)

Signals that the available media playback ranges have changed.

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.

### `[signal]` void QMediaPlayerControl::bufferStatusChanged(int progress)

Signals that buffering progress has changed.

See also bufferStatus().

### `[pure virtual]` qint64 QMediaPlayerControl::duration() const

Returns the duration of the current media in milliseconds.

### `[signal]` void QMediaPlayerControl::durationChanged(qint64 duration)

Signals that the duration of the current media has changed.

See also duration().

### `[signal]` 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

Returns the current media source.

See also setMedia().

### `[signal]` 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.

### `[signal]` void QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)

Signals that the status of the current media has changed.

See also mediaStatus().

### `[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 setMedia().

### `[signal]` void QMediaPlayerControl::mutedChanged(bool mute)

Signals a change in the mute status of a player control.

See also isMuted().

### `[pure virtual]` void QMediaPlayerControl::pause()

Pauses playback of the current media.

If sucessful the player control will immediately enter the paused state.

See also state(), play(), and stop().

### `[pure virtual]` void QMediaPlayerControl::play()

Starts playback of the current media.

If successful the player control will immediately enter the playing state.

See also state().

### `[pure virtual]` qreal QMediaPlayerControl::playbackRate() const

Returns the rate of playback.

See also setPlaybackRate().

### `[signal]` void QMediaPlayerControl::playbackRateChanged(qreal rate)

Signal emitted when playback rate changes to rate.

### `[pure virtual]` qint64 QMediaPlayerControl::position() const

Returns the current playback position in milliseconds.

See also setPosition().

### `[signal]` 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 position().

### `[signal]` void QMediaPlayerControl::seekableChanged(bool seekable)

Signals that the seekable state of a player control has changed.

See also isSeekable().

### `[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 media().

### `[pure virtual]` void QMediaPlayerControl::setMuted(bool mute)

Sets the mute state of a player control.

See also isMuted().

### `[pure virtual]` void QMediaPlayerControl::setPlaybackRate(qreal rate)

Sets the rate of playback.

See also playbackRate().

### `[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 position().

### `[pure virtual]` void QMediaPlayerControl::setVolume(int volume)

Sets the audio volume of a player control.

See also volume().

### `[pure virtual]` QMediaPlayer::State QMediaPlayerControl::state() const

Returns the state of a player control.

### `[signal]` void QMediaPlayerControl::stateChanged(QMediaPlayer::State state)

Signals that the state of a player control has changed.

See also state().

### `[pure virtual]` void QMediaPlayerControl::stop()

Stops playback of the current media.

If successful the player control will immediately enter the stopped state.

### `[signal]` void QMediaPlayerControl::videoAvailableChanged(bool video)

Signals that there has been a change in the availability of video output.

See also isVideoAvailable().

### `[pure virtual]` int QMediaPlayerControl::volume() const

Returns the audio volume of a player control.

See also setVolume().

### `[signal]` void QMediaPlayerControl::volumeChanged(int volume)

Signals the audio volume of a player control has changed.

See also volume().

## Macro Documentation

### QMediaPlayerControl_iid

`org.qt-project.qt.mediaplayercontrol/5.0`

Defines the interface name of the QMediaPlayerControl class.