UE3:SoundNodeWave (UT3)

Object >> SoundNode >> SoundNodeWave

Package: 

Engine

This class in other games:

UDK

Sound node that contains sample data

Properties

Property group 'Compression'

bForceRealtimeDecompression

Type: bool

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

CompressionQuality

Type: int

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

Default value: 40

Property group 'Info'

Duration

Type: float

Modifiers: editconst, const

Duration of sound in seconds.

NumChannels

Type: int

Modifiers: editconst, const

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

Pitch

Type: float

Modifiers: editconst, const

Playback pitch for sound 0.5 to 2.0

Default value: 1.0

SampleRate

Type: int

Modifiers: editconst, const

Cached sample rate for displaying in the tools

Volume

Type: float

Modifiers: editconst, const

Playback volume of sound 0 to 1

Property group 'Subtitles'

bAlwaysLocalise

Type: bool

Localise this sound even if there are no subtitles

bManualWordWrap

Type: bool

Modifiers: localized

TRUE if the subtitles have been split manually.

bMature

Type: bool

Modifiers: localized

TRUE if this sound is considered mature.

Comment

Type: string

Modifiers: localized

Provides contextual information for the sound to the translator.

Subtitles

Type: array<SubtitleCue>

Modifiers: localized

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.

Property group 'TTS'

bUseTTS

Type: bool

Set to true to speak SpokenText using TTS

SpokenText

Type: string

Modifiers: localized

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

TTSSpeaker

Type: ETTSSpeaker

Speaker to use for TTS

Internal variables

bDynamicResource

Type: bool

Modifiers: transient, const

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

bOneTimeUse

Type: bool

Modifiers: transient, const

Whether to free this resource after it has played - designed for TTS of log

ChannelOffsets

Type: array<int>

Modifiers: const

Offsets into the bulk data for the source wav data

ChannelSizes

Type: array<int>

Modifiers: const

Sizes of the bulk data for the source wav data

CompressedPCData

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached ogg vorbis data.

CompressedPS3Data

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached cooked PS3 data to speed up iteration times.

CompressedXbox360Data

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached cooked Xbox 360 data to speed up iteration times.

DecompressionType

Type: EDecompressionType

Modifiers: transient, const

Type of buffer this wave uses. Set once on load

PCMData

Type: array<byte>

Modifiers: transient, const

Where the compressed vorbis data is decompressed to

RawData

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

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

RawPCMData

Type: pointer{SWORD}

Modifiers: native, const

Pointer to 16 bit PCM data - used to preview sounds

ResourceData

Type: pointer{void}

Modifiers: native, const

Memory containing the data copied from the compressed bulk data

ResourceID

Type: int

Modifiers: transient, const

Resource index to cross reference with buffers

ResourceSize

Type: int

Modifiers: transient, const

Size of resource copied from the bulk data

SampleDataSize

Type: int

Modifiers: const

Cached sample data size for tracking stats

VorbisDecompressor

Type: pointer{FAsyncVorbisDecompress}

Modifiers: native, const

Async worker that decompresses the vorbis data on a different thread

Enums

EDecompressionType

DTYPE_Setup 

DTYPE_Invalid 

DTYPE_Preview 

DTYPE_Native 

DTYPE_RealTime 

ETTSSpeaker

TTSSPEAKER_Paul 

TTSSPEAKER_Harry 

TTSSPEAKER_Frank 

TTSSPEAKER_Dennis 

TTSSPEAKER_Kit 

TTSSPEAKER_Betty 

TTSSPEAKER_Ursula 

TTSSPEAKER_Rita 

TTSSPEAKER_Wendy 

Structs

SubtitleCue

Modifiers: native

A line of subtitle text and the time at which it should be displayed.

string Text 

The text too appear in the subtitle.

float Time 

The time at which the subtitle is to be displayed, in seconds relative to the beginning of the line.