~ubuntu-branches/debian/squeeze/nas/squeeze

« back to all changes in this revision

Viewing changes to doc/html/AuSoundPlayFromData.3.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve McIntyre
  • Date: 2008-10-08 01:18:19 UTC
  • mfrom: (4.1.7 intrepid)
  • Revision ID: james.westby@ubuntu.com-20081008011819-wmr4h2w0298k8t7z
Tags: 1.9.1-5
* Fix pending l10n issues. Debconf translations:
* Swedish. Closes: #491766 (thanks to brother@bsnet.se)
* Arabic. Closes: #500437 (thanks to Ossama Khayat)
* Basque. Closes: #500533 (thanks to Piarres Beobide)
* Brazilian Portuguese. Closes: #500973 (thanks to Felipe
  Augusto van de Wiel)
* Many thanks again to Christian Perrier for his i18n efforts,
  co-ordinating the above.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
<!--
 
3
  $NCDId: @(#)AuSPFD.man,v 1.2 1995/05/23 23:52:59 greg Exp $
 
4
   copyright 1994 Steven King
 
5
   
 
6
   portions are
 
7
   * Copyright 1993 Network Computing Devices, Inc.
 
8
   *
 
9
   * Permission to use, copy, modify, distribute, and sell this software and its
 
10
   * documentation for any purpose is hereby granted without fee, provided that
 
11
   * the above copyright notice appear in all copies and that both that
 
12
   * copyright notice and this permission notice appear in supporting
 
13
   * documentation, and that the name Network Computing Devices, Inc. not be
 
14
   * used in advertising or publicity pertaining to distribution of this
 
15
   * software without specific, written prior permission.
 
16
   * 
 
17
   * THIS SOFTWARE IS PROVIDED 'AS-IS'.  NETWORK COMPUTING DEVICES, INC.,
 
18
   * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
 
19
   * LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 
20
   * PARTICULAR PURPOSE, OR NONINFRINGEMENT.  IN NO EVENT SHALL NETWORK
 
21
   * COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
 
22
   * SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
 
23
   * OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
 
24
   * WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
 
25
   * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
26
   
 
27
   $Id: AuSoundPlayFromData.3.html 243 2007-04-07 23:13:43Z jon $
 
28
 
 
29
-->
 
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
 
31
<!-- available at http://polyglotman.sourceforge.net/ -->
 
32
 
 
33
<html>
 
34
<head>
 
35
<title>AuSoundPlayFromData(3) manual page</title>
 
36
</head>
 
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
 
38
<a href='#toc'>Table of Contents</a><p>
 
39
 
 
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
 
41
<b>AuSoundPlayFromData</b> - create a flow to play
 
42
from memory. 
 
43
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
 
44
#include &lt;audio/audiolib.h&gt; <br>
 
45
#include &lt;audio/soundlib.h&gt; <p>
 
46
<b>AuEventHandlerRec</b> *<b>AuSoundPlayFromData</b>(<i>server</i>,
 
47
<i>sound</i>, <i>data</i>, <i>destination</i>, <i>volume</i>, <i>callback</i>, <i>callback_data</i>, <i>flow</i>, <i>volume_mult_elem</i>,
 
48
<i>monitor_element</i>, <i>status</i>) <br>
 
49
    <b>AuServer</b> *<i>server</i>;<br>
 
50
 <br>
 
51
    <b>Sound</b> <i>sound</i>;<br>
 
52
 <br>
 
53
    <b>AuPointer</b> <i>data</i>;<br>
 
54
 <br>
 
55
    <b>AuDeviceID</b> <i>destination</i>;<br>
 
56
 <br>
 
57
    <b>AuFixedPoint</b> <i>volume</i>;<br>
 
58
 <br>
 
59
    void (*<i>callback</i>) (<b>AuServer</b> *, <b>AuEventHandlerRec</b> *, <b>AuEvent</b> *, <b>AuPointer</b>);<br>
 
60
 <br>
 
61
    <b>AuPointer</b> <i>callback_data</i>;<br>
 
62
 <br>
 
63
    <b>AuFlowID</b> *<i>flow</i>; /* <b>RETURN</b> */<br>
 
64
 <br>
 
65
    int *<i>volume_mult_elem</i>; /* <b>RETURN</b> */<br>
 
66
 <br>
 
67
    int *<i>monitor_element</i>; /* <b>RETURN</b> */<br>
 
68
 <br>
 
69
    <b>AuStatus</b> *<i>status</i>; /* <b>RETURN</b> */<br>
 
70
 
 
71
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
 
72
 
 
73
<dl>
 
74
 
 
75
<dt><i>server</i></dt>
 
76
<dd>Specifies the connection to the audio server. </dd>
 
77
 
 
78
<dt><i>sound</i></dt>
 
79
<dd>Specifies
 
80
the description of the audio data. </dd>
 
81
 
 
82
<dt><i>data</i></dt>
 
83
<dd>Specifies the audio data to play.
 
84
</dd>
 
85
 
 
86
<dt><i>destination</i></dt>
 
87
<dd>Specifies the device to play the data on. </dd>
 
88
 
 
89
<dt><i>volume</i></dt>
 
90
<dd>Specifies the
 
91
volume. </dd>
 
92
 
 
93
<dt><i>callback</i></dt>
 
94
<dd>Specifies the procedure to be called for additional event
 
95
processing. </dd>
 
96
 
 
97
<dt><i>callback_data</i></dt>
 
98
<dd>Specifies any additional arguments to be passed
 
99
the callback. </dd>
 
100
 
 
101
<dt><i>flow</i></dt>
 
102
<dd>If non-NULL, returns the flow ID. </dd>
 
103
 
 
104
<dt><i>volume_mult_elem</i></dt>
 
105
<dd>If non-NULL,
 
106
returns the index of the volume multipler element. </dd>
 
107
 
 
108
<dt><i>monitor_element</i></dt>
 
109
<dd>If non-NULL,
 
110
include an ExportMonitor element in the flow and return it's index. </dd>
 
111
 
 
112
<dt><i>status</i></dt>
 
113
<dd>If
 
114
non-NULL, flush the output buffer and return the status from the server.
 
115
</dd>
 
116
</dl>
 
117
 
 
118
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
 
119
<b>AuSoundPlayFromData</b> creates a flow to play <i>data</i> on <i>device</i> and
 
120
returns a pointer to the event handler created or NULL if there was an
 
121
error. 
 
122
<h2><a name='sect4' href='#toc4'><b>Errors</b></a></h2>
 
123
<b>AuBadAlloc</b>, <b>AuBadDevice</b>. 
 
124
<h2><a name='sect5' href='#toc5'><b>See Also</b></a></h2>
 
125
<b>AuSoundPlay</b>, <b>AuSoundPlayFromBucket</b>,
 
126
<b>AuSoundPlayFromFile</b>, <b>AuSoundPlaySynchronousFromFile</b>. <p>
 
127
audiolib - <b>Network Audio
 
128
System</b> C Language Interface <p>
 
129
 
 
130
<hr><p>
 
131
<a name='toc'><b>Table of Contents</b></a><p>
 
132
<ul>
 
133
<li><a name='toc0' href='#sect0'>Name</a></li>
 
134
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
 
135
<li><a name='toc2' href='#sect2'>Arguments</a></li>
 
136
<li><a name='toc3' href='#sect3'>Description</a></li>
 
137
<li><a name='toc4' href='#sect4'>Errors</a></li>
 
138
<li><a name='toc5' href='#sect5'>See Also</a></li>
 
139
</ul>
 
140
</body>
 
141
</html>