1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40
41#include "qmediaplaylistsourcecontrol_p.h"
42#include "qmediacontrol_p.h"
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 \class QMediaPlaylistSourceControl
48 \internal
49
50 \inmodule QtMultimedia
51
52
53 \ingroup multimedia_control
54
55
56 \brief The QMediaPlaylistSourceControl class provides access to the playlist playback
57 functionality of a QMediaService.
58
59 This control allows QMediaPlaylist to be passed directly to the service
60 instead of playing media sources one by one. This control should be
61 implemented if backend benefits from knowing the next media source to be
62 played, for example for preloading, cross fading or gap-less playback.
63
64 If QMediaPlaylistSourceControl is provided, the backend must listen for
65 current playlist item changes to load corresponding media source and
66 advance the playlist with QMediaPlaylist::next() when playback of the
67 current media is finished.
68
69 The interface name of QMediaPlaylistSourceControl is \c org.qt-project.qt.mediaplaylistsourcecontrol/5.0 as
70 defined in QMediaPlaylistSourceControl_iid.
71
72 \sa QMediaService::requestControl(), QMediaPlayer
73*/
74
75/*!
76 \macro QMediaPlaylistSourceControl_iid
77
78 \c org.qt-project.qt.mediaplaylistsourcecontrol/5.0
79
80 Defines the interface name of the QMediaPlaylistSourceControl class.
81
82 \relates QMediaPlaylistSourceControl
83*/
84
85/*!
86 Create a new playlist source control object with the given \a parent.
87*/
88QMediaPlaylistSourceControl::QMediaPlaylistSourceControl(QObject *parent):
89 QMediaControl(*new QMediaControlPrivate, parent)
90{
91}
92
93/*!
94 Destroys the playlist control.
95*/
96QMediaPlaylistSourceControl::~QMediaPlaylistSourceControl()
97{
98}
99
100
101/*!
102 \fn QMediaPlaylistSourceControl::playlist() const
103
104 Returns the current playlist.
105 Should return a null pointer if no playlist is assigned.
106*/
107
108/*!
109 \fn QMediaPlaylistSourceControl::setPlaylist(QMediaPlaylist *playlist)
110
111 Set the playlist of this media player to \a playlist.
112 If a null pointer is passed, the playlist source should be disabled.
113
114 The current media should be replaced with the current item of the media playlist.
115*/
116
117
118/*!
119 \fn QMediaPlaylistSourceControl::playlistChanged(QMediaPlaylist* playlist)
120
121 Signal emitted when the playlist has changed to \a playlist.
122*/
123
124#include "moc_qmediaplaylistsourcecontrol_p.cpp"
125QT_END_NAMESPACE
126
127