File: al_drain_audio_stream.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 (21 lines) | stat: -rw-r--r-- 496 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)