File: al_drain_audio_stream.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 (21 lines) | stat: -rw-r--r-- 503 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
.TH "al_drain_audio_stream" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_drain_audio_stream \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

void\ al_drain_audio_stream(ALLEGRO_AUDIO_STREAM\ *stream)
\f[]
.fi
.SH DESCRIPTION
.PP
You should call this to finalise an audio stream that you will no longer
be feeding, to wait for all pending buffers to finish playing.
The stream\[aq]s playing state will change to false.
.SH SEE ALSO
.PP
al_destroy_audio_stream(3)