← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gnash/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/C/BackLash/sound.xml

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Sack
  • Date: 2008-10-14 16:06:54 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20081014160654-0anbl2mi098aee2h
Tags: 0.8.4-0ubuntu1
https://launchpad.net/bugs/84526
* LP: #84526 - Gnash menu launcher (/usr/share/applications/gnash.desktop
  file) doesn't start any application, also gnash isn't asociated with SWF
  mimetype; we dont show gnash in the .desktop launcher; we add
  NoDisplay=true, add a GenericName and Comment for the sake of
  completeness. Also we add the proper MimeType value, remove Encoding,
  don't use absolute paths for icon and exec and dont use specific icon
  file format suffix.
  - update debian/gnash.desktop

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/C/BackLash/sound.xml
1
 
<sect4 id="assound">
2
 
  <title>Sound ActionScript Class</title>
3
 
 
4
 
  <para>
5
 
    This class implements an Sound object.
6
 
  </para>
7
 
 
8
 
  <sect5 id="soundmethods">
9
 
    <title>The Methods of the Class</title>
10
 
    <para>
11
 
      <variablelist>
12
 
 
13
 
        <varlistentry>
14
 
          <term>attachSound()</term>
15
 
          <listitem>
16
 
            <para>
17
 
              Attach the specified sound.
18
 
            </para>
19
 
          </listitem>
20
 
        </varlistentry>
21
 
 
22
 
        <varlistentry>
23
 
          <term>getBytesLoaded()</term>
24
 
          <listitem>
25
 
            <para>
26
 
              Returns how many bytes of the sound have been loaded.
27
 
            </para>
28
 
          </listitem>
29
 
        </varlistentry>
30
 
 
31
 
        <varlistentry>
32
 
          <term>getBytesTotal()</term>
33
 
          <listitem>
34
 
            <para>
35
 
              Returns the total size of the sound.
36
 
            </para>
37
 
          </listitem>
38
 
        </varlistentry>
39
 
 
40
 
        <varlistentry>
41
 
          <term>getPan()</term>
42
 
          <listitem>
43
 
            <para>
44
 
              Returns the value of the previous call to setPan().
45
 
            </para>
46
 
          </listitem>
47
 
        </varlistentry>
48
 
 
49
 
        <varlistentry>
50
 
          <term>getTransform()</term>
51
 
          <listitem>
52
 
            <para>
53
 
              Returns the value of the previous call to setTransform().
54
 
            </para>
55
 
          </listitem>
56
 
        </varlistentry>
57
 
 
58
 
        <varlistentry>
59
 
          <term>getVolume()</term>
60
 
          <listitem>
61
 
            <para>
62
 
              Returns the value of the previous call to setVolumne().
63
 
            </para>
64
 
          </listitem>
65
 
        </varlistentry>
66
 
 
67
 
        <varlistentry>
68
 
          <term>loadSound()</term>
69
 
          <listitem>
70
 
            <para>
71
 
              Load an MP3 file.
72
 
            </para>
73
 
          </listitem>
74
 
        </varlistentry>
75
 
 
76
 
        <varlistentry>
77
 
          <term>setPan()</term>
78
 
          <listitem>
79
 
            <para>
80
 
              Change the balance.
81
 
            </para>
82
 
          </listitem>
83
 
        </varlistentry>
84
 
 
85
 
        <varlistentry>
86
 
          <term>setTransform()</term>
87
 
          <listitem>
88
 
            <para>
89
 
              Set the channel amounts for each speaker.
90
 
            </para>
91
 
          </listitem>
92
 
        </varlistentry>
93
 
 
94
 
        <varlistentry>
95
 
          <term>setVolume()</term>
96
 
          <listitem>
97
 
            <para>
98
 
              Set the volume for playing.
99
 
            </para>
100
 
          </listitem>
101
 
        </varlistentry>
102
 
 
103
 
        <varlistentry>
104
 
          <term>start()</term>
105
 
          <listitem>
106
 
            <para>
107
 
              Play the loaded sound.
108
 
            </para>
109
 
          </listitem>
110
 
        </varlistentry>
111
 
 
112
 
        <varlistentry>
113
 
          <term>stop()</term>
114
 
          <listitem>
115
 
            <para>
116
 
              Stop playing the sound.
117
 
            </para>
118
 
          </listitem>
119
 
        </varlistentry>
120
 
      </variablelist>
121
 
    </para>
122
 
  </sect5>
123
 
 
124
 
  <sect5 id="soundprops">
125
 
    <title>The Properties of the Sound Class</title>
126
 
    
127
 
    <para>
128
 
      <variablelist>
129
 
 
130
 
        <varlistentry>
131
 
          <term>duration</term>
132
 
          <listitem>
133
 
            <para>
134
 
              The length in milliseconds of the sound.
135
 
            </para>
136
 
          </listitem>
137
 
        </varlistentry>
138
 
 
139
 
        <varlistentry>
140
 
          <term>id3</term>
141
 
          <listitem>
142
 
            <para>
143
 
              Returns the ID3 tag of an MP3 file.
144
 
            </para>
145
 
          </listitem>
146
 
        </varlistentry>
147
 
 
148
 
        <varlistentry>
149
 
          <term>position</term>
150
 
          <listitem>
151
 
            <para>
152
 
              Returns the amount of time the sound has been playing.
153
 
            </para>
154
 
          </listitem>
155
 
        </varlistentry>
156
 
 
157
 
      </variablelist>
158
 
    </para>
159
 
  </sect5>
160
 
 
161
 
  <sect5 id="soundevents">
162
 
    <title>Event Handlers of the Sound Class</title>
163
 
    
164
 
    <para>
165
 
      <variablelist>
166
 
 
167
 
        <varlistentry>
168
 
          <term>onID3</term>
169
 
          <listitem>
170
 
            <para>
171
 
              Called when ID3 data is available.
172
 
            </para>
173
 
          </listitem>
174
 
        </varlistentry>
175
 
 
176
 
        <varlistentry>
177
 
          <term>onLoad</term>
178
 
          <listitem>
179
 
            <para>
180
 
              Called when a sound is loaded.
181
 
            </para>
182
 
          </listitem>
183
 
        </varlistentry>
184
 
 
185
 
        <varlistentry>
186
 
          <term>onSoundComplete</term>
187
 
          <listitem>
188
 
            <para>
189
 
              Called when a sound is done playing.
190
 
            </para>
191
 
          </listitem>
192
 
        </varlistentry>
193
 
 
194
 
      </variablelist>
195
 
    </para>
196
 
  </sect5>
197
 
 
198
 
  <sect5 id="soundconf">
199
 
    <title>Sound Class Conformance</title>
200
 
    
201
 
    <para>
202
 
      <informaltable frame="all">
203
 
        <?dbhtml table-width="75%" ?>
204
 
        <tgroup cols="2">
205
 
          <thead>
206
 
            <row>
207
 
              <entry valign="top">
208
 
                <para>Class Name</para>
209
 
              </entry>
210
 
              <entry valign="top">
211
 
                <para>Conformance</para>
212
 
              </entry>
213
 
            </row>
214
 
          </thead>
215
 
          <tbody>
216
 
            <row>
217
 
              <entry valign="top" align="left">
218
 
                <para>attachSound()</para>
219
 
              </entry>
220
 
              <entry valign="top" align="center">
221
 
                <para>
222
 
                  This method is implemented.
223
 
                </para>
224
 
              </entry>
225
 
            </row>
226
 
            <row>
227
 
              <entry valign="top" align="left">
228
 
                <para>getBytesLoaded()</para>
229
 
              </entry>
230
 
              <entry valign="top" align="center">
231
 
                <para>
232
 
                  This method has an unknown status.
233
 
                </para>
234
 
              </entry>
235
 
            </row>
236
 
            <row>
237
 
              <entry valign="top" align="left">
238
 
                <para>getBytesTotal()</para>
239
 
              </entry>
240
 
              <entry valign="top" align="center">
241
 
                <para>
242
 
                  This method has an unknown status.
243
 
                </para>
244
 
              </entry>
245
 
            </row>
246
 
            <row>
247
 
              <entry valign="top" align="left">
248
 
                <para>getPan()</para>
249
 
              </entry>
250
 
              <entry valign="top" align="center">
251
 
                <para>
252
 
                  This method is unimplemented.
253
 
                </para>
254
 
              </entry>
255
 
            </row>
256
 
            <row>
257
 
              <entry valign="top" align="left">
258
 
                <para>getTransform()</para>
259
 
              </entry>
260
 
              <entry valign="top" align="center">
261
 
                <para>
262
 
                  This method has an unknown status.
263
 
                </para>
264
 
              </entry>
265
 
            </row>
266
 
            <row>
267
 
              <entry valign="top" align="left">
268
 
                <para>getVolume()</para>
269
 
              </entry>
270
 
              <entry valign="top" align="center">
271
 
                <para>
272
 
                  This method is unimplemented.
273
 
                </para>
274
 
              </entry>
275
 
            </row>
276
 
            <row>
277
 
              <entry valign="top" align="left">
278
 
                <para>loadSound()</para>
279
 
              </entry>
280
 
              <entry valign="top" align="center">
281
 
                <para>
282
 
                  This method is unimplemented.
283
 
                </para>
284
 
              </entry>
285
 
            </row>
286
 
            <row>
287
 
              <entry valign="top" align="left">
288
 
                <para>setPan()</para>
289
 
              </entry>
290
 
              <entry valign="top" align="center">
291
 
                <para>
292
 
                  This method is unimplemented.
293
 
                </para>
294
 
              </entry>
295
 
            </row>
296
 
            <row>
297
 
              <entry valign="top" align="left">
298
 
                <para>setTransform()</para>
299
 
              </entry>
300
 
              <entry valign="top" align="center">
301
 
                <para>
302
 
                  This method is unimplemented.
303
 
                </para>
304
 
              </entry>
305
 
            </row>
306
 
            <row>
307
 
              <entry valign="top" align="left">
308
 
                <para>setVolume()</para>
309
 
              </entry>
310
 
              <entry valign="top" align="center">
311
 
                <para>
312
 
                  This method is unimplemented.
313
 
                </para>
314
 
              </entry>
315
 
            </row>
316
 
            <row>
317
 
              <entry valign="top" align="left">
318
 
                <para>start()</para>
319
 
              </entry>
320
 
              <entry valign="top" align="center">
321
 
                <para>
322
 
                  This method is implemented.
323
 
                </para>
324
 
              </entry>
325
 
            </row>
326
 
            <row>
327
 
              <entry valign="top" align="left">
328
 
                <para>stop()</para>
329
 
              </entry>
330
 
              <entry valign="top" align="center">
331
 
                <para>
332
 
                  This method is implemented.
333
 
                </para>
334
 
              </entry>
335
 
            </row>
336
 
            <row>
337
 
              <entry valign="top" align="left">
338
 
                <para>duration</para>
339
 
              </entry>
340
 
              <entry valign="top" align="center">
341
 
                <para>
342
 
                  This property has an unknown status.
343
 
                </para>
344
 
              </entry>
345
 
            </row>
346
 
            <row>
347
 
              <entry valign="top" align="left">
348
 
                <para>id3</para>
349
 
              </entry>
350
 
              <entry valign="top" align="center">
351
 
                <para>
352
 
                  This property is unimplemented.
353
 
                </para>
354
 
              </entry>
355
 
            </row>
356
 
            <row>
357
 
              <entry valign="top" align="left">
358
 
                <para>onID3</para>
359
 
              </entry>
360
 
              <entry valign="top" align="center">
361
 
                <para>
362
 
                  This event handler is unimplemented.
363
 
                </para>
364
 
              </entry>
365
 
            </row>
366
 
            <row>
367
 
              <entry valign="top" align="left">
368
 
                <para>onLoad</para>
369
 
              </entry>
370
 
              <entry valign="top" align="center">
371
 
                <para>
372
 
                  This event handler is unimplemented.
373
 
                </para>
374
 
              </entry>
375
 
            </row>
376
 
            <row>
377
 
              <entry valign="top" align="left">
378
 
                <para>onSoundComplete</para>
379
 
              </entry>
380
 
              <entry valign="top" align="center">
381
 
                <para>
382
 
                  This event handler is unimplemented.
383
 
                </para>
384
 
              </entry>
385
 
            </row>
386
 
            <row>
387
 
              <entry valign="top" align="left">
388
 
                <para>position</para>
389
 
              </entry>
390
 
              <entry valign="top" align="center">
391
 
                <para>
392
 
                  This property is implemented.
393
 
                </para>
394
 
              </entry>
395
 
            </row>
396
 
          </tbody>
397
 
        </tgroup>
398
 
      </informaltable>
399
 
    </para>
400
 
  </sect5>  
401
 
</sect4>