Documentation
VoIP_PlayWave
Require: IP-Symcon >= 5.2
boolean VoIP_PlayWave (int $InstanceID, int $ConnectionID, string $Filename)
Parameters
| InstanceID | ID of the device to be switched |
| ConnectionID | ID of the connection to be switched |
| Filename | Path and name of the file to be played |
Returns
If the command succeeds, it returns TRUE, otherwise FALSE.
Description
Plays the sound file Filename on the connection with the ID ConnectionID on the VoIP instance with the ID InstanceID.
Exclusively data in WAV format: 16-bit, 8000 Hz, mono is supported.
It does not wait for the sound file to finish playing. This is handled by the $_IPS['EVENT'] == "PlayFinish".
Dynamic sound files can also be created using the TTS Module or AWS Polly from the Module Store.
Example
// Plays the sound file "welcome.wav" on the connection with ID 3
VoIP_PlayWave(12345, 3, IPS_GetKernelDir() . "/media/welcome.wav");