afGetMarkIDs(3dm)afGetMarkIDs(3dm)NAMEafGetMarkIDs - get the number and list of marker ID's for an audio track
SYNOPSIS
#include <dmedia/audiofile.h>
int afGetMarkIDs(AFfilehandle file, int trackid, int markids[])
PARAMETER
file is an AFfilehandle structure, created when an audio file was
opened by a call to afOpenFile(3dm).
trackid is an integer which identifies an audio track contained in
file. All currently supported file formats contain exactly one
track, so always use the constant value AF_DEFAULT_TRACK for
now.
markids is an array of integer locations used to return a list of
unique positive marker id's which can be used to reference the
marker structures for track.
RETURN VALUEafGetMarkIDs() returns a nonnegative integer count of the number of
marker structures in the specified audio track, or -1 in case of error.
For AIFF/AIFF-C files, the number of marker structures in the
AF_DEFAULT_TRACK may be from 0 to 65535.
DESCRIPTIONafGetMarkIDs() returns the number of marker structures contained in the
audio track given by trackid, as well as a list of integer id's which can
be used to reference the markers individually.
In the current version of the AF, markers are used to store the locations
of loop endpoints in AIFF-C (AIFF) files only.
Typically, you call afGetMarkIDs() twice. The first time, you pass it a
null markids pointer and just check the return value.
The return value tells you how many locations to allocate in the
markids[] array, which you pass back to afGetMarkIDs() to obtain a list
of mark ID's.
You can then use these id's to reference the individual markers and
obtain information about them such as marker position and associated name
string.
CAVEATS
This function may return any configuration or number of marks just as it
may with an AIFF/AIFF-C file. Apps should be written to expect and
ignore marks they do not understand.
Page 1
afGetMarkIDs(3dm)afGetMarkIDs(3dm)SEE ALSOafOpenFile(3dm), afGetMarkPosition(3dm), afGetMarkName(3dm),
afInitMarkIDs(3dm)
Page 2
