File: AuSoundPlayFromBucket.3.html

package info (click to toggle)
nas 1.9.4-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 8,640 kB
  • sloc: ansic: 52,144; makefile: 31,376; sh: 8,077; perl: 1,104; yacc: 252; cpp: 216; lex: 68
file content (142 lines) | stat: -rw-r--r-- 4,975 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

<!--
  $NCDId: @(#)AuSPFB.man,v 1.2 1995/05/23 23:52:58 greg Exp $
   copyright 1994 Steven King
   
   portions are
   * Copyright 1993 Network Computing Devices, Inc.
   *
   * Permission to use, copy, modify, distribute, and sell this software and its
   * documentation for any purpose is hereby granted without fee, provided that
   * the above copyright notice appear in all copies and that both that
   * copyright notice and this permission notice appear in supporting
   * documentation, and that the name Network Computing Devices, Inc. not be
   * used in advertising or publicity pertaining to distribution of this
   * software without specific, written prior permission.
   * 
   * THIS SOFTWARE IS PROVIDED 'AS-IS'.  NETWORK COMPUTING DEVICES, INC.,
   * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
   * LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   * PARTICULAR PURPOSE, OR NONINFRINGEMENT.  IN NO EVENT SHALL NETWORK
   * COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
   * SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
   * OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
   * WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
   * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   
   $Id: AuSoundPlayFromBucket.3.html 243 2007-04-07 23:13:43Z jon $
 
-->
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>AuSoundPlayFromBucket(3) manual page</title>
</head>
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
<b>AuSoundPlayFromBucket</b> - create a flow to play
from a bucket. 
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
#include &lt;audio/audiolib.h&gt; <br>
#include &lt;audio/soundlib.h&gt; <p>
<b>AuEventHandlerRec</b> *<b>AuSoundPlayFromBucket</b>(<i>server</i>,
<i>source</i>, <i>destination</i>, <i>volume</i>, <i>callback</i>, <i>callback_data</i>, <i>loop_count</i>, <i>flow</i>,
<i>volume_mult_elem</i>, <i>monitor_element</i>, <i>status</i>) <br>
    <b>AuServer</b> *<i>server</i>;<br>
 <br>
    <b>AuBucketID</b> <i>source</i>;<br>
 <br>
    <b>AuDeviceID</b> <i>destination</i>;<br>
 <br>
    <b>AuFixedPoint</b> <i>volume</i>;<br>
 <br>
    void (*<i>callback</i>) (<b>AuServer</b> *, <b>AuEventHandlerRec</b> *, <b>AuEvent</b> *, <b>AuPointer</b>);<br>
 <br>
    <b>AuPointer</b> <i>callback_data</i>;<br>
 <br>
    int <i>loop_count</i>;<br>
 <br>
    <b>AuFlowID</b> *<i>flow</i>; /* <b>RETURN</b> */<br>
 <br>
    int *<i>volume_mult_elem</i>; /* <b>RETURN</b> */<br>
 <br>
    int *<i>monitor_element</i>; /* <b>RETURN</b> */<br>
 <br>
    <b>AuStatus</b> *<i>status</i>; /* <b>RETURN</b> */<br>
 <br>

<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>

<dl>

<dt><i>server</i></dt>
<dd>Specifies the connection to the audio server. </dd>

<dt><i>source</i></dt>
<dd>Specifies
the bucket to play. </dd>

<dt><i>destination</i></dt>
<dd>Specifies the device to output the audio
data. </dd>

<dt><i>volume</i></dt>
<dd>Specifies the volume. </dd>

<dt><i>callback</i></dt>
<dd>Specifies the procedure to be called
for additional event processing. </dd>

<dt><i>callback_data</i></dt>
<dd>Specifies any additional arguments
to be passed to the callback. </dd>

<dt><i>loop_count</i></dt>
<dd>Specifies how many time the bucket
should be played. </dd>

<dt><i>flow</i></dt>
<dd>If non-NULL, returns the flow ID. </dd>

<dt><i>volume_mult_elem</i></dt>
<dd>If
non-NULL, returns the index of the volume multipler element. </dd>

<dt><i>monitor_element</i></dt>
<dd>If
non-NULL, include an ExportMonitor element in the flow and return it's index.
</dd>

<dt><i>status</i></dt>
<dd>If non-NULL, flush the output buffer and return the status from the
server. </dd>
</dl>

<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
<b>AuSoundPlayFromBucket</b> creates a flow to play <i>bucket</i> on
<i>device</i> and returns a pointer to the event handler created or NULL if there
was an error. 
<h2><a name='sect4' href='#toc4'><b>Errors</b></a></h2>
<b>AuBadBucket</b>, <b>AuBadDevice</b>. 
<h2><a name='sect5' href='#toc5'><b>See Also</b></a></h2>
<b>AuSoundPlay</b>, <b>AuSoundPlayFromData</b>,
<b>AuSoundPlayFromFile</b>, <b>AuSoundPlaySynchronousFromFile</b>. <p>
audiolib - <b>Network Audio
System</b> C Language Interface <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Arguments</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>Errors</a></li>
<li><a name='toc5' href='#sect5'>See Also</a></li>
</ul>
</body>
</html>