Difference between revisions of "UE3:SoundNodeWave (UT3)"

Revision as of 09:11, 17 May 2008 (edit) Wormbo (Talk | contribs) (Auto-generated page)		Latest revision as of 07:40, 23 May 2008 (edit) (undo) (Talk)
Line 58:		Line 58:
	Playback volume of sound 0 to 1		Playback volume of sound 0 to 1
		+
		+	'''Default value:''' 0.75
	===Property group 'Subtitles'===		===Property group 'Subtitles'===

---

Latest revision as of 07:40, 23 May 2008

Package: 

Engine

This class in other games:

UDK

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Sound node that contains sample data

Properties[edit]

Property group 'Compression'[edit]

bForceRealtimeDecompression[edit]

Type: bool

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

CompressionQuality[edit]

Type: int

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

Default value: 40

Property group 'Info'[edit]

Duration[edit]

Type: float

Modifiers: editconst, const

Duration of sound in seconds.

NumChannels[edit]

Type: int

Modifiers: editconst, const

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

Pitch[edit]

Type: float

Modifiers: editconst, const

Playback pitch for sound 0.5 to 2.0

Default value: 1.0

SampleRate[edit]

Type: int

Modifiers: editconst, const

Cached sample rate for displaying in the tools

Volume[edit]

Type: float

Modifiers: editconst, const

Playback volume of sound 0 to 1

Default value: 0.75

Property group 'Subtitles'[edit]

bAlwaysLocalise[edit]

Type: bool

Localise this sound even if there are no subtitles

bManualWordWrap[edit]

Type: bool

Modifiers: localized

TRUE if the subtitles have been split manually.

bMature[edit]

Type: bool

Modifiers: localized

TRUE if this sound is considered mature.

Comment[edit]

Type: string

Modifiers: localized

Provides contextual information for the sound to the translator.

Subtitles[edit]

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'[edit]

bUseTTS[edit]

Type: bool

Set to true to speak SpokenText using TTS

SpokenText[edit]

Type: string

Modifiers: localized

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

TTSSpeaker[edit]

Type: ETTSSpeaker

Speaker to use for TTS

Internal variables[edit]

bDynamicResource[edit]

Type: bool

Modifiers: transient, const

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

bOneTimeUse[edit]

Type: bool

Modifiers: transient, const

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

ChannelOffsets[edit]

Type: array<int>

Modifiers: const

Offsets into the bulk data for the source wav data

ChannelSizes[edit]

Type: array<int>

Modifiers: const

Sizes of the bulk data for the source wav data

CompressedPCData[edit]

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached ogg vorbis data.

CompressedPS3Data[edit]

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached cooked PS3 data to speed up iteration times.

CompressedXbox360Data[edit]

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

Cached cooked Xbox 360 data to speed up iteration times.

DecompressionType[edit]

Type: EDecompressionType

Modifiers: transient, const

Type of buffer this wave uses. Set once on load

PCMData[edit]

Type: array<byte>

Modifiers: transient, const

Where the compressed vorbis data is decompressed to

RawData[edit]

Type: Object.UntypedBulkData_Mirror{FByteBulkData}

Modifiers: native, const

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

RawPCMData[edit]

Type: pointer{SWORD}

Modifiers: native, const

Pointer to 16 bit PCM data - used to preview sounds

ResourceData[edit]

Type: pointer{void}

Modifiers: native, const

Memory containing the data copied from the compressed bulk data

ResourceID[edit]

Type: int

Modifiers: transient, const

Resource index to cross reference with buffers

ResourceSize[edit]

Type: int

Modifiers: transient, const

Size of resource copied from the bulk data

SampleDataSize[edit]

Type: int

Modifiers: const

Cached sample data size for tracking stats

VorbisDecompressor[edit]

Type: pointer{FAsyncVorbisDecompress}

Modifiers: native, const

Async worker that decompresses the vorbis data on a different thread

Enums[edit]

EDecompressionType[edit]

DTYPE_Setup 

DTYPE_Invalid 

DTYPE_Preview 

DTYPE_Native 

DTYPE_RealTime 

ETTSSpeaker[edit]

TTSSPEAKER_Paul 

TTSSPEAKER_Harry 

TTSSPEAKER_Frank 

TTSSPEAKER_Dennis 

TTSSPEAKER_Kit 

TTSSPEAKER_Betty 

TTSSPEAKER_Ursula 

TTSSPEAKER_Rita 

TTSSPEAKER_Wendy 

Structs[edit]

SubtitleCue[edit]

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.