USoundWave

Set to true for procedural waves that can be processed asynchronously.

Whether this SoundWave was decompressed from OGG.

Whether to free the resource data after it has been uploaded to the hardware

Whether or not to enable cook-time amplitude envelope analysis.

Whether or not to enable cook-time baked FFT analysis.

Whether or not this source is ambisonics file format.

Set to true of this is a bus sound source.

If set, when played directly (not through a sound cue) the wave will be played looping.

If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.

If set to true if this sound is considered to contain mature/adult content.

Set to true for programmatically generated audio.

Set to true if fade is required when sound is abruptly stopped.

Whether this sound supports seeking.

If set to true the subtitles display as a sequence of single lines as opposed to multiline.

Whether this sound can be streamed to avoid increased memory usage.

If true, the sound will compress to the Bink Audio format whenever available.

Pointer to 16 bit PCM data - used to avoid synchronous operation to obtain first block of the realtime decompressed buffer

Offsets into the bulk data for the source wav data

Sizes of the bulk data for the source wav data

Provides contextual information for the sound to the translator.

GUID used to uniquely identify this node so it can be found in the DDC

Platform agnostic compression quality.

The cooked cooked envelope data.

Cooked streaming platform data for this sound

The cooked spectral time data.

Cue point data

The current revision of our compressed audio data. Used to tell when a chunk in the cache is stale.

Curves associated with this sound wave

Type of buffer this wave uses. Set once on load

The attack time in milliseconds.

How many audio frames to average a new envelope value.

The release time in milliseconds.

Attack time in milliseconds of the spectral envelope follower.

How many audio frames analyze at a time.

Release time in milliseconds of the spectral envelope follower.

The FFT window size to use for fft analysis.

The frequencies (in hz) to analyze when doing baked FFT analysis.

Sample rate of the imported sound wave.

Use this to override how much audio data is loaded when this USoundWave is loaded.

Hold a reference to our internal curve so we can switch back to it if we want to

Loading behavior members are lazily initialized in const getters.

Modulation Settings

Number of channels of multichannel data; 1 or 2 for regular mono and stereo files

The number of frames which have been precached for this sound wave.

The number of sounds currently playing this sound wave.

Specify a sound to use for the baked analysis.

Playback pitch for sound.

Uncompressed wav data 16 bit in mono or stereo - stereo not allowed for multichannel data

FByteBulkData doesn't currently support readonly access from multiple threads, so we limit access to RawData with a critical section on cook.

Pointer to 16 bit PCM data - used to decompress data to and preview sounds

Size of RawPCMData, or what RawPCMData would be if the sound was fully decompressed

Resource index to cross reference with buffers

Cooked sample rate of the asset. Can be modified by sample rate override.

Quality of sample rate conversion for platforms that opt into resampling during cook.

A localized version of the text that is actually spoken phonetically in the audio.

Priority of this sound when streaming (lower priority streams may not always play)

The priority of the subtitle.

Subtitle cues.

Cache the total used memory recorded for this SoundWave to keep INC/DEC consistent

Whether or not we should treat the sound wave used for analysis (this or the override) as looping while performing analysis.

Playback volume of sound 0 to 1 - Default is 1.0.

Begins caching platform data in the background.

Caches platform data for the sound.

Will clean up the decompressor task if the task has finished or force it finish.

When stream caching is enabled, this is called after we've successfully compressed and split the streamed audio for this file.

Blocks on async cache tasks and prepares platform data for use.

Forces platform data to be rebuilt.

Frees up all the resources allocated in this class.

This is only used for DTYPE_Procedural audio.

Get Chunk data for a specified chunk index.

Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats

Gets the compressed data size from derived data cache for the specified format

Gets the member name for the Curves property of the USoundWave object.

Return the format of the generated PCM data type.

If stream caching is enabled, allows the user to retain a strong handle to the first chunk of audio in the cache.

Utility which returns imported PCM data and the parsed header for the file.

Utility which returns imported PCM data and the parsed header for the file.

These functions are required for support for some custom details/editor functionality.

Helper function to get interpolated cooked FFT data for a given time value.

Returns the loading behavior we should use for this sound wave.

Returns the amount of chunks this soundwave contains if it's streaming, or zero if it is not a streaming source.

Return the platform compression overrides set for the current platform.

Memory containing the data copied from the compressed bulk data

Helper function for getting the cached name of the current platform.

Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.

Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.

Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.

This returns the initial chunk of compressed data for streaming data sources.

Handle any special requirements when the sound starts (e.g. subtitles)

Returns whether this sound wave has internal curves.

This function returns true if there are streamable chunks in this asset.

Copy the compressed audio data from derived data cache

Copy the compressed audio data from the bulk data

Change the guid and flush all compressed data

This function can be called before playing or using a SoundWave to check if any cook settings have been modified since this SoundWave was last cooked.

Checks whether sound has seekable streaming enabled.

Checks whether sound has been categorized as streaming.

Checks whether sound has been categorized as streaming.

Called when the procedural sound wave begins on the render thread. Only used in the audio mixer and when bProcedural is true.

Called when the procedural sound wave is done generating on the render thread. Only used in the audio mixer and when bProcedural is true..

If Stream Caching is enabled, this can be used to override the default loading behavior of this USoundWave.

If stream caching is enabled and au.streamcache.KeepFirstChunkInMemory is 1, this will release this USoundWave's first chunk, allowing it to be deleted.

Remove the compressed audio data associated with the passed in wave

If stream caching is enabled, set this sound wave to retain a strong handle to its first chunk.

Serializes cooked platform data.

Sets the curve data for this sound wave.

Sets the internal curve data for this sound wave.

Overwrite sample rate.

Checks whether we should use the load on demand cache.

Attempts to update the cached platform data after any changes that might affect it

Returns curves associated with this sound wave

Returns the length of the sound

Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.

Returns the subtitle priority

Queries if the sound has cooked FFT or envelope data.

Returns whether the sound base is set up in a playable manner

Parses the Sound to generate the WaveInstances to play.

Returns whether sound supports subtitles.

Begins caching platform data in the background for the platform requested

Called before destroying the object.

Clear all the cached cooked platform data which we have accumulated with BeginCacheForCookedPlatformData calls The data can still be cached again using BeginCacheForCookedPlatformData again

Clears cached cooked platform data for specific platform

Called to finish destroying the object.

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Returns the name of the exporter factory used to export this object Used when multiple factories have the same extension

Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData

Called to check if the object is ready for FinishDestroy.

Called when a property on this object has been modified externally

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Do any object-specific cleanup required immediately after loading an object.

Handles reading, writing, and reference collecting using FArchive.

All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms)

Async worker that decompresses the audio data on a different thread