Programming Reference:AudioStimulus Class

From BCI2000 Wiki
Jump to: navigation, search

Location

src/shared/modules/application/audio

Synopsis

The AudioStimulus class unites the functionality of the SpeechStimulus Class, and the SoundStimulus Class in a single object.

Properties

string Sound (rw)

A name of a sound file, or a text to speak. When enclosed with single quotes, the string is interpreted as a text to speak.

float Volume (rw)

A number between 0 and 1, representing the volume of audio output.

Methods

Present()

Renders the text given by the Sound property using the system-wide text-to-speech engine, or begins playback of the sound file specified there.

Conceal()

Does nothing.

See also

Programming Reference:Stimulus Class, Programming Reference:SoundStimulus Class, Programming Reference:SpeechStimulus Class.