File: afWriteFrames.3.txt

package info (click to toggle)
audiofile 0.3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,192 kB
  • sloc: cpp: 31,691; sh: 11,006; ansic: 3,773; makefile: 271
file content (50 lines) | stat: -rw-r--r-- 1,150 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
afWriteFrames(3)
================

NAME
----
afWriteFrames - write audio frames to an audio file

SYNOPSIS
--------
  #include <audiofile.h>

  AFframecount afWriteFrames(AFfilehandle file, int track, const void *data,
      AFframecount count);

DESCRIPTION
-----------
`afWriteFrames` attempts to write up to 'count' frames of audio data
from the buffer 'data' to the audio file handle 'file'.

PARAMETERS
----------
'file' is a valid file handle returned by linkaf:afOpenFile[3].

'track' is always `AF_DEFAULT_TRACK` for all currently supported file formats.

'data' is a buffer of sample frames to be written to the file.

'count' is the number of sample frames to be written.

RETURN VALUE
------------
`afWriteFrames` returns the number of sample frames successfully written
to 'file'.

ERRORS
------
`afWriteFrames` can produce these errors:

`AF_BAD_FILEHANDLE`:: the file handle was invalid
`AF_BAD_TRACKID`:: the track is not `AF_DEFAULT_TRACK` 
`AF_BAD_WRITE`:: writing audio data to the file failed
`AF_BAD_LSEEK`:: seeking within the file failed

SEE ALSO
--------
linkaf:afReadFrames[3]

AUTHOR
------
Michael Pruett <michael@68k.org>