afGetMarkName(3dm)afGetMarkName(3dm)NAME
afGetMarkName, afGetMarkComment - get the name or comment string for a
given marker id in an audio track
SYNOPSIS
#include <dmedia/audiofile.h>
char *afGetMarkName(AFfilehandle file, int trackid, int markid)
char *afGetMarkComment(AFfilehandle file, int trackid, int markid)
PARAMETER
file is an AFfilehandle structure, previously created by a call to
afOpenFile(3dm).
trackid is a positive integer value which identifies an audio track in
file. All currently supported file formats allow exactly one
audio track per file, so the value AF_DEFAULT_TRACK should
always be used here for now.
markid is a positive integer value which identifies a marker structure
in the audio track given by trackid. You obtain marker ID's by
calling afGetMarkIDs(3dm). You can call afInitMarkIDs(3dm) to
assign your own ID's when you create a new audio file.
RETURN VALUEafGetMarkName() returns a null-terminated string containing the name
associated with the specified marker, or the null string on error.
afGetMarkComment() returns a null-terminated string containing the
comment associated with the specified marker, or the null string on
error.
DESCRIPTION
The AIFF-C (AIFF) spec includes locations for name strings in marker
structures. For example, the marker which holds the beginning sample
frame location for the sustain loop might be named "begin sustain loop".
The WAVE (RIFF) format spec includes "cues" and associated data
describing each "cue". In addition to the position and name string, a
"note" is included in this data. The AF maps the mark position, name and
comment into these portions of the description.
See wave(4) for more details about cues.
See the AIFF-C spec and aiff(4) for more details about markers.
SEE ALSOafOpenFile(3dm), afGetMarkIDs(3dm), afInitMarkIDs(3dm),
afInitMarkName(3dm), afInitMarkComment(3dm)
Page 1
