Sound Player

Summary

Doc_BoxAlgorithm_SoundPlayer.png
  • Plugin name : Sound Player
  • Version : 1.0
  • Author : Laurent Bonnet
  • Company : INRIA
  • Short description : Play/Stop a sound, with or without loop.
  • Documentation template generation date : Dec 30 2016

Description

Available format : WAV / OGG. Play and stop with input stimulations. Box based on OpenAL.

The Sound Player box can play a sound in WAV or OGG format. It is based on the OpenAL library. The box has to be configured to define the stimulations used as "play" and "stop" triggers. When the file is stopped, manually or not, the "stop" stimulation is output.

Inputs

1. Input triggers

The stimulations that trigger "play" or "stop".

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Outputs

1. Resync triggers

The box outputs the "play" and "stop" triggers when the sound is actually started and stopped (manually or at the end of file). These stimulations are synchronized with the OpenAL engine, which timing may differ slightly with the input triggers.

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Settings

1. PLAY trigger

The stimulation that triggers the sound play.

  • Type identifier : Stimulation (0x2c132d6e, 0x44ab0d97)
  • Default value : [ OVTK_StimulationId_Label_00 ]

2. STOP trigger

The stimulation that triggers the sound stop.

  • Type identifier : Stimulation (0x2c132d6e, 0x44ab0d97)
  • Default value : [ OVTK_StimulationId_Label_01 ]

3. File to play

The sound file, in OGG or WAV format.

  • Type identifier : Filename (0x330306dd, 0x74a95f98)
  • Default value : [ ${Path_Data}/plugins/stimulation/ov_beep.wav ]

4. Loop

This setting indicates if the file has to be played in a loop once started. note: when enabled the output stimulation is not sent after each loop, but only when a "stop" stimulation is received.

  • Type identifier : Boolean (0x2cdb2f0b, 0x12f231ea)
  • Default value : [ false ]

Examples

Miscellaneous

This box is based on OpenAL (through Alut) and uses the libogg and libvorbis libraries.