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
QQuickPlaylist Class Reference

#include <qquickplaylist_p.h>

+ Inheritance diagram for QQuickPlaylist:
+ Collaboration diagram for QQuickPlaylist:

Public Types

enum  PlaybackMode { CurrentItemOnce = QMediaPlaylist::CurrentItemOnce , CurrentItemInLoop = QMediaPlaylist::CurrentItemInLoop , Sequential = QMediaPlaylist::Sequential , Loop = QMediaPlaylist::Loop }
 
enum  Error {
  NoError = QMediaPlaylist::NoError , FormatError = QMediaPlaylist::FormatError , FormatNotSupportedError = QMediaPlaylist::FormatNotSupportedError , NetworkError = QMediaPlaylist::NetworkError ,
  AccessDeniedError = QMediaPlaylist::AccessDeniedError
}
 
enum  Roles { SourceRole = Qt::UserRole + 1 }
 
- Public Types inherited from QAbstractItemModel
enum  LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
 This enum describes the way the model changes layout. More...
 
enum class  CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }
 

Public Slots

QUrl itemSource (int index)
 \qmlmethod url QtMultimedia::Playlist::itemSource(index)
 
int nextIndex (int steps=1)
 \qmlmethod int QtMultimedia::Playlist::nextIndex(steps)
 
int previousIndex (int steps=1)
 \qmlmethod int QtMultimedia::Playlist::previousIndex(steps)
 
void next ()
 \qmlmethod QtMultimedia::Playlist::next()
 
void previous ()
 \qmlmethod QtMultimedia::Playlist::previous()
 
void shuffle ()
 \qmlmethod QtMultimedia::Playlist::shuffle()
 
void load (const QUrl &location, const QString &format=QString())
 \qmlmethod QtMultimedia::Playlist::load(location, format)
 
bool save (const QUrl &location, const QString &format=QString())
 \qmlmethod bool QtMultimedia::Playlist::save(location, format)
 
void addItem (const QUrl &source)
 \qmlmethod bool QtMultimedia::Playlist::addItem(source)
 
 Q_REVISION (1) void addItems(const QList< QUrl > &sources)
 
bool insertItem (int index, const QUrl &source)
 \qmlmethod bool QtMultimedia::Playlist::insertItem(index, source)
 
 Q_REVISION (1) bool insertItems(int index
 
- Public Slots inherited from QAbstractItemModel
virtual bool submit ()
 Lets the model know that it should submit cached information to permanent storage.
 
virtual void revert ()
 Lets the model know that it should discard cached information.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void playbackModeChanged ()
 
void currentItemSourceChanged ()
 
void currentIndexChanged ()
 
void itemCountChanged ()
 
void errorChanged ()
 
void itemAboutToBeInserted (int start, int end)
 
void itemInserted (int start, int end)
 
void itemAboutToBeRemoved (int start, int end)
 
void itemRemoved (int start, int end)
 
void itemChanged (int start, int end)
 
void loaded ()
 
void loadFailed ()
 
void error (QQuickPlaylist::Error error, const QString &errorString)
 
- Signals inherited from QAbstractItemModel
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
 This signal is emitted whenever the data in an existing item changes.
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 This signal is emitted whenever a header is changed.
 
void layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are inserted into the model.
 
void rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been inserted into the model.
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are removed from the model.
 
void rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been removed from the model.
 
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are inserted into the model.
 
void columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been inserted into the model.
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are removed from the model.
 
void columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been removed from the model.
 
void modelAboutToBeReset (QPrivateSignal)
 
void modelReset (QPrivateSignal)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
 
- 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

 QQuickPlaylist (QObject *parent=0)
 
 ~QQuickPlaylist ()
 
PlaybackMode playbackMode () const
 \qmlproperty enumeration QtMultimedia::Playlist::playbackMode
 
void setPlaybackMode (PlaybackMode playbackMode)
 
QUrl currentItemSource () const
 \qmlproperty url QtMultimedia::Playlist::currentItemsource
 
int currentIndex () const
 \qmlproperty int QtMultimedia::Playlist::currentIndex
 
void setCurrentIndex (int currentIndex)
 
int itemCount () const
 \qmlproperty int QtMultimedia::Playlist::itemCount
 
Error error () const
 \qmlproperty enumeration QtMultimedia::Playlist::error
 
QString errorString () const
 \qmlproperty string QtMultimedia::Playlist::errorString
 
QMediaPlaylist * mediaPlaylist () const
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 Returns the number of rows under the given parent.
 
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
 Returns the data stored under the given role for the item referred to by the index.
 
QHash< int, QByteArrayroleNames () const override
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
QQmlListProperty< QQuickPlaylistItemitems ()
 
 Q_REVISION (1) bool moveItem(int from
 
bool removeItem (int index)
 \qmlmethod bool QtMultimedia::Playlist::removeItem(index)
 
 Q_REVISION (1) bool removeItems(int start
 
void clear ()
 \qmlmethod bool QtMultimedia::Playlist::clear()
 
- Public Member Functions inherited from QAbstractListModel
 QAbstractListModel (QObject *parent=nullptr)
 Constructs an abstract list model with the given parent.
 
 ~QAbstractListModel ()
 Destroys the abstract list model.
 
QModelIndex index (int row, int column=0, const QModelIndex &parent=QModelIndex()) const override
 Returns the index of the data in row and column with parent.
 
QModelIndex sibling (int row, int column, const QModelIndex &idx) const override
 \reimp
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 \reimp
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 \reimp
 
QObjectparent () const
 Returns a pointer to the parent object.
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent=nullptr)
 Constructs an abstract item model with the given parent.
 
virtual ~QAbstractItemModel ()
 Destroys the abstract item model.
 
Q_INVOKABLE bool hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
 Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
 
virtual Q_INVOKABLE bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 Sets the role data for the item at index to value.
 
virtual Q_INVOKABLE QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 Returns the data for the given role and section in the header with the specified orientation.
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
 Sets the data for the given role and section in the header with the specified orientation to the value supplied.
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const
 Returns a map with values for all predefined roles in the model for the item at the given index.
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
 
virtual bool clearItemData (const QModelIndex &index)
 
virtual QStringList mimeTypes () const
 Returns the list of allowed MIME types.
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const
 Returns an object that contains serialized items of data corresponding to the list of indexes specified.
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
 Returns {true} if a model can accept a drop of the data.
 
virtual Qt::DropActions supportedDropActions () const
 
virtual Qt::DropActions supportedDragActions () const
 Returns the actions supported by the data in this model.
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertRows(int row
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertColumns(int column
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeRows(int row
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeColumns(int column
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertRow(int row
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertColumn(int column
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeRow(int row
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeColumn(int column
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
 
virtual Q_INVOKABLE void fetchMore (const QModelIndex &parent)
 Fetches any available data for the items with the parent specified by the parent index.
 
virtual Q_INVOKABLE bool canFetchMore (const QModelIndex &parent) const
 Returns {true} if there is more data available for parent; otherwise returns {false}.
 
Q_INVOKABLE Q_REVISION (6, 4) virtual void sort(int column
 
virtual QModelIndex buddy (const QModelIndex &index) const
 Returns a model index for the buddy of the item represented by index.
 
virtual Q_INVOKABLE QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
 Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
 
virtual QSize span (const QModelIndex &index) const
 Returns the row and column span of the item represented by index.
 
bool checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
 
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Static Public Member Functions

static void item_append (QQmlListProperty< QQuickPlaylistItem > *list, QQuickPlaylistItem *item)
 
static qsizetype item_count (QQmlListProperty< QQuickPlaylistItem > *list)
 
static void item_clear (QQmlListProperty< QQuickPlaylistItem > *list)
 
- 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)
 

Public Attributes

const QList< QUrl > & sources
 
int to
 
int end
 
- Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int count
 
Q_INVOKABLE int const QModelIndexparent = QModelIndex())
 Returns the parent of the model item with the given index.
 
Q_INVOKABLE int sourceRow
 
Q_INVOKABLE int int count
 
Q_INVOKABLE int int const QModelIndexdestinationParent
 
Q_INVOKABLE int int const QModelIndex int destinationChild
 
Q_INVOKABLE int sourceColumn
 
Q_INVOKABLE const QModelIndexparent = QModelIndex())
 
Q_INVOKABLE int const QModelIndexdestinationParent
 
Q_INVOKABLE int const QModelIndex int destinationChild
 
Q_INVOKABLE Qt::SortOrder order = Qt::AscendingOrder)
 

Properties

PlaybackMode playbackMode
 
QUrl currentItemSource
 
int currentIndex
 
int itemCount
 
Error error
 
QString errorString
 
QQmlListProperty< QQuickPlaylistItemitems
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Protected Slots inherited from QAbstractItemModel
virtual void resetInternalData ()
 
- Protected Member Functions inherited from QAbstractListModel
 QAbstractListModel (QAbstractItemModelPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
 
QModelIndex createIndex (int row, int column, const void *data=nullptr) const
 Creates a model index for the given row and column with the internal pointer ptr.
 
QModelIndex createIndex (int row, int column, quintptr id) const
 Creates a model index for the given row and column with the internal identifier, id.
 
void encodeData (const QModelIndexList &indexes, QDataStream &stream) const
 
bool decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 Begins a row insertion operation.
 
void endInsertRows ()
 Ends a row insertion operation.
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 Begins a row removal operation.
 
void endRemoveRows ()
 Ends a row removal operation.
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
 
void endMoveRows ()
 Ends a row move operation.
 
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 Begins a column insertion operation.
 
void endInsertColumns ()
 Ends a column insertion operation.
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 Begins a column removal operation.
 
void endRemoveColumns ()
 Ends a column removal operation.
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
 Begins a column move operation.
 
void endMoveColumns ()
 Ends a column move operation.
 
void beginResetModel ()
 Begins a model reset operation.
 
void endResetModel ()
 Completes a model reset operation.
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndexList persistentIndexList () const
 
- Protected Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 43 of file qquickplaylist_p.h.

Member Enumeration Documentation

◆ Error

Enumerator
NoError 
FormatError 
FormatNotSupportedError 
NetworkError 
AccessDeniedError 

Definition at line 68 of file qquickplaylist_p.h.

◆ PlaybackMode

Enumerator
CurrentItemOnce 
CurrentItemInLoop 
Sequential 
Loop 

Definition at line 58 of file qquickplaylist_p.h.

◆ Roles

Enumerator
SourceRole 

Definition at line 78 of file qquickplaylist_p.h.

Constructor & Destructor Documentation

◆ QQuickPlaylist()

QQuickPlaylist::QQuickPlaylist ( QObject * parent = 0)

Definition at line 147 of file qquickplaylist.cpp.

◆ ~QQuickPlaylist()

QQuickPlaylist::~QQuickPlaylist ( )

Definition at line 154 of file qquickplaylist.cpp.

Member Function Documentation

◆ addItem

void QQuickPlaylist::addItem ( const QUrl & source)
slot

\qmlmethod bool QtMultimedia::Playlist::addItem(source)

Appends the source URL to the playlist.

Returns true if the source is added successfully.

Definition at line 374 of file qquickplaylist.cpp.

Referenced by item_append().

+ Here is the caller graph for this function:

◆ classBegin()

void QQuickPlaylist::classBegin ( )
overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 514 of file qquickplaylist.cpp.

References QObject::connect(), currentIndexChanged(), currentItemSourceChanged(), loaded(), loadFailed(), playbackModeChanged(), SIGNAL, and SLOT.

+ Here is the call graph for this function:

◆ clear()

void QQuickPlaylist::clear ( )

\qmlmethod bool QtMultimedia::Playlist::clear()

Removes all the items from the playlist.

Returns true if the operation is successful.

Definition at line 484 of file qquickplaylist.cpp.

Referenced by item_clear().

+ Here is the caller graph for this function:

◆ componentComplete()

void QQuickPlaylist::componentComplete ( )
overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 540 of file qquickplaylist.cpp.

◆ currentIndex()

int QQuickPlaylist::currentIndex ( ) const

\qmlproperty int QtMultimedia::Playlist::currentIndex

This property holds the position of the current item in the playlist.

Definition at line 208 of file qquickplaylist.cpp.

◆ currentIndexChanged

void QQuickPlaylist::currentIndexChanged ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ currentItemSource()

QUrl QQuickPlaylist::currentItemSource ( ) const

\qmlproperty url QtMultimedia::Playlist::currentItemsource

This property holds the source URL of the current item in the playlist.

Definition at line 198 of file qquickplaylist.cpp.

◆ currentItemSourceChanged

void QQuickPlaylist::currentItemSourceChanged ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ data()

QVariant QQuickPlaylist::data ( const QModelIndex & index,
int role = Qt::DisplayRole ) const
overridevirtual

Returns the data stored under the given role for the item referred to by the index.

Note
If you do not have a value to return, return an invalid (default-constructed) QVariant.
See also
Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 497 of file qquickplaylist.cpp.

References Q_UNUSED.

◆ error() [1/2]

QQuickPlaylist::Error QQuickPlaylist::error ( ) const

\qmlproperty enumeration QtMultimedia::Playlist::error

This property holds the error condition of the playlist.

\table \header

  • Value
  • Description \row
  • NoError
  • No errors \row
  • FormatError
  • Format error. \row
  • FormatNotSupportedError
  • Format not supported. \row
  • NetworkError
  • Network error. \row
  • AccessDeniedError
  • Access denied error. \endtable

Definition at line 250 of file qquickplaylist.cpp.

◆ error [2/2]

void QQuickPlaylist::error ( QQuickPlaylist::Error error,
const QString & errorString )
signal

◆ errorChanged

void QQuickPlaylist::errorChanged ( )
signal

Referenced by load().

+ Here is the caller graph for this function:

◆ errorString()

QString QQuickPlaylist::errorString ( ) const

\qmlproperty string QtMultimedia::Playlist::errorString

This property holds a string describing the current error condition of the playlist.

Definition at line 260 of file qquickplaylist.cpp.

◆ insertItem

bool QQuickPlaylist::insertItem ( int index,
const QUrl & source )
slot

\qmlmethod bool QtMultimedia::Playlist::insertItem(index, source)

Inserts the source URL to the playlist at the given index.

Returns true if the source is added successfully.

Definition at line 409 of file qquickplaylist.cpp.

◆ item_append()

static void QQuickPlaylist::item_append ( QQmlListProperty< QQuickPlaylistItem > * list,
QQuickPlaylistItem * item )
inlinestatic

Definition at line 107 of file qquickplaylist_p.h.

References addItem(), item, and list.

Referenced by items().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ item_clear()

static void QQuickPlaylist::item_clear ( QQmlListProperty< QQuickPlaylistItem > * list)
inlinestatic

Definition at line 114 of file qquickplaylist_p.h.

References clear(), and list.

Referenced by items().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ item_count()

static qsizetype QQuickPlaylist::item_count ( QQmlListProperty< QQuickPlaylistItem > * list)
inlinestatic

Definition at line 111 of file qquickplaylist_p.h.

References itemCount, and list.

Referenced by items().

+ Here is the caller graph for this function:

◆ itemAboutToBeInserted

void QQuickPlaylist::itemAboutToBeInserted ( int start,
int end )
signal

◆ itemAboutToBeRemoved

void QQuickPlaylist::itemAboutToBeRemoved ( int start,
int end )
signal

◆ itemChanged

void QQuickPlaylist::itemChanged ( int start,
int end )
signal

◆ itemCount()

int QQuickPlaylist::itemCount ( ) const

\qmlproperty int QtMultimedia::Playlist::itemCount

This property holds the number of items in the playlist.

Definition at line 226 of file qquickplaylist.cpp.

◆ itemCountChanged

void QQuickPlaylist::itemCountChanged ( )
signal

◆ itemInserted

void QQuickPlaylist::itemInserted ( int start,
int end )
signal

◆ itemRemoved

void QQuickPlaylist::itemRemoved ( int start,
int end )
signal

◆ items()

QQmlListProperty< QQuickPlaylistItem > QQuickPlaylist::items ( )
inline

Definition at line 103 of file qquickplaylist_p.h.

References item_append(), item_clear(), and item_count().

+ Here is the call graph for this function:

◆ itemSource

QUrl QQuickPlaylist::itemSource ( int index)
slot

\qmlmethod url QtMultimedia::Playlist::itemSource(index)

Returns the source URL of the item at the given index in the playlist.

Definition at line 270 of file qquickplaylist.cpp.

◆ load

void QQuickPlaylist::load ( const QUrl & location,
const QString & format = QString() )
slot

\qmlmethod QtMultimedia::Playlist::load(location, format)

Loads a playlist from the given location. If format is specified, it is used, otherwise the format is guessed from the location name and the data.

New items are appended to the playlist.

onloaded() is emitted if the playlist loads successfully, otherwise onLoadFailed() is emitted with \l error and \l errorString defined accordingly.

Definition at line 346 of file qquickplaylist.cpp.

References emit, and errorChanged().

+ Here is the call graph for this function:

◆ loaded

void QQuickPlaylist::loaded ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ loadFailed

void QQuickPlaylist::loadFailed ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ mediaPlaylist()

QMediaPlaylist * QQuickPlaylist::mediaPlaylist ( ) const
inline

Definition at line 94 of file qquickplaylist_p.h.

◆ next

void QQuickPlaylist::next ( )
slot

\qmlmethod QtMultimedia::Playlist::next()

Advances to the next item in the playlist.

Definition at line 310 of file qquickplaylist.cpp.

◆ nextIndex

int QQuickPlaylist::nextIndex ( int steps = 1)
slot

\qmlmethod int QtMultimedia::Playlist::nextIndex(steps)

Returns the index of the item in the playlist which would be current after calling next() steps times.

Returned value depends on the size of the playlist, the current position and the playback mode.

See also
playbackMode, previousIndex()

Definition at line 285 of file qquickplaylist.cpp.

◆ playbackMode()

QQuickPlaylist::PlaybackMode QQuickPlaylist::playbackMode ( ) const

\qmlproperty enumeration QtMultimedia::Playlist::playbackMode

This property holds the order in which items in the playlist are played.

\table \header

  • Value
  • Description \row
  • CurrentItemOnce
  • The current item is played only once. \row
  • CurrentItemInLoop
  • The current item is played repeatedly in a loop. \row
  • Sequential
  • Playback starts from the current and moves through each successive item until the last is reached and then stops. The next item is a null item when the last one is currently playing. \row
  • Loop
  • Playback restarts at the first item after the last has finished playing. \row
  • Random
  • Play items in random order. \endtable

Definition at line 180 of file qquickplaylist.cpp.

◆ playbackModeChanged

void QQuickPlaylist::playbackModeChanged ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ previous

void QQuickPlaylist::previous ( )
slot

\qmlmethod QtMultimedia::Playlist::previous()

Returns to the previous item in the playlist.

Definition at line 320 of file qquickplaylist.cpp.

◆ previousIndex

int QQuickPlaylist::previousIndex ( int steps = 1)
slot

\qmlmethod int QtMultimedia::Playlist::previousIndex(steps)

Returns the index of the item in the playlist which would be current after calling previous() steps times.

Returned value depends on the size of the playlist, the current position and the playback mode.

See also
playbackMode, nextIndex()

Definition at line 300 of file qquickplaylist.cpp.

◆ Q_REVISION [1/4]

QQuickPlaylist::Q_REVISION ( 1 )
slot

◆ Q_REVISION() [2/4]

QQuickPlaylist::Q_REVISION ( 1 )

◆ Q_REVISION() [3/4]

QQuickPlaylist::Q_REVISION ( 1 )

◆ Q_REVISION [4/4]

QQuickPlaylist::Q_REVISION ( 1 ) const &
slot

◆ removeItem()

bool QQuickPlaylist::removeItem ( int index)

\qmlmethod bool QtMultimedia::Playlist::removeItem(index)

Removes the item at the given index from the playlist.

Returns true if the item is removed successfully.

Definition at line 458 of file qquickplaylist.cpp.

◆ roleNames()

QHash< int, QByteArray > QQuickPlaylist::roleNames ( ) const
overridevirtual
Since
4.6

Returns the model's role names.

The default role names set by Qt are:

\table \header

Reimplemented from QAbstractItemModel.

Definition at line 507 of file qquickplaylist.cpp.

References roleNames(), and SourceRole.

Referenced by roleNames().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rowCount()

int QQuickPlaylist::rowCount ( const QModelIndex & parent = QModelIndex()) const
overridevirtual

Returns the number of rows under the given parent.

When the parent is valid it means that rowCount is returning the number of children of parent.

Note
When implementing a table based model, rowCount() should return 0 when the parent is valid.
See also
columnCount()

Implements QAbstractItemModel.

Definition at line 489 of file qquickplaylist.cpp.

References QAbstractListModel::parent().

+ Here is the call graph for this function:

◆ save

bool QQuickPlaylist::save ( const QUrl & location,
const QString & format = QString() )
slot

\qmlmethod bool QtMultimedia::Playlist::save(location, format)

Saves the playlist to the given location. If format is specified, it is used, otherwise the format is guessed from the location name.

Returns true if the playlist is saved successfully.

Definition at line 362 of file qquickplaylist.cpp.

◆ setCurrentIndex()

void QQuickPlaylist::setCurrentIndex ( int currentIndex)

Definition at line 213 of file qquickplaylist.cpp.

References currentIndex.

◆ setPlaybackMode()

void QQuickPlaylist::setPlaybackMode ( PlaybackMode playbackMode)

Definition at line 185 of file qquickplaylist.cpp.

References playbackMode.

◆ shuffle

void QQuickPlaylist::shuffle ( )
slot

\qmlmethod QtMultimedia::Playlist::shuffle()

Shuffles items in the playlist.

Definition at line 330 of file qquickplaylist.cpp.

Member Data Documentation

◆ end

int QQuickPlaylist::end

Definition at line 133 of file qquickplaylist_p.h.

◆ sources

const QList<QUrl>& QQuickPlaylist::sources

Definition at line 130 of file qquickplaylist_p.h.

◆ to

int QQuickPlaylist::to

Definition at line 131 of file qquickplaylist_p.h.

Property Documentation

◆ currentIndex

int QQuickPlaylist::currentIndex
readwrite

Definition at line 48 of file qquickplaylist_p.h.

Referenced by setCurrentIndex().

◆ currentItemSource

QUrl QQuickPlaylist::currentItemSource
read

Definition at line 47 of file qquickplaylist_p.h.

◆ error

Error QQuickPlaylist::error
read

Definition at line 50 of file qquickplaylist_p.h.

◆ errorString

QString QQuickPlaylist::errorString
read

Definition at line 51 of file qquickplaylist_p.h.

◆ itemCount

int QQuickPlaylist::itemCount
read

Definition at line 49 of file qquickplaylist_p.h.

Referenced by item_count().

◆ items

QQmlListProperty<QQuickPlaylistItem> QQuickPlaylist::items
read

Definition at line 52 of file qquickplaylist_p.h.

◆ playbackMode

PlaybackMode QQuickPlaylist::playbackMode
readwrite

Definition at line 46 of file qquickplaylist_p.h.

Referenced by setPlaybackMode().


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