Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Signals | Public Member Functions | Properties | List of all members
QQuickMediaPlayer Class Reference

#include <qquickmediaplayer_p.h>

+ Inheritance diagram for QQuickMediaPlayer:
+ Collaboration diagram for QQuickMediaPlayer:

Signals

void qmlSourceChanged (const QUrl &source)
 
void qmlPositionChanged (int position)
 
void qmlDurationChanged (int duration)
 
void autoPlayChanged (bool autoPlay)
 
- Signals inherited from QMediaPlayer
void sourceChanged (const QUrl &media)
 Signals that the media source has been changed to media.
 
void playbackStateChanged (QMediaPlayer::PlaybackState newState)
 
void mediaStatusChanged (QMediaPlayer::MediaStatus status)
 Signals that the status of the current media has changed.
 
void durationChanged (qint64 duration)
 Signals the duration of the content has changed to duration, expressed in milliseconds.
 
void positionChanged (qint64 position)
 Signals the position of the content has changed to position, expressed in milliseconds.
 
void hasAudioChanged (bool available)
 Signals the availability of audio content has changed to available.
 
void hasVideoChanged (bool videoAvailable)
 Signals the availability of visual content has changed to videoAvailable.
 
void bufferProgressChanged (float progress)
 Signals the amount of the local buffer filled as a number between 0 and 1.
 
void seekableChanged (bool seekable)
 Signals the seekable status of the player object has changed.
 
void playingChanged (bool playing)
 
void playbackRateChanged (qreal rate)
 Signals the playbackRate has changed to rate.
 
void loopsChanged ()
 
void metaDataChanged ()
 
void videoOutputChanged ()
 
void audioOutputChanged ()
 
void tracksChanged ()
 
void activeTracksChanged ()
 
void errorChanged ()
 
void errorOccurred (QMediaPlayer::Error error, const QString &errorString)
 \qmlsignal QtMultimedia::MediaPlayer::errorOccurred(error, errorString)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickMediaPlayer (QObject *parent=nullptr)
 
void qmlSetSource (const QUrl &source)
 
QUrl qmlSource () const
 
void setQmlPosition (int position)
 
int qmlPosition () const
 
int qmlDuration () const
 
bool autoPlay () const
 
void setAutoPlay (bool autoPlay)
 
- Public Member Functions inherited from QMediaPlayer
 QMediaPlayer (QObject *parent=nullptr)
 Constructs a QMediaPlayer instance as a child of {parent}.
 
 ~QMediaPlayer ()
 Destroys the player object.
 
QList< QMediaMetaData > audioTracks () const
 
QList< QMediaMetaData > videoTracks () const
 
QList< QMediaMetaData > subtitleTracks () const
 
int activeAudioTrack () const
 
int activeVideoTrack () const
 
int activeSubtitleTrack () const
 
void setActiveAudioTrack (int index)
 
void setActiveVideoTrack (int index)
 
void setActiveSubtitleTrack (int index)
 
void setAudioOutput (QAudioOutput *output)
 
QAudioOutput * audioOutput () const
 
void setVideoOutput (QObject *)
 
QObject * videoOutput () const
 
void setVideoSink (QVideoSink *sink)
 Sets sink to be the QVideoSink instance to retrieve video data.
 
QVideoSink * videoSink () const
 Returns the QVideoSink instance.
 
QUrl source () const
 
const QIODevice * sourceDevice () const
 Returns the stream source of media data.
 
PlaybackState playbackState () const
 
MediaStatus mediaStatus () const
 
qint64 duration () const
 Returns the duration of the current media in ms.
 
qint64 position () const
 Returns the current position inside the media being played back in ms.
 
bool hasAudio () const
 
bool hasVideo () const
 
float bufferProgress () const
 Returns a number between 0 and 1 when buffering data.
 
QMediaTimeRange bufferedTimeRange () const
 Returns a QMediaTimeRange describing the currently buffered data.
 
bool isSeekable () const
 Returns true if the media is seekable.
 
qreal playbackRate () const
 Returns the current playback rate.
 
bool isPlaying () const
 
int loops () const
 \qmlproperty int QtMultimedia::MediaPlayer::loops
 
void setLoops (int loops)
 
Error error () const
 Returns the current error state.
 
QString errorString () const
 
bool isAvailable () const
 Returns true if the media player is supported on this platform.
 
QMediaMetaData metaData () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Properties

QUrl source
 
int duration
 
int position
 
bool autoPlay
 
- Properties inherited from QMediaPlayer
QUrl source
 the active media source being used by the player object.
 
qint64 duration
 \qmlproperty int QtMultimedia::MediaPlayer::duration
 
qint64 position
 \qmlproperty int QtMultimedia::MediaPlayer::position
 
float bufferProgress
 \qmlproperty real QtMultimedia::MediaPlayer::bufferProgress
 
bool hasAudio
 \qmlproperty bool QtMultimedia::MediaPlayer::hasAudio
 
bool hasVideo
 \qmlproperty bool QtMultimedia::MediaPlayer::hasVideo
 
bool seekable
 \qmlproperty bool QtMultimedia::MediaPlayer::seekable
 
bool playing
 \qmlproperty bool QtMultimedia::MediaPlayer::playing
 
qreal playbackRate
 \qmlproperty real QtMultimedia::MediaPlayer::playbackRate
 
int loops
 Determines how often the media is played before the player stops.
 
PlaybackState playbackState
 Returns the \l{QMediaPlayer::}{PlaybackState}.
 
MediaStatus mediaStatus
 the status of the current media stream.
 
QMediaMetaData metaData
 \qmlproperty mediaMetaData QtMultimedia::MediaPlayer::metaData
 
Error error
 a string describing the last error condition.
 
QString errorString
 \qmlproperty string QtMultimedia::MediaPlayer::errorString
 
QObject * videoOutput
 \qmlproperty VideoOutput QtMultimedia::MediaPlayer::videoOutput
 
QAudioOutput * audioOutput
 \qmlproperty AudioOutput QtMultimedia::MediaPlayer::audioOutput
 
QList< QMediaMetaData > audioTracks
 \qmlproperty list<mediaMetaData> QtMultimedia::MediaPlayer::audioTracks
 
QList< QMediaMetaData > videoTracks
 \qmlproperty list<mediaMetaData> QtMultimedia::MediaPlayer::videoTracks
 
QList< QMediaMetaData > subtitleTracks
 \qmlproperty list<mediaMetaData> QtMultimedia::MediaPlayer::subtitleTracks
 
int activeAudioTrack
 \qmlproperty int QtMultimedia::MediaPlayer::activeAudioTrack
 
int activeVideoTrack
 Returns the currently active video track.
 
int activeSubtitleTrack
 Returns the currently active subtitle track.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QMediaPlayer
enum  PlaybackState { StoppedState , PlayingState , PausedState }
 Defines the current state of a media player. More...
 
enum  MediaStatus {
  NoMedia , LoadingMedia , LoadedMedia , StalledMedia ,
  BufferingMedia , BufferedMedia , EndOfMedia , InvalidMedia
}
 \qmlproperty enumeration QtMultimedia::MediaPlayer::playbackState More...
 
enum  Error {
  NoError , ResourceError , FormatError , NetworkError ,
  AccessDeniedError
}
 \qmlproperty enumeration QtMultimedia::MediaPlayer::mediaStatus More...
 
enum  Loops { Infinite = -1 , Once = 1 }
 Some predefined constants for the \l loops property. More...
 
- Public Slots inherited from QMediaPlayer
void play ()
 \qmlmethod QtMultimedia::MediaPlayer::play()
 
void pause ()
 \qmlmethod QtMultimedia::MediaPlayer::pause()
 
void stop ()
 \qmlmethod QtMultimedia::MediaPlayer::stop()
 
void setPosition (qint64 position)
 
void setPlaybackRate (qreal rate)
 
void setSource (const QUrl &source)
 \qmlproperty url QtMultimedia::MediaPlayer::source
 
void setSourceDevice (QIODevice *device, const QUrl &sourceUrl=QUrl())
 Sets the current source device.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 26 of file qquickmediaplayer_p.h.

Constructor & Destructor Documentation

◆ QQuickMediaPlayer()

QT_BEGIN_NAMESPACE QQuickMediaPlayer::QQuickMediaPlayer ( QObject * parent = nullptr)

Definition at line 9 of file qquickmediaplayer.cpp.

References QObject::connect(), QMediaPlayer::durationChanged(), QMediaPlayer::mediaStatusChanged(), and QMediaPlayer::positionChanged().

+ Here is the call graph for this function:

Member Function Documentation

◆ autoPlay()

bool QQuickMediaPlayer::autoPlay ( ) const
Since
6.7 \qmlproperty bool QtMultimedia::MediaPlayer::autoPlay

This property controls whether the media begins to play automatically after it gets loaded. Defaults to false.

Definition at line 82 of file qquickmediaplayer.cpp.

◆ autoPlayChanged

void QQuickMediaPlayer::autoPlayChanged ( bool autoPlay)
signal

Referenced by setAutoPlay().

+ Here is the caller graph for this function:

◆ qmlDuration()

int QQuickMediaPlayer::qmlDuration ( ) const

Definition at line 43 of file qquickmediaplayer.cpp.

References duration.

◆ qmlDurationChanged

void QQuickMediaPlayer::qmlDurationChanged ( int duration)
signal

◆ qmlPosition()

int QQuickMediaPlayer::qmlPosition ( ) const

Definition at line 38 of file qquickmediaplayer.cpp.

References position.

◆ qmlPositionChanged

void QQuickMediaPlayer::qmlPositionChanged ( int position)
signal

◆ qmlSetSource()

void QQuickMediaPlayer::qmlSetSource ( const QUrl & source)

Definition at line 17 of file qquickmediaplayer.cpp.

References context, emit, qmlContext(), qmlSourceChanged(), QMediaPlayer::setSource(), and source.

+ Here is the call graph for this function:

◆ qmlSource()

QUrl QQuickMediaPlayer::qmlSource ( ) const

Definition at line 28 of file qquickmediaplayer.cpp.

◆ qmlSourceChanged

void QQuickMediaPlayer::qmlSourceChanged ( const QUrl & source)
signal

Referenced by qmlSetSource().

+ Here is the caller graph for this function:

◆ setAutoPlay()

void QQuickMediaPlayer::setAutoPlay ( bool autoPlay)

Definition at line 87 of file qquickmediaplayer.cpp.

References autoPlay, autoPlayChanged(), and emit.

+ Here is the call graph for this function:

◆ setQmlPosition()

void QQuickMediaPlayer::setQmlPosition ( int position)

Definition at line 33 of file qquickmediaplayer.cpp.

References position, and setPosition().

+ Here is the call graph for this function:

Property Documentation

◆ autoPlay

bool QQuickMediaPlayer::autoPlay
readwrite

Definition at line 35 of file qquickmediaplayer_p.h.

Referenced by setAutoPlay().

◆ duration

int QQuickMediaPlayer::duration
read

Definition at line 33 of file qquickmediaplayer_p.h.

Referenced by qmlDuration().

◆ position

int QQuickMediaPlayer::position
readwrite

Definition at line 34 of file qquickmediaplayer_p.h.

Referenced by qmlPosition(), and setQmlPosition().

◆ source

QUrl QQuickMediaPlayer::source
readwrite

Definition at line 29 of file qquickmediaplayer_p.h.

Referenced by qmlSetSource().

The documentation for this class was generated from the following files: