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

ALLEGRO_VOICE\ *al_create_voice(unsigned\ int\ freq,
\ \ \ ALLEGRO_AUDIO_DEPTH\ depth,\ ALLEGRO_CHANNEL_CONF\ chan_conf)
\f[]
.fi
.SH DESCRIPTION
.PP
Creates a voice structure and allocates a voice from the digital sound
driver.
The passed frequency, sample format and channel configuration are used
as a hint to what kind of data will be sent to the voice.
However, the underlying sound driver is free to use non\-matching
values.
For example it may be the native format of the sound hardware.
If a mixer is attached to the voice, the mixer will convert from the
mixer\[aq]s format to the voice format and care does not have to be
taken for this.
.PP
However if you access the voice directly, make sure to not rely on the
parameters passed to this function, but instead query the returned voice
for the actual settings.
.SH SEE ALSO
.PP
al_destroy_voice(3)