Open

The player calls this function to prepare the plug-in encode audio data.

Parameters

Parameters	Description
outFile	[in] string of filename to which to write encoded data (encoding determined by version setting)
srcFile	[in] string of filename or stream URL that is the source of decoded data (encoding determined by version setting)
wf	[in] format of audio data to be encoded
openedFilename	[out] string of actual file being created by encoder, in case encoder changes it from outFile (encoding determined by version setting)
openedFilenameSize	[in] size of buffer pointed to by openedFilename (in bytes)

Return Values

Return Values	Description
0	command unsuccessful
1	command successful

Remarks

The format of the audio will match the format specified by the wf parameter. The outFile parameter should be the name of the file to write encoded data to. The srcFile parameter is to provide reference to the source media if needed.

The module must populate the openedFilename parameter with the full filename of the file being used to write the encoded data to, even if it matches outFile.

Upon returning success, the module should expect audio data to arrive at the Write function until the Stop function is called.