struct AudioClipCreateInformation

Descriptor used for initializing an audio clip.

Public

Fields

ReadMode

AudioReadMode ReadMode

Determines how is audio data read.

Format

Determines in which format is the audio data in.

Frequency

u32 Frequency

Sample rate (frequency) of the audio data.

BitDepth

u32 BitDepth

Number of bits per sample.

Not used for compressed formats.

ChannelCount

u32 ChannelCount

Number of channels.

Each channel has its own step of samples.

Is3D

bool Is3D

Determines should the audio clip be played using 3D positioning.

Only valid for mono audio.

KeepSourceData

bool KeepSourceData

Determines should the audio clip keep the original data in memory after creation.

For example if the audio data is normally compressed, but audio clip uncompresses it on load, the original compressed data will be lost unless this is enabled. This will cause extra memory to be used, but can be useful in certain circumstances (for example you might require that data to save the audio clip on disk).

When loading audio clip directly from disk, this properly is controlled by the ResourceLoadFlag::KeepSourceData.