alCSPGetChlVol.3p
1.02 KB
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
.TH alCSPGetChlVol 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alCSPGetChlVol \- returns the volume for the given MIDI channel.
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
u8 alCSPGetChlVol(ALCSPlayer *seqp, u8 chan);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.B seqp
pointer to compressed MIDI sequence player.
.TP
.B chan
the target (0 based) MIDI channel.
.SH DESCRIPTION
alCSPGetChlVol returns the volume for the given MIDI channel at the end of
the last call to
.B alAudioFrame.
A value of 127 is full volume, and 0 is "off". Because messages generated by
.B alCSPSetChlVol
are not processed until the next
call to
.B alAudioFrame,
a call to
.B alCSPSetChlVol
followed by a call to
.B alCSPGetChlVol
within the same frame will not reflect
the new value.
.SH NOTE
In addition to channel volume, the sequence player maintains an overall
sequence volume which can be accessed and set with
.B alCSPGetVol
and
.B alCSPSetVol.
.SH SEE ALSO
alCSPSetChlVol(3P),
alCSPSetVol(3P),
alCSPGetVol(3P),
alCSeqPlayer(3P)