3
@mainpage mediascanner Reference Manual
5
@section description Description
7
The <a href="http://www.ubuntu.com/devices/tv">Ubuntu TV</a> media scanner
8
maintains a list of media files available to the user along with meta-data
9
for those files. These may be accessed from a local file system which is
10
physically attached to the device or via network mounts or sharing protocols.
12
This mediascanner API provides access to this information and can be used
13
to schedule scans and to control the scanning process.
15
Most applications will access the mediascanner via the
16
<a href="https://live.gnome.org/Grilo">Grilo</a> API, via
17
the @ref grilo-plugin "grl-mediascanner Grilo plugin", which uses this
20
See mediascanner::MediaIndex and mediascanner::WritableMediaIndex.
22
See the @ref architecture "Architecture" page for more details.
24
@section control Control
26
Most users will configure the mediascanner via the control panel, which uses
27
the mediascanner's @ref gsettings-schema "DConf settings".
29
@section basics Basic Usage
31
Include, for instance, the mediaindex header:
33
#include <mediascanner/mediaindex.h>
35
(You may include other headers, such as @c mediascanner/writeablemediaindex.h instead.)
37
If your source file is @c program.cc, you can compile it with:
39
g++ program.cc -o program `pkg-config --cflags --libs mediascanner-1.0`
42
Alternatively, if using autoconf, use the following in @c configure.ac:
44
PKG_CHECK_MODULES([MEDIASCANNER], [mediascanner-1.0])
46
Then use the generated @c MEDIASCANNER_CFLAGS and @c MEDIASCANNER_LIBS variables in the
47
project @c Makefile.am files. For example:
49
program_CPPFLAGS = $(MEDIASCANNER_CFLAGS)
50
program_LDADD = $(MEDIASCANNER_LIBS)
added
removed
docs/overview.dox
