Cogito, ergo sum
UE3:SoundNodeWave (UDK)
Contents
- 1 Properties
- 1.1 Property group 'Compression'
- 1.2 Property group 'Info'
- 1.3 Property group 'Subtitles'
- 1.4 Property group 'TTS'
- 1.5 Internal variables
- 1.5.1 bDynamicResource
- 1.5.2 ChannelOffsets
- 1.5.3 ChannelSizes
- 1.5.4 CompressedPCData
- 1.5.5 CompressedPS3Data
- 1.5.6 CompressedXbox360Data
- 1.5.7 DecompressionType
- 1.5.8 LocalizedSubtitles
- 1.5.9 RawData
- 1.5.10 RawPCMData
- 1.5.11 RawPCMDataSize
- 1.5.12 ResourceData
- 1.5.13 ResourceID
- 1.5.14 ResourceSize
- 1.5.15 VorbisDecompressor
- 2 Enums
| 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.
bLoopingSound[edit]
Type: bool
If set, the compressor does everything required to make this a seamlessly looping sound
Default value: True
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.4 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]
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 to contain mature content.
Comment[edit]
Type: string
Modifiers: localized
Provides contextual information for the sound to the translator.
Subtitles[edit]
Type: array<EngineTypes.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: AudioDevice.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
ChannelOffsets[edit]
Modifiers: const
Offsets into the bulk data for the source wav data
ChannelSizes[edit]
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
LocalizedSubtitles[edit]
Type: array<EngineTypes.LocalizedSubtitle>
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[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{BYTE}
Modifiers: native, const
Pointer to 16 bit PCM data - used to decompress data to and preview sounds
RawPCMDataSize[edit]
Type: int
Modifiers: const
Size of RawPCMData, or what RawPCMData would be if the sound was fully decompressed
ResourceData[edit]
Type: pointer{BYTE}
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
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
- DTYPE_Xenon
