3
$NCDId: @(#)AuMChStA.man,v 1.1 1994/09/27 00:30:39 greg Exp $
4
copyright 1994 Steven King
7
* Copyright 1993 Network Computing Devices, Inc.
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.
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.
27
$Id: AuMakeChangeStateAction.3.html 243 2007-04-07 23:13:43Z jon $
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
31
<!-- available at http://polyglotman.sourceforge.net/ -->
35
<title>AuMakeChangeStateAction(3) manual page</title>
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
38
<a href='#toc'>Table of Contents</a><p>
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
41
<b>AuMakeChangeStateAction</b> - initialize an action
43
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
44
#include <audio/audiolib.h> <p>
45
<b>AuMakeChangeStateAction</b>(<i>action</i>, <i>trigger_state</i>,
46
<i>trigger_prev_state</i>, <i>trigger_reason</i>, <i>flow</i>, <i>element_num</i>, <i>new_state</i>) <br>
47
<b>AuElementAction</b> <i>action</i>; /* <b>RETURN</b> */<br>
49
unsigned char <i>trigger_state</i>;<br>
51
unsigned char <i>trigger_prev_state</i>;<br>
53
unsigned char <i>trigger_reason</i>;<br>
55
<b>AuFlowID</b> <i>flow</i>;<br>
57
unsigned char <i>element_num</i>;<br>
59
unsigned char <i>new_state</i>;<br>
61
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
65
<dt><i>action</i></dt>
66
<dd>Returns the initialized action. </dd>
68
<dt><i>trigger_state</i></dt>
70
state that triggers the action. This must be one of these constants: <b>AuStateStop</b>,
71
<b>AuStateStart</b>, <b>AuStatePause</b>, or <b>AuStateAny</b>. </dd>
73
<dt><i>trigger_prev_state</i></dt>
75
previous state for the trigger. This must be one of these constants: <b>AuStateStop</b>,
76
<b>AuStateStart</b>, <b>AuStatePause</b>, or <b>AuStateAny</b>. </dd>
78
<dt><i>trigger_reason</i></dt>
79
<dd>Specifies the reason
80
for the action. This must be one of these constants: <b>AuReasonUser</b>, <b>AuReasonUnderrun</b>,
81
<b>AuReasonOverrun</b>, <b>AuReasonEOF</b>, <b>AuReasonWatermark</b>, <b>AuReasonHardware</b>, or <b>AuReasonAny</b>.
85
<dd>Specifies the ID of the flow to affect. </dd>
87
<dt><i>element_num</i></dt>
88
<dd>Specifies the index
89
of the element to affect. </dd>
91
<dt><i>new_state</i></dt>
92
<dd>Specifies the new state for the flow.
93
This must be one of thses constants: <b>AuStateStop</b>, <b>AuStateStart</b>, or <b>AuStatePause</b>.
97
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
98
<b>AuMakeChangeStateAction</b> sets the <b>action</b> field of <i>action</i> to <b>AuElementActionChangeState</b>
99
and initializes the other fields with the remaining arguments. <p>
100
<b>AuMakeChangeStateAction</b>
101
is implemented as a macro.
102
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
103
<b>AuMakeSendNotifyAction</b>, <b>AuMakeNoopAction</b>.
105
audiolib - <b>Network Audio System</b> C Language Interface <p>
108
<a name='toc'><b>Table of Contents</b></a><p>
110
<li><a name='toc0' href='#sect0'>Name</a></li>
111
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
112
<li><a name='toc2' href='#sect2'>Arguments</a></li>
113
<li><a name='toc3' href='#sect3'>Description</a></li>
114
<li><a name='toc4' href='#sect4'>See Also</a></li>