← Back to branch summary

~ubuntu-branches/ubuntu/karmic/ogmrip/karmic

« back to all changes in this revision

Viewing changes to docs/reference/ogmrip/xml/ogmrip-player.xml

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2009-09-21 19:49:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921194925-by5swrxkmnr07miv
Tags: 0.13.1-0.0ubuntu1
https://launchpad.net/bugs/434203
https://launchpad.net/bugs/434873
https://launchpad.net/bugs/424403
* Sync with Debian-multimedia.org (LP: #434203)
* Ubuntu remaining changes:
 - debian/rules:
  + Disable hal support by passing --disable-hal-support, to avoid crash when
    loading (LP: #434873).
 - debian/control:
  + Depends on mplayer-nogui | mplayer, ogmrip doesn't need the GUI of 
    mplayer (LP: #424403).
  + Recommends all ogmrip plugins and ogmrip-profiles.
  + Remove build-depends on libhal-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ogmrip/xml/ogmrip-player.xml
12
12
<refnamediv>
13
13
<refname>OGMRipPlayer</refname>
14
14
<refpurpose>Simple video player</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="ogmrip-OGMRipPlayer.synopsis" role="synopsis">
24
23
 
25
24
                    <link linkend="OGMRipPlayer">OGMRipPlayer</link>;
26
25
                    <link linkend="OGMRipPlayerClass">OGMRipPlayerClass</link>;
27
 
<link linkend="OGMRipPlayer">OGMRipPlayer</link>*       <link linkend="ogmrip-player-new">ogmrip_player_new</link>                   (void);
 
26
<link linkend="OGMRipPlayer">OGMRipPlayer</link> *      <link linkend="ogmrip-player-new">ogmrip_player_new</link>                   (void);
28
27
<link linkend="void">void</link>                <link linkend="ogmrip-player-set-title">ogmrip_player_set_title</link>             (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
29
28
                                                         <link linkend="OGMDvdTitle">OGMDvdTitle</link> *title);
30
29
<link linkend="void">void</link>                <link linkend="ogmrip-player-set-audio-file">ogmrip_player_set_audio_file</link>        (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
57
56
<para>
58
57
</para>
59
58
<para>
60
 
 
61
59
</para>
62
60
</refsect1>
63
61
 
65
63
<title role="details.title">Details</title>
66
64
<refsect2 id="OGMRipPlayer" role="struct">
67
65
<title>OGMRipPlayer</title>
68
 
<indexterm zone="OGMRipPlayer"><primary>OGMRipPlayer</primary></indexterm><programlisting>typedef struct {
 
66
<indexterm zone="OGMRipPlayer"><primary sortas="OGMRipPlayer">OGMRipPlayer</primary></indexterm><programlisting>typedef struct {
69
67
  GObject parent_instance;
70
68
 
71
69
  OGMRipPlayerPriv *priv;
72
70
} OGMRipPlayer;
73
71
</programlisting>
74
72
<para>
75
 
 
76
73
</para></refsect2>
77
74
<refsect2 id="OGMRipPlayerClass" role="struct">
78
75
<title>OGMRipPlayerClass</title>
79
 
<indexterm zone="OGMRipPlayerClass"><primary>OGMRipPlayerClass</primary></indexterm><programlisting>typedef struct {
 
76
<indexterm zone="OGMRipPlayerClass"><primary sortas="OGMRipPlayerClass">OGMRipPlayerClass</primary></indexterm><programlisting>typedef struct {
80
77
  GObjectClass parent_class;
81
78
 
82
79
  void (* play) (OGMRipPlayer *player);
84
81
} OGMRipPlayerClass;
85
82
</programlisting>
86
83
<para>
87
 
 
88
84
</para></refsect2>
89
85
<refsect2 id="ogmrip-player-new" role="function">
90
86
<title>ogmrip_player_new ()</title>
91
 
<indexterm zone="ogmrip-player-new"><primary>ogmrip_player_new</primary></indexterm><programlisting><link linkend="OGMRipPlayer">OGMRipPlayer</link>*       ogmrip_player_new                   (void);</programlisting>
 
87
<indexterm zone="ogmrip-player-new"><primary sortas="ogmrip_player_new">ogmrip_player_new</primary></indexterm><programlisting><link linkend="OGMRipPlayer">OGMRipPlayer</link> *      ogmrip_player_new                   (void);</programlisting>
92
88
<para>
93
89
Creates a new <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link></para>
94
90
<para>
95
 
 
96
91
</para><variablelist role="params">
97
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
 
92
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
98
93
</simpara></listitem></varlistentry>
99
94
</variablelist></refsect2>
100
95
<refsect2 id="ogmrip-player-set-title" role="function">
101
96
<title>ogmrip_player_set_title ()</title>
102
 
<indexterm zone="ogmrip-player-set-title"><primary>ogmrip_player_set_title</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_title             (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
97
<indexterm zone="ogmrip-player-set-title"><primary sortas="ogmrip_player_set_title">ogmrip_player_set_title</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_title             (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
103
98
                                                         <link linkend="OGMDvdTitle">OGMDvdTitle</link> *title);</programlisting>
104
99
<para>
105
100
Sets the DVD title to play</para>
106
101
<para>
107
 
 
108
102
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
103
<varlistentry><term><parameter>player</parameter>&#160;:</term>
110
104
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
111
105
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
106
<varlistentry><term><parameter>title</parameter>&#160;:</term>
113
107
<listitem><simpara> an <link linkend="OGMDvdTitle"><type>OGMDvdTitle</type></link>
114
108
</simpara></listitem></varlistentry>
115
109
</variablelist></refsect2>
116
110
<refsect2 id="ogmrip-player-set-audio-file" role="function">
117
111
<title>ogmrip_player_set_audio_file ()</title>
118
 
<indexterm zone="ogmrip-player-set-audio-file"><primary>ogmrip_player_set_audio_file</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_audio_file        (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
112
<indexterm zone="ogmrip-player-set-audio-file"><primary sortas="ogmrip_player_set_audio_file">ogmrip_player_set_audio_file</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_audio_file        (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
119
113
                                                         <link linkend="OGMRipFile">OGMRipFile</link> *file);</programlisting>
120
114
<para>
121
115
Sets the audio file to play</para>
122
116
<para>
123
 
 
124
117
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>player</parameter>&#160;:</term>
126
119
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
127
120
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>file</parameter>&nbsp;:</term>
 
121
<varlistentry><term><parameter>file</parameter>&#160;:</term>
129
122
<listitem><simpara> an <link linkend="OGMRipFile"><type>OGMRipFile</type></link>
130
123
</simpara></listitem></varlistentry>
131
124
</variablelist></refsect2>
132
125
<refsect2 id="ogmrip-player-set-audio-stream" role="function">
133
126
<title>ogmrip_player_set_audio_stream ()</title>
134
 
<indexterm zone="ogmrip-player-set-audio-stream"><primary>ogmrip_player_set_audio_stream</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_audio_stream      (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
127
<indexterm zone="ogmrip-player-set-audio-stream"><primary sortas="ogmrip_player_set_audio_stream">ogmrip_player_set_audio_stream</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_audio_stream      (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
135
128
                                                         <link linkend="OGMDvdAudioStream">OGMDvdAudioStream</link> *stream);</programlisting>
136
129
<para>
137
130
Sets the audio stream to play</para>
138
131
<para>
139
 
 
140
132
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
133
<varlistentry><term><parameter>player</parameter>&#160;:</term>
142
134
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
143
135
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
136
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
145
137
<listitem><simpara> an <link linkend="OGMDvdAudioStream"><type>OGMDvdAudioStream</type></link>
146
138
</simpara></listitem></varlistentry>
147
139
</variablelist></refsect2>
148
140
<refsect2 id="ogmrip-player-set-subp-file" role="function">
149
141
<title>ogmrip_player_set_subp_file ()</title>
150
 
<indexterm zone="ogmrip-player-set-subp-file"><primary>ogmrip_player_set_subp_file</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_subp_file         (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
142
<indexterm zone="ogmrip-player-set-subp-file"><primary sortas="ogmrip_player_set_subp_file">ogmrip_player_set_subp_file</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_subp_file         (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
151
143
                                                         <link linkend="OGMRipFile">OGMRipFile</link> *file);</programlisting>
152
144
<para>
153
145
Sets the subtitle file to play</para>
154
146
<para>
155
 
 
156
147
</para><variablelist role="params">
157
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
148
<varlistentry><term><parameter>player</parameter>&#160;:</term>
158
149
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
159
150
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><parameter>file</parameter>&nbsp;:</term>
 
151
<varlistentry><term><parameter>file</parameter>&#160;:</term>
161
152
<listitem><simpara> an <link linkend="OGMRipFile"><type>OGMRipFile</type></link>
162
153
</simpara></listitem></varlistentry>
163
154
</variablelist></refsect2>
164
155
<refsect2 id="ogmrip-player-set-subp-stream" role="function">
165
156
<title>ogmrip_player_set_subp_stream ()</title>
166
 
<indexterm zone="ogmrip-player-set-subp-stream"><primary>ogmrip_player_set_subp_stream</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_subp_stream       (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
157
<indexterm zone="ogmrip-player-set-subp-stream"><primary sortas="ogmrip_player_set_subp_stream">ogmrip_player_set_subp_stream</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_subp_stream       (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
167
158
                                                         <link linkend="OGMDvdSubpStream">OGMDvdSubpStream</link> *stream);</programlisting>
168
159
<para>
169
160
Sets the subtitle stream to play</para>
170
161
<para>
171
 
 
172
162
</para><variablelist role="params">
173
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
163
<varlistentry><term><parameter>player</parameter>&#160;:</term>
174
164
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
175
165
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
166
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
177
167
<listitem><simpara> an <link linkend="OGMDvdSubpStream"><type>OGMDvdSubpStream</type></link>
178
168
</simpara></listitem></varlistentry>
179
169
</variablelist></refsect2>
180
170
<refsect2 id="ogmrip-player-set-chapters" role="function">
181
171
<title>ogmrip_player_set_chapters ()</title>
182
 
<indexterm zone="ogmrip-player-set-chapters"><primary>ogmrip_player_set_chapters</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_chapters          (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
172
<indexterm zone="ogmrip-player-set-chapters"><primary sortas="ogmrip_player_set_chapters">ogmrip_player_set_chapters</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_set_chapters          (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
183
173
                                                         <link linkend="guint">guint</link> start,
184
174
                                                         <link linkend="gint">gint</link> end);</programlisting>
185
175
<para>
186
176
Sets the chapters to play</para>
187
177
<para>
188
 
 
189
178
</para><variablelist role="params">
190
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
179
<varlistentry><term><parameter>player</parameter>&#160;:</term>
191
180
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
192
181
</simpara></listitem></varlistentry>
193
 
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
 
182
<varlistentry><term><parameter>start</parameter>&#160;:</term>
194
183
<listitem><simpara> the chapter to start playing at
195
184
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
 
185
<varlistentry><term><parameter>end</parameter>&#160;:</term>
197
186
<listitem><simpara> the chapter to stop playing at, or -1
198
187
</simpara></listitem></varlistentry>
199
188
</variablelist></refsect2>
200
189
<refsect2 id="ogmrip-player-play" role="function">
201
190
<title>ogmrip_player_play ()</title>
202
 
<indexterm zone="ogmrip-player-play"><primary>ogmrip_player_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmrip_player_play                  (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
 
191
<indexterm zone="ogmrip-player-play"><primary sortas="ogmrip_player_play">ogmrip_player_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmrip_player_play                  (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player,
203
192
                                                         <link linkend="GError">GError</link> **error);</programlisting>
204
193
<para>
205
194
Plays the selected title, streams and chapters</para>
206
195
<para>
207
 
 
208
196
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
197
<varlistentry><term><parameter>player</parameter>&#160;:</term>
210
198
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
211
199
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
200
<varlistentry><term><parameter>error</parameter>&#160;:</term>
213
201
<listitem><simpara> return location for error
214
202
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if an error was set
 
203
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if an error was set
216
204
</simpara></listitem></varlistentry>
217
205
</variablelist></refsect2>
218
206
<refsect2 id="ogmrip-player-stop" role="function">
219
207
<title>ogmrip_player_stop ()</title>
220
 
<indexterm zone="ogmrip-player-stop"><primary>ogmrip_player_stop</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_stop                  (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player);</programlisting>
 
208
<indexterm zone="ogmrip-player-stop"><primary sortas="ogmrip_player_stop">ogmrip_player_stop</primary></indexterm><programlisting><link linkend="void">void</link>                ogmrip_player_stop                  (<link linkend="OGMRipPlayer">OGMRipPlayer</link> *player);</programlisting>
221
209
<para>
222
210
Stops playing the title</para>
223
211
<para>
224
 
 
225
212
</para><variablelist role="params">
226
 
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
213
<varlistentry><term><parameter>player</parameter>&#160;:</term>
227
214
<listitem><simpara> an <link linkend="OGMRipPlayer"><type>OGMRipPlayer</type></link>
228
215
</simpara></listitem></varlistentry>
229
216
</variablelist></refsect2>