Back to Adaptive Vision Library website
You are here: Start » Function Reference » Sound » PlaySoundFile
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Plays specified audio file in WAV format.
Syntax
void avl::PlaySoundFile ( PlaySoundFileState& ioState, const atl::File& inFile, bool inSynchronous )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
ioState | PlaySoundFileState& | Object used to maintain state of the function. | ||
inFile | const File& | Sound file in WAV format | ||
inSynchronous | bool | False | Plays sound in synchronous mode, waiting for the end of playback |
Description
This filter plays specified in inFile audio file in WAV format. The audio file is by default played in asynchronous (non-blocking) mode - to play file in synchronous mode set the inSynchronous input to True.
Errors
Error type | Description |
---|---|
IoError | PlaySoundFile supports only .wav files. |