aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-08 09:55:57 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:56 -0400
commit34452432d125a846591523cf4999311c987c0bf4 (patch)
tree084af62663ad639494d74e779b5d9444eac795f7 /Documentation/DocBook
parent4cde378b3b7cfc65000deab14bfc1b314cb4075b (diff)
[media] DocBook/audio.xml: synchronize attribute changes
Some attributes suffered some changes since DVBv1. Sync them with the current API header files. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/dvb/audio.xml67
1 files changed, 35 insertions, 32 deletions
diff --git a/Documentation/DocBook/media/dvb/audio.xml b/Documentation/DocBook/media/dvb/audio.xml
index 60abf9a55d5c..b3d3895544e1 100644
--- a/Documentation/DocBook/media/dvb/audio.xml
+++ b/Documentation/DocBook/media/dvb/audio.xml
@@ -21,10 +21,10 @@ the following values, depending on whether we are replaying from an internal (de
21external (user write) source. 21external (user write) source.
22</para> 22</para>
23<programlisting> 23<programlisting>
24 typedef enum { 24typedef enum {
25 AUDIO_SOURCE_DEMUX, 25 AUDIO_SOURCE_DEMUX,
26 AUDIO_SOURCE_MEMORY 26 AUDIO_SOURCE_MEMORY
27 } audio_stream_source_t; 27} audio_stream_source_t;
28</programlisting> 28</programlisting>
29<para>AUDIO_SOURCE_DEMUX selects the demultiplexer (fed either by the frontend or the 29<para>AUDIO_SOURCE_DEMUX selects the demultiplexer (fed either by the frontend or the
30DVR device) as the source of the video stream. If AUDIO_SOURCE_MEMORY 30DVR device) as the source of the video stream. If AUDIO_SOURCE_MEMORY
@@ -39,11 +39,11 @@ call.
39state of audio playback. 39state of audio playback.
40</para> 40</para>
41<programlisting> 41<programlisting>
42 typedef enum { 42typedef enum {
43 AUDIO_STOPPED, 43 AUDIO_STOPPED,
44 AUDIO_PLAYING, 44 AUDIO_PLAYING,
45 AUDIO_PAUSED 45 AUDIO_PAUSED
46 } audio_play_state_t; 46} audio_play_state_t;
47</programlisting> 47</programlisting>
48 48
49</section> 49</section>
@@ -53,11 +53,13 @@ state of audio playback.
53following values. 53following values.
54</para> 54</para>
55<programlisting> 55<programlisting>
56 typedef enum { 56typedef enum {
57 AUDIO_STEREO, 57 AUDIO_STEREO,
58 AUDIO_MONO_LEFT, 58 AUDIO_MONO_LEFT,
59 AUDIO_MONO_RIGHT, 59 AUDIO_MONO_RIGHT,
60 } audio_channel_select_t; 60 AUDIO_MONO,
61 AUDIO_STEREO_SWAPPED
62} audio_channel_select_t;
61</programlisting> 63</programlisting>
62 64
63</section> 65</section>
@@ -67,14 +69,15 @@ following values.
67states of the playback operation. 69states of the playback operation.
68</para> 70</para>
69<programlisting> 71<programlisting>
70 typedef struct audio_status { 72typedef struct audio_status {
71 boolean AV_sync_state; 73 boolean AV_sync_state;
72 boolean mute_state; 74 boolean mute_state;
73 audio_play_state_t play_state; 75 audio_play_state_t play_state;
74 audio_stream_source_t stream_source; 76 audio_stream_source_t stream_source;
75 audio_channel_select_t channel_select; 77 audio_channel_select_t channel_select;
76 boolean bypass_mode; 78 boolean bypass_mode;
77 } audio_status_t; 79 audio_mixer_t mixer_state;
80} audio_status_t;
78</programlisting> 81</programlisting>
79 82
80</section> 83</section>
@@ -84,10 +87,10 @@ states of the playback operation.
84volume. 87volume.
85</para> 88</para>
86<programlisting> 89<programlisting>
87 typedef struct audio_mixer { 90typedef struct audio_mixer {
88 unsigned int volume_left; 91 unsigned int volume_left;
89 unsigned int volume_right; 92 unsigned int volume_right;
90 } audio_mixer_t; 93} audio_mixer_t;
91</programlisting> 94</programlisting>
92 95
93</section> 96</section>
@@ -114,12 +117,12 @@ bits set according to the hardwares capabilities.
114<para>The ioctl AUDIO_SET_KARAOKE uses the following format: 117<para>The ioctl AUDIO_SET_KARAOKE uses the following format:
115</para> 118</para>
116<programlisting> 119<programlisting>
117 typedef 120typedef
118 struct audio_karaoke{ 121struct audio_karaoke {
119 int vocal1; 122 int vocal1;
120 int vocal2; 123 int vocal2;
121 int melody; 124 int melody;
122 } audio_karaoke_t; 125} audio_karaoke_t;
123</programlisting> 126</programlisting>
124<para>If Vocal1 or Vocal2 are non-zero, they get mixed into left and right t at 70% each. If both, 127<para>If Vocal1 or Vocal2 are non-zero, they get mixed into left and right t at 70% each. If both,
125Vocal1 and Vocal2 are non-zero, Vocal1 gets mixed into the left channel and Vocal2 into the 128Vocal1 and Vocal2 are non-zero, Vocal1 gets mixed into the left channel and Vocal2 into the