QMediaPlayer Class

Member Function Documentation

QMediaPlayer::QMediaPlayer(QObject *parent = nullptr, QMediaPlayer::Flags flags = ...)

Construct a QMediaPlayer instance parented to parent and with flags.

[virtual] QMediaPlayer::~QMediaPlayer()

Destroys the player object.

[signal] void QMediaPlayer::audioAvailableChanged(bool available)

Signals the availability of audio content has changed to available.

Note: Notifier signal for property audioAvailable.

[signal] void QMediaPlayer::audioRoleChanged(QAudio::Role role)

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

This function was introduced in Qt 5.6.

Note: Notifier signal for property audioRole.

[override virtual] QMultimedia::AvailabilityStatus QMediaPlayer::availability() const

Reimplemented from QMediaObject::availability().

[signal] void QMediaPlayer::bufferStatusChanged(int percentFilled)

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

Note: Notifier signal for property bufferStatus.

[signal] void QMediaPlayer::currentMediaChanged(const QMediaContent &media)

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

Note: Notifier signal for property currentMedia.

See also currentMedia() and mediaChanged().

QNetworkConfiguration QMediaPlayer::currentNetworkConfiguration() const

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.

[signal] void QMediaPlayer::customAudioRoleChanged(const QString &role)

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

This function was introduced in Qt 5.11.

Note: Notifier signal for property customAudioRole.

[signal] void QMediaPlayer::durationChanged(qint64 duration)

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

Note: Notifier signal for property duration.

QMediaPlayer::Error QMediaPlayer::error() const

Returns the current error state.

[signal] void QMediaPlayer::error(QMediaPlayer::Error error)

Signals that an error condition has occurred.

Note: Signal error is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(mediaPlayer, QOverload<QMediaPlayer::Error>::of(&QMediaPlayer::error),
    [=](QMediaPlayer::Error error){ /* ... */ });

See also errorString().

[static] QMultimedia::SupportEstimate QMediaPlayer::hasSupport(const QString &mimeType, const QStringList &codecs = QStringList(), QMediaPlayer::Flags flags = ...)

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.

[signal] void QMediaPlayer::mediaChanged(const QMediaContent &media)

Signals that the media source has been changed to media.

Note: Notifier signal for property media.

See also media() and currentMediaChanged().

[signal] void QMediaPlayer::mediaStatusChanged(QMediaPlayer::MediaStatus status)

Signals that the status of the current media has changed.

Note: Notifier signal for property mediaStatus.

See also mediaStatus().

const QIODevice *QMediaPlayer::mediaStream() const

Returns the stream source of media data.

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

See also setMedia().

[signal] void QMediaPlayer::mutedChanged(bool muted)

Signal the mute state has changed to muted.

Note: Notifier signal for property muted.

[signal] void QMediaPlayer::networkConfigurationChanged(const QNetworkConfiguration &configuration)

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

[slot] void QMediaPlayer::pause()

Pause playing the current source.

[slot] void QMediaPlayer::play()

Start or resume playing the current source.

[signal] void QMediaPlayer::playbackRateChanged(qreal rate)

Signals the playbackRate has changed to rate.

Note: Notifier signal for property playbackRate.

[signal] void QMediaPlayer::positionChanged(qint64 position)

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

Note: Notifier signal for property position.

[signal] void QMediaPlayer::seekableChanged(bool seekable)

Signals the seekable status of the player object has changed.

Note: Notifier signal for property seekable.

[slot] void QMediaPlayer::setMedia(const QMediaContent &media, QIODevice *stream = nullptr)

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.

Note: This function returns immediately after recording the specified source of the media. It does not wait for the media to finish loading and does not check for errors. Listen for the mediaStatusChanged() and error() signals to be notified when the media is loaded and when an error occurs during loading.

Note: Setter function for property media.

See also media().

[slot] void QMediaPlayer::setNetworkConfigurations(const QList<QNetworkConfiguration> &configurations)

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.

void QMediaPlayer::setVideoOutput(QVideoWidget *output)

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.

void QMediaPlayer::setVideoOutput(QGraphicsVideoItem *output)

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.

void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)

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] void QMediaPlayer::stateChanged(QMediaPlayer::State state)

Signal the state of the Player object has changed.

Note: Notifier signal for property state.

[slot] void QMediaPlayer::stop()

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

QList<QAudio::Role> QMediaPlayer::supportedAudioRoles() const

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 audioRole.

QStringList QMediaPlayer::supportedCustomAudioRoles() const

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 customAudioRole.

[signal] void QMediaPlayer::videoAvailableChanged(bool videoAvailable)

Signal the availability of visual content has changed to videoAvailable.

Note: Notifier signal for property videoAvailable.

[signal] void QMediaPlayer::volumeChanged(int volume)

Signal the playback volume has changed to volume.

Note: Notifier signal for property volume.