qquickplaylist_p.h

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QQUICKPLAYLIST_P_H
#define QQUICKPLAYLIST_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtCore/QAbstractListModel>
#include <QtQml/qqmlparserstatus.h>
#include <QtQml/qqml.h>
 
#include <qmediaplaylist.h>
#include <private/qglobal_p.h>
 
QT_BEGIN_NAMESPACE
 
class QQuickPlaylistItem : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QUrl source READ source WRITE setSource)
    QML_NAMED_ELEMENT(PlaylistItem)
 
public:
    QQuickPlaylistItem(QObject *parent = 0);
 
    QUrl source() const;
    void setSource(const QUrl &source);
 
private:
    QUrl m_source;
};
 
class QQuickPlaylist : public QAbstractListModel, public QQmlParserStatus
{
    Q_OBJECT
    Q_PROPERTY(PlaybackMode playbackMode READ playbackMode WRITE setPlaybackMode NOTIFY playbackModeChanged)
    Q_PROPERTY(QUrl currentItemSource READ currentItemSource NOTIFY currentItemSourceChanged)
    Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)
    Q_PROPERTY(int itemCount READ itemCount NOTIFY itemCountChanged)
    Q_PROPERTY(Error error READ error NOTIFY errorChanged)
    Q_PROPERTY(QString errorString READ errorString NOTIFY errorChanged)
    Q_PROPERTY(QQmlListProperty<QQuickPlaylistItem> items READ items DESIGNABLE false)
    Q_INTERFACES(QQmlParserStatus)
    Q_CLASSINFO("DefaultProperty", "items")
    QML_NAMED_ELEMENT(Playlist)
 
public:
    enum PlaybackMode
    {
        CurrentItemOnce = QMediaPlaylist::CurrentItemOnce,
        CurrentItemInLoop = QMediaPlaylist::CurrentItemInLoop,
        Sequential = QMediaPlaylist::Sequential,
        Loop = QMediaPlaylist::Loop,
//        Random = QMediaPlaylist::Random
    };
    Q_ENUM(PlaybackMode)
 
    enum Error
    {
        NoError = QMediaPlaylist::NoError,
        FormatError = QMediaPlaylist::FormatError,
        FormatNotSupportedError = QMediaPlaylist::FormatNotSupportedError,
        NetworkError = QMediaPlaylist::NetworkError,
        AccessDeniedError = QMediaPlaylist::AccessDeniedError
    };
    Q_ENUM(Error)
 
    enum Roles
    {
        SourceRole = Qt::UserRole + 1
    };
 
    QQuickPlaylist(QObject *parent = 0);
    ~QQuickPlaylist();
 
    PlaybackMode playbackMode() const;
    void setPlaybackMode(PlaybackMode playbackMode);
    QUrl currentItemSource() const;
    int currentIndex() const;
    void setCurrentIndex(int currentIndex);
    int itemCount() const;
    Error error() const;
    QString errorString() const;
    QMediaPlaylist *mediaPlaylist() const { return m_playlist; }
 
    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
    QHash<int, QByteArray> roleNames() const override;
 
    void classBegin() override;
    void componentComplete() override;
 
    QQmlListProperty<QQuickPlaylistItem> items() {
        return QQmlListProperty<QQuickPlaylistItem>(
            this, 0, item_append, item_count, 0, item_clear);
    }
    static void item_append(QQmlListProperty<QQuickPlaylistItem> *list,
                            QQuickPlaylistItem* item) {
        static_cast<QQuickPlaylist*>(list->object)->addItem(item->source());
    }
    static qsizetype item_count(QQmlListProperty<QQuickPlaylistItem> *list) {
        return static_cast<QQuickPlaylist*>(list->object)->itemCount();
    }
    static void item_clear(QQmlListProperty<QQuickPlaylistItem> *list) {
        static_cast<QQuickPlaylist*>(list->object)->clear();
    }
 
public Q_SLOTS:
    QUrl itemSource(int index);
    int nextIndex(int steps = 1);
    int previousIndex(int steps = 1);
    void next();
    void previous();
    void shuffle();
    void load(const QUrl &location, const QString &format = QString());
    bool save(const QUrl &location, const QString &format = QString());
    void addItem(const QUrl &source);
    Q_REVISION(1) void addItems(const QList<QUrl> &sources);
    bool insertItem(int index, const QUrl &source);
    Q_REVISION(1) bool insertItems(int index, const QList<QUrl> &sources);
    Q_REVISION(1) bool moveItem(int from, int to);
    bool removeItem(int index);
    Q_REVISION(1) bool removeItems(int start, int end);
    void clear();
 
Q_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);
 
private Q_SLOTS:
    void _q_mediaAboutToBeInserted(int start, int end);
    void _q_mediaInserted(int start, int end);
    void _q_mediaAboutToBeRemoved(int start, int end);
    void _q_mediaRemoved(int start, int end);
    void _q_mediaChanged(int start, int end);
    void _q_loadFailed();
 
private:
    Q_DISABLE_COPY(QQuickPlaylist)
 
    QMediaPlaylist *m_playlist;
    QString m_errorString;
    QMediaPlaylist::Error m_error;
};
 
QT_END_NAMESPACE
 
#endif