Commit | Line | Data |
---|---|---|
8e080c2e MCC |
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" [ | |
d80bd70f MCC |
4 | <!ENTITY % media-entities SYSTEM "./media-entities.tmpl"> %media-entities; |
5 | <!ENTITY media-indices SYSTEM "./media-indices.tmpl"> | |
8e080c2e MCC |
6 | |
7 | <!ENTITY eg "e. g."> | |
8 | <!ENTITY ie "i. e."> | |
9 | <!ENTITY fd "File descriptor returned by <link linkend='func-open'><function>open()</function></link>."> | |
10 | <!ENTITY i2c "I<superscript>2</superscript>C"> | |
6d172492 | 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>"> |
3de530f8 | 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>"> |
8e080c2e MCC |
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> | |
571d19c3 | 32 | <year>2009-2012</year> |
8e080c2e MCC |
33 | <holder>LinuxTV Developers</holder> |
34 | </copyright> | |
35 | ||
36 | <legalnotice> | |
37 | ||
38 | <para>Permission is granted to copy, distribute and/or modify | |
39 | this document under the terms of the GNU Free Documentation License, | |
40 | Version 1.1 or any later version published by the Free Software | |
41 | Foundation. 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> | |
571d19c3 | 56 | <para>It is divided into four parts.</para> |
8e080c2e MCC |
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> | |
571d19c3 HV |
65 | <para>The third part covers the Remote Controller API.</para> |
66 | <para>The fourth part covers the Media Controller API.</para> | |
8e080c2e MCC |
67 | <para>For additional information and for the latest development code, |
68 | see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para> | |
69 | <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> | |
70 | ||
71 | </preface> | |
72 | ||
73 | <part id="v4l2spec"> | |
74 | &sub-v4l2; | |
75 | </part> | |
76 | <part id="dvbapi"> | |
77 | &sub-dvbapi; | |
78 | </part> | |
79 | <part id="v4ldvb_common"> | |
80 | <partinfo> | |
81 | <authorgroup> | |
82 | <author> | |
83 | <firstname>Mauro</firstname> | |
84 | <surname>Chehab</surname> | |
85 | <othername role="mi">Carvalho</othername> | |
86 | <affiliation><address><email>mchehab@redhat.com</email></address></affiliation> | |
87 | <contrib>Initial version.</contrib> | |
88 | </author> | |
89 | </authorgroup> | |
90 | <copyright> | |
571d19c3 | 91 | <year>2009-2012</year> |
8e080c2e MCC |
92 | <holder>Mauro Carvalho Chehab</holder> |
93 | </copyright> | |
94 | ||
95 | <revhistory> | |
96 | <!-- Put document revisions here, newest first. --> | |
97 | <revision> | |
98 | <revnumber>1.0.0</revnumber> | |
99 | <date>2009-09-06</date> | |
100 | <authorinitials>mcc</authorinitials> | |
101 | <revremark>Initial revision</revremark> | |
102 | </revision> | |
103 | </revhistory> | |
104 | </partinfo> | |
105 | ||
fab81259 | 106 | <title>Remote Controller API</title> |
8e080c2e MCC |
107 | <chapter id="remote_controllers"> |
108 | &sub-remote_controllers; | |
109 | </chapter> | |
110 | </part> | |
176fb0d1 LP |
111 | <part id="media_common"> |
112 | &sub-media-controller; | |
113 | </part> | |
8e080c2e | 114 | |
6d172492 MCC |
115 | <chapter id="gen_errors"> |
116 | &sub-gen-errors; | |
117 | </chapter> | |
118 | ||
119 | ||
8e080c2e MCC |
120 | &sub-fdl-appendix; |
121 | ||
122 | </book> |