Prosody WAV FILE: API: sm_replay_wav_prepare

Prototype Definition

int sm_replay_wav_prepare(struct sm_replay_wav_prepare_parms *replay_wav_prep_parms)

Parameters

*replay_wav_prep_parms

a structure of the following type:

typedef struct sm_replay_wav_prepare_parms {
	char *filename;						/* in */
	SM_REPLAY_PARMS *replay_parms;				/* out */
} SM_REPLAY_WAV_PREPARE_PARMS;

Description

Given an open WAV file, populates the replay_parms structure with the information required to start a replay. The channel field will remain uninitialised until a valid tSMChannelId is supplied. Please note that the replay_parms structure must have already been cleared (usually with memset()) before calling this function. After this function returnes you may modify the field in that structure before starting a replay.

Fields

filename

The name of a WAV file.

replay_parms

A structure as defined for sm_replay_start.

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_FILE_ACCESS - problem reading file

This function is part of the Prosody WAV FILE API.