The speaker component is used to play sound.

The speaker component is customized by setting options in the Speaker context panel. To display the Speaker context panel, click the embedded component. Actions are associated with components using routines in the DocumentTools package.

The Name property is used to reference the component when using routines from the DocumentTools package.

The following table describes the control and use of the speaker component options:

An x in the Get column indicates that the option can be read, that is, retrieved by using the DocumentTools[GetProperty] tool.

An x in the Set column indicates that the option can be written, that is, set by using the DocumentTools[SetProperty] tool.

enabled 

Whether the component is enabled. If enabled is set to false, the component is dimmed and any action associated with it cannot be initiated. By default, the value is true.

device 

The speaker device to use for playing sound.

mute 

Whether the speaker is muted or not.

samplerate 

The sample rate for playing sound (in Hz). 44100Hz is CD quality.

stereo

Whether audio is played using one channel (mono) or two channels (stereo).

tooltip 

The text that appears when the user hovers the mouse over the speaker component.

type 

The type of the component. This returns "Speaker".

value 

Audio data sent to the speaker.

visible 

Whether the speaker component is visible. By default, the value is true.

volume 

The volume of the speaker. By default, the value is 5.

with(DocumentTools):

audiofile := cat(kernelopts(datadir), "/audio/ViolinThreePosVibrato.wav");

R := AudioTools:-Read(audiofile);

SetProperty("Speaker0", stereo, true);

srate := attributes(R)[1];

$\mathrm{srate}:=44100$

SetProperty("Speaker0", samplerate, srate);

SetProperty("Speaker0", value, R);

AudioTools:-Play(R);