File: al_attach_audio_stream_to_voice.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (32 lines) | stat: -rw-r--r-- 924 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
29
30
31
32
.TH "al_attach_audio_stream_to_voice" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_attach_audio_stream_to_voice \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_attach_audio_stream_to_voice(ALLEGRO_AUDIO_STREAM\ *stream,
\ \ \ ALLEGRO_VOICE\ *voice)
\f[]
.fi
.SH DESCRIPTION
.PP
Attaches an audio stream to a voice.
The same rules as al_attach_sample_instance_to_voice(3) apply.
This may fail if the driver can\[aq]t create a voice with the buffer
count and buffer size the stream uses.
.PP
An audio stream attached directly to a voice has a number of
limitations: The audio stream plays immediately and cannot be stopped.
The stream position, speed, gain and panning cannot be changed.
At this time, we don\[aq]t recommend attaching audio streams directly to
voices.
Use a mixer inbetween.
.PP
Returns true on success, false on failure.
.SH SEE ALSO
.PP
al_detach_voice(3)