File: al_save_sample_f.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-- 769 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_save_sample_f" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_save_sample_f \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_save_sample_f(ALLEGRO_FILE\ *fp,\ const\ char\ *ident,\ ALLEGRO_SAMPLE\ *spl)
\f[]
.fi
.SH DESCRIPTION
.PP
Writes a sample into a ALLEGRO_FILE(3) filestream.
Currently, wav is the only supported format, and the extension must be
".wav".
.PP
Returns true on success, false on error.
The file remains open afterwards.
.RS
.PP
\f[I]Note:\f[] the allegro_audio library does not support any audio file
formats by default.
You must use the allegro_acodec addon, or register your own format
handler.
.RE
.SH SEE ALSO
.PP
al_save_sample(3), al_register_sample_saver_f(3),
al_init_acodec_addon(3)