QMediaPlayer Class

See also QMediaObject, QMediaService, QVideoWidget, QMediaPlaylist

Defines a media player error condition.

flags QMediaPlayer::Flags

The Flags type is a typedef for QFlags<Flag>. It stores an OR combination of Flag values.

Defines the status of a media player's current media.

Defines the current state of a media player.

This property holds the audio availabilty status for the current media.

As the life time of QMediaPlayer can be longer than the playback of one QMediaContent, this property may change over time, the audioAvailableChanged signal can be used to monitor it's status.

Access functions:

• bool isAudioAvailable() const

Notifier signal:

• void audioAvailableChanged(bool available)

This property holds the role of the audio stream played by the media player.

It can be set to specify the type of audio being played, allowing the system to make appropriate decisions when it comes to volume, routing or post-processing.

The audio role must be set before calling setMedia().

customAudioRole is cleared when this property is set to anything other than QAudio::CustomRole.

This property was introduced in Qt 5.6.

Access functions:

• audioRole() const

• void setAudioRole( audioRole)

Notifier signal:

• void audioRoleChanged( role)

See Also▲

This property holds the percentage of the temporary buffer filled before playback begins or resumes, from 0 (empty) to 100 (full).

When the player object is buffering; this property holds the percentage of the temporary buffer that is filled. The buffer will need to reach 100% filled before playback can start or resume, at which time mediaStatus() will return BufferedMedia or BufferingMedia. If the value is anything lower than 100, mediaStatus() will return StalledMedia.

Access functions:

• int bufferStatus() const

Notifier signal:

• void bufferStatusChanged(int percentFilled)

See Also▲

This property holds the current active media content being played by the player object. This value could be different from QMediaPlayer::media property if a playlist is used. In this case currentMedia indicates the current media content being processed by the player, while QMediaPlayer::media property contains the original playlist.

Access functions:

• currentMedia() const

Notifier signal:

• void currentMediaChanged(const &media)

See Also▲

This property holds the role of the audio stream played by the media player.

It can be set to specify the type of audio being played when the backend supports audio roles unknown to Qt. Specifying a role allows the system to make appropriate decisions when it comes to volume, routing or post-processing.

The audio role must be set before calling setMedia().

audioRole is set to QAudio::CustomRole when this property is set.

This property was introduced in Qt 5.11.

Access functions:

• customAudioRole() const

• void setCustomAudioRole(const &audioRole)

Notifier signal:

• void customAudioRoleChanged(const &role)

See Also▲

This property holds the duration of the current media.

The value is the total playback time in milliseconds of the current media. The value may change across the life time of the QMediaPlayer object and may not be available when initial playback begins, connect to the durationChanged() signal to receive status notifications.

Access functions:

• duration() const

Notifier signal:

• void durationChanged( duration)

This property holds a string describing the last error condition.

Access functions:

• errorString() const

See Also▲

This property holds the active media source being used by the player object.

The player object will use the QMediaContent for selection of the content to be played.

By default this property has a null QMediaContent.

Setting this property to a null QMediaContent will cause the player to discard all information relating to the current media source and to cease all I/O operations related to that media.

Access functions:

• media() const

• void setMedia(const &media, *stream = nullptr)

Notifier signal:

• void mediaChanged(const &media)

See Also▲

This property holds the status of the current media stream.

The stream status describes how the playback of the current stream is progressing.

By default this property is QMediaPlayer::NoMedia

Access functions:

• mediaStatus() const

Notifier signal:

• void mediaStatusChanged( status)

See Also▲

This property holds the muted state of the current media.

The value will be true if the playback volume is muted; otherwise false.

Access functions:

• bool isMuted() const

• void setMuted(bool muted)

Notifier signal:

• void mutedChanged(bool muted)

This property holds the playback rate of the current media.

This value is a multiplier applied to the media's standard play rate. By default this value is 1.0, indicating that the media is playing at the standard pace. Values higher than 1.0 will increase the rate of play. Values less than zero can be set and indicate the media will rewind at the multiplier of the standard pace.

Not all playback services support change of the playback rate. It is framework defined as to the status and quality of audio and video while fast forwarding or rewinding.

Access functions:

• playbackRate() const

• void setPlaybackRate( rate)

Notifier signal:

• void playbackRateChanged( rate)

This property holds the media playlist being used by the player object.

The player object will use the current playlist item for selection of the content to be played.

By default this property is set to null.

If the media playlist is used as a source, QMediaPlayer::currentMedia is updated with a current playlist item. The current source should be selected with QMediaPlaylist::setCurrentIndex(int) instead of QMediaPlayer::setMedia(), otherwise the current playlist will be discarded.

Access functions:

• *playlist() const

• void setPlaylist( *playlist)

See Also▲

This property holds the playback position of the current media.

The value is the current playback position, expressed in milliseconds since the beginning of the media. Periodically changes in the position will be indicated with the signal positionChanged(), the interval between updates can be set with QMediaObject's method setNotifyInterval().

Access functions:

• position() const

• void setPosition( position)

Notifier signal:

• void positionChanged( position)

This property holds the seek-able status of the current media

If seeking is supported this property will be true; false otherwise. The status of this property may change across the life time of the QMediaPlayer object, use the seekableChanged signal to monitor changes.

Access functions:

• bool isSeekable() const

Notifier signal:

• void seekableChanged(bool seekable)

This property holds the media player's playback state.

By default this property is QMediaPlayer::Stopped

Access functions:

• state() const

Notifier signal:

• void stateChanged( state)

See Also▲

This property holds the video availability status for the current media.

If available, the QVideoWidget class can be used to view the video. As the life time of QMediaPlayer can be longer than the playback of one QMediaContent, this property may change over time, the videoAvailableChanged signal can be used to monitor it's status.

Access functions:

• bool isVideoAvailable() const

Notifier signal:

• void videoAvailableChanged(bool videoAvailable)

See Also▲

This property holds the current playback volume.

The playback volume is scaled linearly, ranging from 0 (silence) to 100 (full volume). Values outside this range will be clamped.

By default the volume is 100.

UI volume controls should usually be scaled nonlinearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. See QAudio::convertVolume() for more details.

Access functions:

• int volume() const

• void setVolume(int volume)

Notifier signal:

• void volumeChanged(int volume)

Construct a QMediaPlayer instance parented to parent and with flags.

Destroys the player object.

Signals the availability of audio content has changed to available.

Signals that the audio role of the media player has changed.

This function was introduced in Qt 5.6.

Reimplements: QMediaObject::availability() const.

Signal the amount of the local buffer filled as a percentage by percentFilled.

Signals that the current playing content has been changed to media.

See Also▲

Returns the current network access point in use. If a default contructed QNetworkConfiguration is returned this feature is not available or that none of the current supplied configurations are in use.

Signals that the audio role of the media player has changed.

This function was introduced in Qt 5.11.

Signal the duration of the content has changed to duration, expressed in milliseconds.

Returns the current error state.

Signals that an error condition has occurred.

See Also▲

Returns the level of support a media player has for a mimeType and a set of codecs.

The flags argument allows additional requirements such as performance indicators to be specified.

Signals that the media source has been changed to media.

See Also▲

Signals that the status of the current media has changed.

See Also▲

Returns the stream source of media data.

This is only valid if a stream was passed to setMedia().

See Also▲

Signal the mute state has changed to muted.

Signal that the active in use network access point has been changed to configuration and all subsequent network access will use this configuration.

Pause playing the current source.

Start or resume playing the current source.

Signals the playbackRate has changed to rate.

Signal the position of the content has changed to position, expressed in milliseconds.

Signals the seekable status of the player object has changed.

Sets the current media source.

If a stream is supplied; media data will be read from it instead of resolving the media source. In this case the media source may still be used to resolve additional information about the media such as mime type. The stream must be open and readable.

Setting the media to a null QMediaContent will cause the player to discard all information relating to the current media source and to cease all I/O operations related to that media.

Since Qt 5.12.2, the url scheme gst-pipeline provides custom pipelines for the GStreamer backend.

player = new QMediaPlayer;
player->setMedia(QUrl("gst-pipeline: videotestsrc ! autovideosink"));
player->play();

If the pipeline contains a video sink element named qtvideosink, current QVideoWidget can be used to render the video.

If the pipeline contains appsrc element, it will be used to push data from stream.

QImage img("images/qt-logo.png");
img = img.convertToFormat(QImage::Format_ARGB32);
QByteArray ba(reinterpret_cast<const char *>(img.bits()), img.sizeInBytes());
QBuffer buffer(&ba);
buffer.open(QIODevice::ReadOnly);
player = new QMediaPlayer;
player->setMedia(QUrl("gst-pipeline: appsrc blocksize=4294967295 ! \
    video/x-raw,format=BGRx,framerate=30/1,width=200,height=147 ! \
    coloreffects preset=heat ! videoconvert ! video/x-raw,format=I420 ! jpegenc ! rtpjpegpay ! \
    udpsink host=127.0.0.1 port=5000"), &buffer);
player->play();

QMediaPlayer *receiver = new QMediaPlayer;
videoWidget = new QVideoWidget;
receiver->setVideoOutput(videoWidget);
receiver->setMedia(QUrl("gst-pipeline: udpsrc port=5000 ! \
    application/x-rtp,encoding-name=JPEG,payload=26 ! rtpjpegdepay ! jpegdec ! \
    xvimagesink name=qtvideosink"));
receiver->play();
// Content will be shown in this widget.
videoWidget->show();

See Also▲

Sets the network access points for remote media playback. configurations contains, in ascending preferential order, a list of configuration that can be used for network access.

This will invalidate the choice of previous configurations.

Attach a QVideoWidget video output to the media player.

If the media player has already video output attached, it will be replaced with a new one.

Attach a QGraphicsVideoItem video output to the media player.

If the media player has already video output attached, it will be replaced with a new one.

Sets a video surface as the video output of a media player.

If a video output has already been set on the media player the new surface will replace it.

Signal the state of the Player object has changed.

Stop playing, and reset the play position to the beginning.

Returns a list of supported audio roles.

If setting the audio role is not supported, an empty list is returned.

This function was introduced in Qt 5.6.

See Also▲

Returns a list of supported custom audio roles. An empty list may indicate that the supported custom audio roles aren't known. The list may not be complete.

This function was introduced in Qt 5.11.

See Also▲

Signal the availability of visual content has changed to videoAvailable.

Signal the playback volume has changed to volume.

[static] QStringList QMediaPlayer::supportedMimeTypes(QMediaPlayer::Flags flags = Flags())▲