summaryrefslogtreecommitdiffstats
path: root/src/multimedia/qmediabackgroundplaybackcontrol.cpp
blob: d7cbd380a2f5be470555916e1034e84765956f53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmediabackgroundplaybackcontrol.h"
#include "qmediacontrol_p.h"

QT_BEGIN_NAMESPACE


/*!
    \class QMediaBackgroundPlaybackControl
    \inmodule QtMultimedia
    \ingroup multimedia
    \since 5.0


    \brief The QMediaBackgroundPlaybackControl class provides access to the background playback
    related control of a QMediaService.

    If a QMediaService can play media in background, it should implement QMediaBackgroundPlaybackControl.
    This control provides a means to set the \l {setContextId()}{contextId} for application,
    \l {acquire()}{acquire the resource for playback} and \l {release()} {release the playback resource}.

    The interface name of QMediaBackgroundPlaybackControl is \c com.nokia.Qt.QMediaBackgroundPlaybackControl/1.0 as
    defined in QMediaBackgroundPlaybackControl_iid.

    \sa QMediaService::requestControl(), QMediaPlayer
*/

/*!
    \macro QMediaBackgroundPlaybackControl_iid

    \c com.nokia.Qt.QMediaBackgroundPlaybackControl/1.0

    Defines the interface name of the QMediaBackgroundPlaybackControl class.

    \relates QMediaBackgroundPlaybackControl
*/

/*!
    Destroys a media background playback control.
*/
QMediaBackgroundPlaybackControl::~QMediaBackgroundPlaybackControl()
{
}

/*!
    Constructs a new media background playback control with the given \a parent.
*/
QMediaBackgroundPlaybackControl::QMediaBackgroundPlaybackControl(QObject *parent):
    QMediaControl(*new QMediaControlPrivate, parent)
{
}

/*!
    \fn QMediaBackgroundPlaybackControl::setContextId(const QString& contextId)

    Sets the contextId for the application, the last contextId will be released if previously set.
    \l {acquire()}{acquire method} will be automatically invoked after setting a new contextId.

    contextId is an unique string set by the application and is used by the background daemon to
    distinguish and manage different context for different application.

    \since 1.0
*/

/*!
    \fn QMediaBackgroundPlaybackControl::acquire()

    Try to acquire the playback resource for current application
    \since 1.0
*/

/*!
    \fn QMediaBackgroundPlaybackControl::release()

    Give up the playback resource if current applicaiton holds it.
    \since 1.0
*/

/*!
    \property QMediaBackgroundPlaybackControl::isAcquired()
    \brief indicate whether the background playback resource is granted or not

    It may take sometime for the backend to actually update this value before the first use.

    By default this property is false

    \since 1.0
*/

/*!
    \fn QMediaBackgroundPlaybackControl::acquired()

    Signals that the playback resource is acquired

    \since 1.0
*/

/*!
    \fn QMediaBackgroundPlaybackControl::lost()

    Signals that the playback resource is lost

    \since 1.0
*/

#include "moc_qmediabackgroundplaybackcontrol.cpp"
QT_END_NAMESPACE