I'm a doctor, not a mechanic
UE3:SoundNodeWave (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
| This is an auto-generated page and may need human attention. Please remove this 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
[edit] Properties
[edit] Property group 'Compression'
[edit] bForceRealtimeDecompression
Type: bool
If set, forces wave data to be decompressed during playback instead of upfront on platforms that have a choice.
[edit] CompressionQuality
Type: int
Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality
Default value: 40
[edit] Property group 'Info'
[edit] Duration
Type: float
Modifiers: editconst, const
Duration of sound in seconds.
[edit] NumChannels
Type: int
Modifiers: editconst, const
Number of channels of multichannel data; 1 or 2 for regular mono and stereo files
[edit] Pitch
Type: float
Modifiers: editconst, const
Playback pitch for sound 0.5 to 2.0
Default value: 1.0
[edit] SampleRate
Type: int
Modifiers: editconst, const
Cached sample rate for displaying in the tools
[edit] Volume
Type: float
Modifiers: editconst, const
Playback volume of sound 0 to 1
Default value: 0.75
[edit] Property group 'Subtitles'
[edit] bAlwaysLocalise
Type: bool
Localise this sound even if there are no subtitles
[edit] bManualWordWrap
Type: bool
Modifiers: localized
TRUE if the subtitles have been split manually.
[edit] bMature
Type: bool
Modifiers: localized
TRUE if this sound is considered mature.
[edit] Comment
Type: string
Modifiers: localized
Provides contextual information for the sound to the translator.
[edit] 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.
[edit] Property group 'TTS'
[edit] bUseTTS
Type: bool
Set to true to speak SpokenText using TTS
[edit] SpokenText
Type: string
Modifiers: localized
A localized version of the text that is actually spoken in the audio.
[edit] TTSSpeaker
Type: ETTSSpeaker
Speaker to use for TTS
[edit] Internal variables
[edit] bDynamicResource
Type: bool
Modifiers: transient, const
Whether to free the resource data after it has been uploaded to the hardware
[edit] bOneTimeUse
Type: bool
Modifiers: transient, const
Whether to free this resource after it has played - designed for TTS of log
[edit] ChannelOffsets
Modifiers: const
Offsets into the bulk data for the source wav data
[edit] ChannelSizes
Modifiers: const
Sizes of the bulk data for the source wav data
[edit] CompressedPCData
Type: Object.UntypedBulkData_Mirror{FByteBulkData}
Modifiers: native, const
Cached ogg vorbis data.
[edit] CompressedPS3Data
Type: Object.UntypedBulkData_Mirror{FByteBulkData}
Modifiers: native, const
Cached cooked PS3 data to speed up iteration times.
[edit] CompressedXbox360Data
Type: Object.UntypedBulkData_Mirror{FByteBulkData}
Modifiers: native, const
Cached cooked Xbox 360 data to speed up iteration times.
[edit] DecompressionType
Type: EDecompressionType
Modifiers: transient, const
Type of buffer this wave uses. Set once on load
[edit] PCMData
Modifiers: transient, const
Where the compressed vorbis data is decompressed to
[edit] RawData
Type: Object.UntypedBulkData_Mirror{FByteBulkData}
Modifiers: native, const
Uncompressed wav data 16 bit in mono or stereo - stereo not allowed for multichannel data
[edit] RawPCMData
Type: pointer{SWORD}
Modifiers: native, const
Pointer to 16 bit PCM data - used to preview sounds
[edit] ResourceData
Type: pointer{void}
Modifiers: native, const
Memory containing the data copied from the compressed bulk data
[edit] ResourceID
Type: int
Modifiers: transient, const
Resource index to cross reference with buffers
[edit] ResourceSize
Type: int
Modifiers: transient, const
Size of resource copied from the bulk data
[edit] SampleDataSize
Type: int
Modifiers: const
Cached sample data size for tracking stats
[edit] VorbisDecompressor
Type: pointer{FAsyncVorbisDecompress}
Modifiers: native, const
Async worker that decompresses the vorbis data on a different thread
[edit] Enums
[edit] EDecompressionType
- DTYPE_Setup
- DTYPE_Invalid
- DTYPE_Preview
- DTYPE_Native
- DTYPE_RealTime
[edit] ETTSSpeaker
- TTSSPEAKER_Paul
- TTSSPEAKER_Harry
- TTSSPEAKER_Frank
- TTSSPEAKER_Dennis
- TTSSPEAKER_Kit
- TTSSPEAKER_Betty
- TTSSPEAKER_Ursula
- TTSSPEAKER_Rita
- TTSSPEAKER_Wendy
[edit] Structs
[edit] SubtitleCue
Modifiers: native
A line of subtitle text and the time at which it should be displayed.
