File: al_set_audio_stream_pan.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (28 lines) | stat: -rw-r--r-- 809 bytes parent folder | download
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
.TH al_set_audio_stream_pan 3 "" "Allegro reference manual"
.SH NAME
.PP
al_set_audio_stream_pan \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_set_audio_stream_pan(ALLEGRO_AUDIO_STREAM\ *stream,\ float\ val)
\f[]
.fi
.SH DESCRIPTION
.PP
Set the pan value on an audio stream.
A value of \-1.0 means to play the stream only through the left speaker;
+1.0 means only through the right speaker; 0.0 means the sample is
centre balanced.
A special value ALLEGRO_AUDIO_PAN_NONE(3) disables panning and plays the
stream at its original level.
This will be louder than a pan value of 0.0.
.PP
Returns true on success, false on failure.
Will fail if the sample instance is attached directly to a voice.
.SH SEE ALSO
.PP
al_get_audio_stream_pan(3), ALLEGRO_AUDIO_PAN_NONE(3)