File: modules_cpp.dox

package info (click to toggle)
kodi 2%3A21.2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 143,076 kB
  • sloc: cpp: 694,471; xml: 52,618; ansic: 38,300; python: 7,161; sh: 4,289; javascript: 2,325; makefile: 1,791; perl: 969; java: 513; cs: 390; objc: 340
file content (165 lines) | stat: -rw-r--r-- 5,986 bytes parent folder | download | duplicates (4)
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*!

\defgroup cpp C++
\image html logo-cpp.png
\brief \htmlonly
      <h3><span  style="text-decoration: underline;"><span  style="font-style: italic;"><span
               style="color: rgb(102, 102, 102);">C++ Binary Add-On Development</span></span></span></h3>
       \endhtmlonly

Kodi allows the use of **C++** addons to expand their possibilities. This gives you
many options to expand it quickly and easily with new features.

Here is a table of the types currently possible:
\table_start
  \table_h3{ Type, Class, Description }
  \table_row3{   <b>Audio decoder</b>,
                 @ref cpp_kodi_addon_audiodecoder "kodi::addon::CInstanceAudioDecoder",
    For audio decoders as binary add-ons. This class implements a way to handle
    special types of audio files.
  }
  \table_row3{   <b>Audio encoder</b>,
                 @ref cpp_kodi_addon_audioencoder "kodi::addon::CInstanceAudioEncoder",
    To convert audio data\, such as a CD\, to a new format and create files for this.
  }
  \table_row3{   <b>Game engine</b>,
                 @ref cpp_kodi_addon_game "kodi::addon::CInstanceGame",
    This is to provide support for games in the system.
  }
  \table_row3{   <b>Image decoder</b>,
                 @ref cpp_kodi_addon_imagedecoder "kodi::addon::CInstanceImageDecoder",
    This instance type is used to allow Kodi various additional image format types.
  }
  \table_row3{   <b>Inputstream</b>,
                 @ref cpp_kodi_addon_inputstream "kodi::addon::CInstanceInputStream",
    To process special video and/or audio streams. This allows addons to support newer species in Kodi.
  }
  \table_row3{   <b>Peripheral</b>,
                 @ref cpp_kodi_addon_peripheral "kodi::addon::CInstancePeripheral",
    Made to have Kodi controllable with new and different ways\, such as Joystick.
  }
  \table_row3{   <b>Screensaver</b>,
                 @ref cpp_kodi_addon_screensaver "kodi::addon::CInstanceScreensaver",
    A screensaver is a Kodi addon that fills the screen with moving images or
    patterns when the computer is not in use.
  }
  \table_row3{   <b>PVR (TV / radio handling)</b>,
                 @ref cpp_kodi_addon_pvr "kodi::addon::CInstancePVRClient",
    Used to provide Kodi with various sources for TV and radio streams.
  }
  \table_row3{   <b>VFS (Virtual filesystem support)</b>,
                 @ref cpp_kodi_addon_vfs "kodi::addon::CInstanceVFS",
    This instance type is used to allow Kodi various additional file system types.
  }
  \table_row3{   <b>Video codec</b>,
                 @ref cpp_kodi_addon_videocodec "kodi::addon::CInstanceVideoCodec",
    Used to decode special video formats and make them usable for playback.
    @note This can only be used in connection with @ref cpp_kodi_addon_inputstream "kodi::addon::CInstanceInputStream".
  }
  \table_row3{   <b>Visualization</b>,
                 @ref cpp_kodi_addon_visualization "kodi::addon::CInstanceVisualization",
    Music visualization is a feature in Kodi that generates animated imagery based on a piece of music.
  }
\table_end
*/
/*!
\defgroup cpp_cmake CMake addon creation structure
\ingroup cpp
\brief **CMake help macros to create addon for Kodi**
*/
/*!
\defgroup cpp_kodi Interface - kodi
\ingroup cpp
\brief **General addon interface functions**
*/
  /*!
  \defgroup cpp_kodi_Defs Definitions, structures and enumerators
  \ingroup cpp_kodi
  @brief **General definition values**
  */
/*!
\defgroup cpp_kodi_addon Interface - kodi::addon
\ingroup cpp
\brief **Addon type interface functions and classes**
*/
  /*!
  \defgroup cpp_kodi_addon_addonbase class CAddonBase
  \ingroup cpp_kodi_addon
  */
    /*!
    \defgroup cpp_kodi_addon_addonbase_Defs Definitions, structures and enumerators
    \ingroup cpp_kodi_addon_addonbase
    @brief **General definition values**
    */
  /*!
  \defgroup cpp_kodi_addon_instances Addon type instances
  \brief **Group of possible processing instances which can be made available by an add-on**\n
  Kodi enables numerous different ways in which the necessary documentation is included in this group.
  \ingroup cpp_kodi_addon
  */
    /*!
    \defgroup cpp_kodi_addon_audiodecoder Audio Decoder
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_audioencoder Audio Encoder
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_game Game
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_imagedecoder Image Decoder
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_inputstream Inputstream
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_peripheral Peripheral
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_pvr PVR
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_screensaver Screensaver
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_vfs VFS
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_videocodec Video Codec
    \ingroup cpp_kodi_addon_instances
    */
    /*!
    \defgroup cpp_kodi_addon_visualization Visualization
    \ingroup cpp_kodi_addon_instances
    */
/*!
\defgroup cpp_kodi_gui Interface - kodi::gui
\ingroup cpp
\brief **Graphical functions for Windows and Dialogs to show**\n
Offers classes and functions that manipulate the Graphical User Interface
through windows, dialogs, and various control widgets.
*/
/*!
\defgroup cpp_kodi_platform Interface - kodi::platform
\ingroup cpp
\brief **Platform specific functions**\n
This group contains OS platform specific functions with which Kodi is accessed.

@note Its header and its classes and functions are only available in the
associated OS and are not available outside.
*/
/*!
\defgroup cpp_kodi_tools Interface - kodi::tools
\ingroup cpp
\brief **Helper tools and functions**\n
This group includes things that only work indirectly with Kodi.
*/