Engine.SoundNodeWave

Extends

SoundNode

Modifiers

PerObjectConfig native ( Sound ) dependson ( AudioDevice ) hidecategories ( Object ) editinlinenew

Sound node that contains sample data

Core.Object
|   
+-- Engine.SoundNode
   |   
   +-- Engine.SoundNodeWave

Direct Known Subclasses:

SoundNodeWaveStreaming

Functions Summary
		GeneratePCMData (out Array<byte> Buffer, int SamplesNeeded))

bDynamicResource Source code

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

bProcedural Source code

Set to true for programmatically-generated, streamed audio. Not used from the editor; you should use SoundNodeWaveStreaming.uc for this.

ChannelOffsets Source code

Offsets into the bulk data for the source wav data

ChannelSizes Source code

Sizes of the bulk data for the source wav data

CompressedPCData Source code

Cached ogg vorbis data.

CompressedPS3Data Source code

Cached cooked PS3 data to speed up iteration times.

CompressedXbox360Data Source code

Cached cooked Xbox 360 data to speed up iteration times.

DecompressionType Source code

Type of buffer this wave uses. Set once on load

LocalizedSubtitles Source code

The array of the subtitles for each language. Generated at cook time. The index for a specific language extenstion can be retrieved via the Localization_GetLanguageExtensionIndex function in UnMisc.cpp.

RawData Source code

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

RawPCMData Source code

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

RawPCMDataSize Source code

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

ResourceData Source code

Memory containing the data copied from the compressed bulk data

ResourceID Source code

Resource index to cross reference with buffers

ResourceSize Source code

Size of resource copied from the bulk data

VorbisDecompressor Source code

Async worker that decompresses the vorbis data on a different thread

Compression

100isbestquality.> Source code

Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality

bForceRealTimeDecompressionSource code

If set, forces wave data to be decompressed during playback instead of upfront on platforms that have a choice.

bLoopingSound Source code

If set, the compressor does everything required to make this a seamlessly looping sound

CompressionQualitySource code

Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality

evenforshortdurationsounds.> Source code

If set, forces wave data to be decompressed during playback instead of upfront on platforms that have a choice.

Info

Duration Source code

Duration of sound in seconds.

maximumis2.0-itisasimplelinearmultipliertotheSampleRate.> Source code

Playback pitch for sound 0.4 to 2.0

NumChannels Source code

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

PitchSource code

Playback pitch for sound 0.4 to 2.0

SampleRate Source code

Cached sample rate for displaying in the tools

Volume Source code

Playback volume of sound 0 to 1

SoundNodeWave

SourceFilePath Source code

Path to the resource used to construct this sound node wave

SourceFileTimestamp Source code

Date/Time-stamp of the file from the last import

Subtitles

bManualWordWrap Source code

TRUE if the subtitles have been split manually.

bMature Source code

TRUE if this sound is considered to contain mature content.

Comment Source code

Provides contextual information for the sound to the translator.

Subtitles Source code

Subtitle cues. If empty, use SpokenText as the subtitle. Will often be empty, as the contents of the subtitle is commonly identical to what is spoken.

TTS

bUseTTS Source code

Set to true to speak SpokenText using TTS

SpokenText Source code

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

TTSSpeaker Source code

Speaker to use for TTS

EDecompressionType Source code

GeneratePCMData Source code

This is only for DTYPE_Procedural audio. Override this function. Put SamplesNeeded PCM samples into Buffer. If put less, silence will be filled in at the end of the buffer. If you put more, data will be truncated. Please note that "samples" means individual channels, not sample frames! If you have stereo data and SamplesNeeded is 1, you're writing two SWORDs, not four! Due to UnrealScript limitations, this is an array, but you should supply 16-bit, signed data.

defaultproperties
{
	Volume=0.75
	Pitch=1.0
	CompressionQuality=40
	bLoopingSound=TRUE
}