Commit | Line | Data |
---|---|---|
8e080c2e | 1 | <?xml version="1.0"?> |
8bfd4a68 AH |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.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>"> | |
f57fa210 | 25 | <!ENTITY dash-ent-8 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> |
b01189b8 | 26 | <!ENTITY dash-ent-10 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> |
f57fa210 LP |
27 | <!ENTITY dash-ent-12 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> |
28 | <!ENTITY dash-ent-14 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> | |
7b88fc08 | 29 | <!ENTITY dash-ent-16 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> |
f57fa210 LP |
30 | <!ENTITY dash-ent-20 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> |
31 | <!ENTITY dash-ent-22 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> | |
32 | <!ENTITY dash-ent-24 "<entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry><entry>-</entry>"> | |
8e080c2e MCC |
33 | ]> |
34 | ||
35 | <book id="media_api"> | |
36 | <bookinfo> | |
90f745ce MCC |
37 | <title>LINUX MEDIA INFRASTRUCTURE API</title> |
38 | ||
39 | <copyright> | |
40 | <year>2009-2014</year> | |
41 | <holder>LinuxTV Developers</holder> | |
42 | </copyright> | |
43 | ||
44 | <legalnotice> | |
45 | <para>Permission is granted to copy, distribute and/or modify | |
46 | this document under the terms of the GNU Free Documentation License, | |
47 | Version 1.1 or any later version published by the Free Software | |
48 | Foundation. A copy of the license is included in the chapter entitled | |
49 | "GNU Free Documentation License"</para> | |
50 | </legalnotice> | |
8e080c2e MCC |
51 | </bookinfo> |
52 | ||
53 | <toc></toc> <!-- autogenerated --> | |
54 | ||
55 | <preface> | |
56 | <title>Introduction</title> | |
57 | ||
58 | <para>This document covers the Linux Kernel to Userspace API's used by | |
1b962087 | 59 | video and radio streaming devices, including video cameras, |
8e080c2e | 60 | analog and digital TV receiver cards, AM/FM receiver cards, |
1b962087 HV |
61 | streaming capture and output devices, codec devices and remote |
62 | controllers.</para> | |
571d19c3 | 63 | <para>It is divided into four parts.</para> |
1b962087 HV |
64 | <para>The first part covers radio, video capture and output, |
65 | cameras, analog TV devices and codecs.</para> | |
8e080c2e MCC |
66 | <para>The second part covers the |
67 | API used for digital TV and Internet reception via one of the | |
68 | several digital tv standards. While it is called as DVB API, | |
69 | in fact it covers several different video standards including | |
70 | DVB-T, DVB-S, DVB-C and ATSC. The API is currently being updated | |
0ba4f6e4 | 71 | to document support also for DVB-S2, ISDB-T and ISDB-S.</para> |
571d19c3 HV |
72 | <para>The third part covers the Remote Controller API.</para> |
73 | <para>The fourth part covers the Media Controller API.</para> | |
8e080c2e MCC |
74 | <para>For additional information and for the latest development code, |
75 | see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para> | |
76 | <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> | |
8e080c2e MCC |
77 | </preface> |
78 | ||
90f745ce MCC |
79 | <part id="v4l2spec">&sub-v4l2;</part> |
80 | <part id="dvbapi">&sub-dvbapi;</part> | |
81 | <part id="remotes">&sub-remote_controllers;</part> | |
82 | <part id="media_common">&sub-media-controller;</part> | |
6d172492 | 83 | |
90f745ce | 84 | <chapter id="gen_errors">&sub-gen-errors;</chapter> |
6d172492 | 85 | |
8e080c2e MCC |
86 | &sub-fdl-appendix; |
87 | ||
88 | </book> |