Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.SoundNodeWave

Extends
SoundNode
Modifiers
PerObjectConfig native ( SoundNode ) hidecategories ( Object ) editinlinenew

Sound node that contains sample data

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

Constants Summary
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
boolbDynamicResource
boolbOneTimeUse
array<int>ChannelOffsets
array<int>ChannelSizes
UntypedBulkData_MirrorCompressedPCData
UntypedBulkData_MirrorCompressedPS3Data
UntypedBulkData_MirrorCompressedXbox360Data
EDecompressionTypeDecompressionType
array<byte>PCMData
UntypedBulkData_MirrorRawData
pointerRawPCMData
pointerResourceData
intResourceID
intResourceSize
intSampleDataSize
pointerVorbisDecompressor
Compression
int100isbestquality>
boolbForceRealtimeDecompression
intCompressionQuality
Info
floatDuration
intNumChannels
floatPitch
intSampleRate
floatVolume
Subtitles
boolbAlwaysLocalise
boolbManualWordWrap
boolbMature
stringComment
array<SubtitleCue>Subtitles
TTS
boolbUseTTS
stringSpokenText
ETTSSpeakerTTSSpeaker
Inherited Variables from Engine.SoundNode
ChildNodes, NodeUpdateHint
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
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,
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
SubtitleCue
Text, Time
Inherited Structures from Core.Object
Box, BoxSphereBounds, Color, Cylinder, double, DynamicMap_Mirror, Guid, IndirectArray_Mirror, InterpCurveFloat, InterpCurvePointFloat, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, Rotator, TextureMipBulkData_Mirror, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClassIsChildOf, ClearConfig, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, Exp, FClamp, FCubicInterp, FindDeltaAngle, FindObject, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetDotDistance, GetEnum, GetFuncName, GetHeadingAngle, GetNetFuncName, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetSpecialValue, GetStateName, GetUnAxes, GotoState, InStr, IsA, IsChildState, IsInState, IsNetScript, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, OrthoRotation, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointInBox, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, SaveConfig, SClampRotAxis, ScriptTrace, SetSpecialValue, SetUTracing, Sin, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=


Variables Detail

bDynamicResource Source code

var transient const bool bDynamicResource;
Whether to free the resource data after it has been uploaded to the hardware

bOneTimeUse Source code

var transient const bool bOneTimeUse;
Whether to free this resource after it has played - designed for TTS of log

ChannelOffsets Source code

var const array<int> ChannelOffsets;
Offsets into the bulk data for the source wav data

ChannelSizes Source code

var const array<int> ChannelSizes;
Sizes of the bulk data for the source wav data

CompressedPCData Source code

var native const UntypedBulkData_Mirror CompressedPCData;
Cached ogg vorbis data.

CompressedPS3Data Source code

var native const UntypedBulkData_Mirror CompressedPS3Data;
Cached cooked PS3 data to speed up iteration times.

CompressedXbox360Data Source code

var native const UntypedBulkData_Mirror CompressedXbox360Data;
Cached cooked Xbox 360 data to speed up iteration times.

DecompressionType Source code

var transient const EDecompressionType DecompressionType;
Type of buffer this wave uses. Set once on load

PCMData Source code

var transient const array<byte> PCMData;
Where the compressed vorbis data is decompressed to

RawData Source code

var native const UntypedBulkData_Mirror RawData;
Uncompressed wav data 16 bit in mono or stereo - stereo not allowed for multichannel data

RawPCMData Source code

var native const pointer RawPCMData;
Pointer to 16 bit PCM data - used to preview sounds

ResourceData Source code

var native const pointer ResourceData;
Memory containing the data copied from the compressed bulk data

ResourceID Source code

var transient const int ResourceID;
Resource index to cross reference with buffers

ResourceSize Source code

var transient const int ResourceSize;
Size of resource copied from the bulk data

SampleDataSize Source code

var const int SampleDataSize;
Cached sample data size for tracking stats

VorbisDecompressor Source code

var native const pointer VorbisDecompressor;
Async worker that decompresses the vorbis data on a different thread

Compression

100isbestquality> Source code

var(Compression) int 100isbestquality>;
Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality

bForceRealtimeDecompression Source code

var(Compression) bool bForceRealtimeDecompression;
If set, forces wave data to be decompressed during playback instead of upfront on platforms that have a choice.

CompressionQualitySource code

var(Compression) int CompressionQuality<Tooltip=1smallestsize;
Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality

Info

Duration Source code

var(Info) editconst const float Duration;
Duration of sound in seconds.

NumChannels Source code

var(Info) editconst const int NumChannels;
Number of channels of multichannel data; 1 or 2 for regular mono and stereo files

Pitch Source code

var(Info) editconst const float Pitch;
Playback pitch for sound 0.5 to 2.0

SampleRate Source code

var(Info) editconst const int SampleRate;
Cached sample rate for displaying in the tools

Volume Source code

var(Info) editconst const float Volume;
Playback volume of sound 0 to 1

Subtitles

bAlwaysLocalise Source code

var(Subtitles) bool bAlwaysLocalise;

bManualWordWrap Source code

var(Subtitles) localized bool bManualWordWrap;
TRUE if the subtitles have been split manually.

bMature Source code

var(Subtitles) localized bool bMature;
TRUE if this sound is considered mature.

Comment Source code

var(Subtitles) localized string Comment;
Provides contextual information for the sound to the translator.

Subtitles Source code

var(Subtitles) localized array<SubtitleCue> Subtitles;
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

var(TTS) bool bUseTTS;
Set to true to speak SpokenText using TTS

SpokenText Source code

var(TTS) localized string SpokenText;
A localized version of the text that is actually spoken in the audio.

TTSSpeaker Source code

var(TTS) ETTSSpeaker TTSSpeaker;
Speaker to use for TTS


Enumerations Detail

EDecompressionType Source code

enum EDecompressionType
{
DTYPE_Setup, DTYPE_Invalid, DTYPE_Preview, DTYPE_Native, DTYPE_RealTime
};

ETTSSpeaker Source code

enum ETTSSpeaker
{
TTSSPEAKER_Paul, TTSSPEAKER_Harry, TTSSPEAKER_Frank, TTSSPEAKER_Dennis, TTSSPEAKER_Kit, TTSSPEAKER_Betty, TTSSPEAKER_Ursula, TTSSPEAKER_Rita, TTSSPEAKER_Wendy,
};


Structures Detail

SubtitleCue Source code

struct SubtitleCue
{
var(SoundNodeWave) localized string Text;
var(SoundNodeWave) localized float Time;
};
A line of subtitle text and the time at which it should be displayed.
Text:
The text too appear in the subtitle.
Time:
The time at which the subtitle is to be displayed, in seconds relative to the beginning of the line.


Defaultproperties

defaultproperties
{
   CompressionQuality=40
   Volume=0.750000
   Pitch=1.000000
   Name="Default__SoundNodeWave"
   ObjectArchetype=SoundNode'Engine.Default__SoundNode'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:44.572 - Created with UnCodeX