blob: 46c412a2c3aa8f4c82f635bebaf26c51b1e0c6f2 (
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
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qivimediaindexercontrolbackendinterface.h"
QT_BEGIN_NAMESPACE
/*!
\class QIviMediaIndexerControlBackendInterface
\inmodule QtIviMedia
\ingroup backends
\inherits QObject
\keyword org.qt-project.qtivi.MediaIndexer/1.0
\brief The QIviMediaIndexerControlBackendInterface defines the interface for backends to the
QIviMediaIndexerControl feature class.
The QIviMediaIndexerControlBackendInterface is the interface used by \l QIviMediaIndexerControl
The interface is discovered by a \l QIviMediaIndexerControl object, which connects to it and sets it up.
<example of a fully featured backend>
*/
/*!
Constructs a backend interface.
The \a parent is sent to the QObject constructor.
*/
QIviMediaIndexerControlBackendInterface::QIviMediaIndexerControlBackendInterface(QObject *parent)
: QIviFeatureInterface(parent)
{
}
/*!
\fn QIviMediaIndexerControlBackendInterface::initialize()
Initializes the backend. This function is called after a feature connected to the backend.
It is expected that this function will use the stateChanged and the progressChanged signals to inform the feature about the
current state of the indexing.
\sa stateChanged() progressChanged()
*/
/*!
\fn QIviMediaIndexerControlBackendInterface::pause()
Pauses the currently ongoing indexing. If currently no indexing is ongoing this call should not perform any actions.
\sa resume()
*/
/*!
\fn QIviMediaIndexerControlBackendInterface::resume()
Resumes the previously paused indexing. If there is nothing to resume this call should not perform any actions.
\sa pause()
*/
/*!
\fn void QIviMediaIndexerControlBackendInterface::progressChanged(qreal progress)
This signal is emitted when indexing is currently ongoing and the progress of the operation changed.
The \a progress argument passes the current progress between \e 0 and \e 1.
*/
/*!
\fn void QIviMediaIndexerControlBackendInterface::stateChanged(QIviMediaIndexerControl::State state)
This signal is emitted whenever the indexing state changed. The \a state argument holds the new state
of the indexer.
*/
QT_END_NAMESPACE
|
