blob: 09266feafe8adf17e51b7bd33be6286ab1e83057 (
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
|
/****************************************************************************
**
** 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 documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtivimedia-backends.html
\title QtIviMedia Backends
\ingroup qtivi_backend_groups
All backends supporting interfaces from QtIviMedia
\annotatedlist qtivimedia_backend
*/
/*!
\page qtivimedia-tuner-simulation-backend.html
\title QtIviMedia Tuner Simulation Backend
\ingroup qtivimedia_backend
\ingroup qtivi_backend
\brief Provides a static tuner simulation.
\section1 Supported interfaces
\list
\li \l{org.qt-project.qtivi.AmFmTuner/1.0}
\li \l{org.qt-project.qtivi.SearchAndBrowseModel/1.0}
\endlist
The backend will return a fixed set of radio stations on the FM band and no stations on the AM band.
For the SearchAndBrowseModel the following contenTypes are supported:
\list
\li \b station A list of all stations found.
\li \b presets A list for storing the users favorite stations.
\endlist
\note Both lists don't support filtering and sorting.
*/
/*!
\page qtivimedia-player-simulation-backend.html
\title QtIviMedia MediaPlayer Simulation Backend
\ingroup qtivimedia_backend
\ingroup qtivi_backend
\brief Provides a media player simulation using QtMultimedia.
\section1 Requirements
\list
\li QtMultimedia
\li taglib
\endlist
\section1 Supported interfaces
\list
\li \l{org.qt-project.qtivi.MediaPlayer/1.0}
\li \l{org.qt-project.qtivi.MediaIndexer/1.0}
\li \l{org.qt-project.qtivi.MediaDiscovery/1.0}
\li \l{org.qt-project.qtivi.SearchAndBrowseModel/1.0}
\endlist
The backend uses QtMultimedia to offer real media playback on various platforms.
The indexer will automatically start to index all \c .mp3 files in the media folder.
For the SearchAndBrowseModel the following contenTypes are supported:
\list
\li \b artist A list of all artists.
\li \b album A list of all albums.
\li \b track A list of all tracks.
\endlist
The model supports filtering and sorting, as well as navigating through the media library using
the following navigation paths:
\list
\li Artist -> Album -> Track
\li Album -> Track
\endlist
\note On systems where \c taglib is disabled, indexing of files doesn't work and because of that
the media database can't be created.
The MediaDiscoveryModel provides a simulation of USB thumb drives and can be configured using the the
\c QTIVIMEDIA_SIMULATOR_DEVICEFOLDER environment variable, which needs to be set to an absolute path.
Every sub-folder within that path is recognized as a new USB thumb drive.
Using the SearchAndBrowseModel on the discovered media devices, the \c file contentType can be used to
navigate through the device's folder structure.
Every new device discovered is automatically indexed and all \c .mp3 files can be retrieved using the
the SearchAndBrowseModel connected to the media player's service object to browse the library.
\section1 Configuration
This backend uses environment variables for its configuration. By default it will write its database
to the application's cache location. There is also a non persistent mode, where the indexed media
database is not saved, but recreated on every start of the app.
\table
\header
\li Name
\li Description
\row
\li QTIVIMEDIA_TEMPORARY_DATABASE
\li The database is written to a temporary location and deleted when the application is stopped.
\row
\li QTIVIMEDIA_SIMULATOR_DATABASE
\li A path to the media database which should be used.
\row
\li QTIVIMEDIA_SIMULATOR_LOCALMEDIAFOLDER
\li The local media directory (default: all media locations of the user - see also QStandardPaths)
\row
\li QTIVIMEDIA_SIMULATOR_DEVICEFOLDER
\li The path which will be used by the DiscoveryModel for discovering media devices.
(default: /home/<user>/usb-simulation)
\endtable
*/
|
