SourceAudio#

class ansys.sound.core.sound_composer.SourceAudio(file='')#

Sound Composer’s audio source class.

This class creates an audio source for the Sound Composer. An audio source simply consists of a time-domain - typically audio - signal. Unlike other source types, it requires no source control.

See also

SoundComposer, Track

Examples

Create an audio source from a sound signal stored in a WAV file.

>>> from ansys.sound.core.sound_composer import SourceAudio
>>> source_audio = SourceAudio(file="path/to/audio.wav")
>>> source_audio.process(sampling_frequency=48000.0)
>>> source_audio.plot()

Class instantiation takes the following parameters.

Parameters:

filestr, default: “”: Path to the audio source file. Supported files are WAV files and and text files with the header AnsysSound_SoundSamples.

Methods

`SourceAudio.get_as_generic_data_containers`()	Get the source data as generic data containers.
`SourceAudio.get_output`()	Get the generated sound as a DPF field.
`SourceAudio.get_output_as_nparray`()	Get the generated sound as a NumPy array.
`SourceAudio.is_source_control_valid`()	Check if the source control is valid.
`SourceAudio.load_from_text_file`(file)	Load the audio source data from a text file.
`SourceAudio.load_from_wave_file`(file)	Load the audio source data from a WAV file.
`SourceAudio.plot`()	Plot the generated sound.
`SourceAudio.plot_control`()	Plot the source control(s) in a figure.
`SourceAudio.process`([sampling_frequency])	Generate the sound of the audio source.
`SourceAudio.set_from_generic_data_containers`(...)	Set the source and source control data from generic data containers.

Attributes

SourceAudio.source_audio_data

Source data of the audio source.