dmACReset(3dm) dmACReset(3dm)
NAME
dmACReset - reset a DMaudioconverter handle to its default state
SYNOPSIS
#include <dmedia/dmaudio.h>
#include <dmedia/dmaudioutil.h>
DMstatus dmACReset(DMaudioconverter converter)
PARAMETERS
converter is a DMaudioconverter handle created by a previous call to
the creation method dmACCreate(3dm).
RETURNED VALUE
Returns DMSUCCESS if the operation succeeds. If DMFAILURE is returned,
the error number and/or message can be retrieved via dmGetError(3dm).
DESCRIPTION
The handle passed to this routine is declared as follows:
typedef struct DMaudioconverter *DMaudioconverter;
dmACReset(3dm) clears and zeros any internal buffered data and resets all
counters, essentially returning the converter to the state it was in
immediately following a call to dmACSetParams(3dm). This might be
desirable in a case where an existing stream of data were to be
interrupted and replaced with a new stream, and the user wished to be
certain all of the previously-processed data was cleared.
SEE ALSO
dmACCreate(3dm), dmACSetParams(3dm), dmACGetParams(3dm),
dmACConvert(3dm), dmACDestroy(3dm)
Page 1