stimuli.audio.Sound

class stimuli.audio.Sound(fname, device=None, *, backend='sounddevice', clock=<class 'stimuli.time._clock.Clock'>, **kwargs)

Auditory stimulus loaded from a file.

Parameters:

fnamestr | pathlib.Path

Path to the supported audio file to load.

deviceint | None

Device index to use for sound playback. If None, the default device provided by the backend is used.

backend"sounddevice"

The backend to use for sound playback.

clockstimuli.time.BaseClock class

Clock object to use for timing measurements. By default, the stimuli.time.Clock class is used.

**kwargs

Additional keyword arguments passed to the backend initialization.

Attributes

duration	The duration of the audio stimulus.
fname	The sound's original file name.
sample_rate	The sample rate of the audio stimulus.
signal	The audio signal.
times	The time array of the audio stimulus.
volume	The volume of the audio stimulus per channel given as a percentage.
window	Window applied to the audio signal.

Methods

play([when, blocking])	Play the audio data.
plot()	Plot the audio signal waveform.
save(fname, *[, overwrite])	Save the audio stimulus to a WAV file.
stop()	Interrupt immediately the playback of the audio data.

play(when=None, *, blocking=False)

Play the audio data.

Parameters:

whenfloat | None

The relative time in seconds when to start playing the audio data. For instance, 0.2 will start playing in 200 ms. If None, the audio data is played as soon as possible. A duration superior to the device latency is recommended.

blockingbool

If True, the function blocks until the audio playback is finished.

plot()

Plot the audio signal waveform.

Returns:

fmatplotlib.figure.Figure

The matplotlib figure object.

axmatplotlib.axes.Axes

The matplotlib axes object.

save(fname, *, overwrite=False)

Save the audio stimulus to a WAV file.

The saving is handled by scipy.io.wavfile.write().

Parameters:

fnamestr | pathlib.Path

Path to the output file. The extension should be '.wav'.

overwritebool

If True, existing files are overwritten.

stop()

Interrupt immediately the playback of the audio data.

property duration

The duration of the audio stimulus.

Type:

float

property fname

The sound’s original file name.

Type:

Path

property sample_rate

The sample rate of the audio stimulus.

Type:

int

property signal

The audio signal.

Type:

ndarray of shape (n_samples, n_channels)

property times

The time array of the audio stimulus.

Type:

ndarray of shape (n_samples,)

property volume

The volume of the audio stimulus per channel given as a percentage.

Type:

ndarray of shape (n_channels,)

property window

Window applied to the audio signal.

Type:

ndarray of shape (n_samples,) | None

Examples using stimuli.audio.Sound

Base sounds

Base sounds