aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media_api.tmpl
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/DocBook/media_api.tmpl')
-rw-r--r--Documentation/DocBook/media_api.tmpl121
1 files changed, 121 insertions, 0 deletions
diff --git a/Documentation/DocBook/media_api.tmpl b/Documentation/DocBook/media_api.tmpl
new file mode 100644
index 00000000000..4e8e8985cc1
--- /dev/null
+++ b/Documentation/DocBook/media_api.tmpl
@@ -0,0 +1,121 @@
1<?xml version="1.0"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4<!ENTITY % media-entities SYSTEM "./media-entities.tmpl"> %media-entities;
5<!ENTITY media-indices SYSTEM "./media-indices.tmpl">
6
7<!ENTITY eg "e.&nbsp;g.">
8<!ENTITY ie "i.&nbsp;e.">
9<!ENTITY fd "File descriptor returned by <link linkend='func-open'><function>open()</function></link>.">
10<!ENTITY i2c "I<superscript>2</superscript>C">
11<!ENTITY return-value "<title>Return Value</title><para>On success <returnvalue>0</returnvalue> is returned, on error <returnvalue>-1</returnvalue> and the <varname>errno</varname> variable is set appropriately. The generic error codes are described at the <link linkend='gen-errors'>Generic Error Codes</link> chapter.</para>">
12<!ENTITY return-value-dvb "<para>RETURN VALUE</para><para>On success <returnvalue>0</returnvalue> is returned, on error <returnvalue>-1</returnvalue> and the <varname>errno</varname> variable is set appropriately. The generic error codes are described at the <link linkend='gen-errors'>Generic Error Codes</link> chapter.</para>">
13<!ENTITY manvol "<manvolnum>2</manvolnum>">
14
15<!-- Table templates: structs, structs w/union, defines. -->
16<!ENTITY cs-str "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />">
17<!ENTITY cs-ustr "<colspec colname='c1' colwidth='1*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='1*' /><colspec colname='c4' colwidth='2*' /><spanspec spanname='hspan' namest='c1' nameend='c4' />">
18<!ENTITY cs-def "<colspec colname='c1' colwidth='3*' /><colspec colname='c2' colwidth='1*' /><colspec colname='c3' colwidth='4*' /><spanspec spanname='hspan' namest='c1' nameend='c3' />">
19
20<!-- Video for Linux mailing list address. -->
21<!ENTITY v4l-ml "<ulink url='http://www.linuxtv.org/lists.php'>http://www.linuxtv.org/lists.php</ulink>">
22
23<!-- LinuxTV v4l-dvb repository. -->
24<!ENTITY v4l-dvb "<ulink url='http://linuxtv.org/repo/'>http://linuxtv.org/repo/</ulink>">
25]>
26
27<book id="media_api">
28<bookinfo>
29<title>LINUX MEDIA INFRASTRUCTURE API</title>
30
31<copyright>
32 <year>2009-2011</year>
33 <holder>LinuxTV Developers</holder>
34</copyright>
35
36<legalnotice>
37
38<para>Permission is granted to copy, distribute and/or modify
39this document under the terms of the GNU Free Documentation License,
40Version 1.1 or any later version published by the Free Software
41Foundation. A copy of the license is included in the chapter entitled
42"GNU Free Documentation License"</para>
43</legalnotice>
44
45</bookinfo>
46
47<toc></toc> <!-- autogenerated -->
48
49<preface>
50 <title>Introduction</title>
51
52 <para>This document covers the Linux Kernel to Userspace API's used by
53 video and radio straming devices, including video cameras,
54 analog and digital TV receiver cards, AM/FM receiver cards,
55 streaming capture devices.</para>
56 <para>It is divided into three parts.</para>
57 <para>The first part covers radio, capture,
58 cameras and analog TV devices.</para>
59 <para>The second part covers the
60 API used for digital TV and Internet reception via one of the
61 several digital tv standards. While it is called as DVB API,
62 in fact it covers several different video standards including
63 DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated
64 to documment support also for DVB-S2, ISDB-T and ISDB-S.</para>
65 <para>The third part covers Remote Controller API</para>
66 <para>For additional information and for the latest development code,
67 see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para>
68 <para>For discussing improvements, reporting troubles, sending new drivers, etc, please mail to: <ulink url="http://vger.kernel.org/vger-lists.html#linux-media">Linux Media Mailing List (LMML).</ulink>.</para>
69
70</preface>
71
72<part id="v4l2spec">
73&sub-v4l2;
74</part>
75<part id="dvbapi">
76&sub-dvbapi;
77</part>
78<part id="v4ldvb_common">
79<partinfo>
80<authorgroup>
81<author>
82<firstname>Mauro</firstname>
83<surname>Chehab</surname>
84<othername role="mi">Carvalho</othername>
85<affiliation><address><email>mchehab@redhat.com</email></address></affiliation>
86<contrib>Initial version.</contrib>
87</author>
88</authorgroup>
89<copyright>
90 <year>2009-2011</year>
91 <holder>Mauro Carvalho Chehab</holder>
92</copyright>
93
94<revhistory>
95<!-- Put document revisions here, newest first. -->
96<revision>
97<revnumber>1.0.0</revnumber>
98<date>2009-09-06</date>
99<authorinitials>mcc</authorinitials>
100<revremark>Initial revision</revremark>
101</revision>
102</revhistory>
103</partinfo>
104
105<title>Remote Controller API</title>
106<chapter id="remote_controllers">
107&sub-remote_controllers;
108</chapter>
109</part>
110<part id="media_common">
111&sub-media-controller;
112</part>
113
114<chapter id="gen_errors">
115&sub-gen-errors;
116</chapter>
117
118
119&sub-fdl-appendix;
120
121</book>
generated by cgit v1.2.2 (git 2.25.0) at 2025-07-22 19:00:44 -0400