I'm a doctor, not a mechanic
UE3:AudioDevice (UT3)
Contents
- 1 Properties
- 1.1 Property group 'AudioDevice'
- 1.2 Internal variables
- 1.2.1 AudioComponents
- 1.2.2 bGameWasTicking
- 1.2.3 bTestEQFilter
- 1.2.4 bTestLowPassFilter
- 1.2.5 CurrentMode
- 1.2.6 CurrentSoundGroups
- 1.2.7 CurrentTick
- 1.2.8 DestinationSoundGroups
- 1.2.9 Effects
- 1.2.10 FreeSources
- 1.2.11 Listeners
- 1.2.12 MaxChannels
- 1.2.13 NameToSoundGroupIndexMap
- 1.2.14 SoundModeEndTime
- 1.2.15 SoundModeStartTime
- 1.2.16 Sources
- 1.2.17 SourceSoundGroups
- 1.2.18 TextToSpeech
- 1.2.19 TransientMasterVolume
- 1.2.20 UseEffectsProcessing
- 1.2.21 WaveInstanceSourceMap
- 2 Enums
- 3 Structs
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. |
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
Properties
Property group 'AudioDevice'
SoundGroupEffects
Type: array<SoundGroupEffect>
Modifiers: config
Array of presets that modify sound groups
Default value, index 1:
Member | Value | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GroupEffect |
|
SoundGroups
Type: array<SoundGroup>
Modifiers: config
Array of sound groups read from ini file
Default value, index 0:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Ambient' | ||||||
Properties |
|
Default value, index 1:
Member | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GroupName | 'Announcer' | ||||||||||
Properties |
|
Default value, index 2:
Member | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GroupName | 'Briefing' | ||||||||||
Properties |
|
Default value, index 3:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Character' | ||||||
Properties |
|
Default value, index 4:
Member | Value | ||||||||
---|---|---|---|---|---|---|---|---|---|
GroupName | 'Cinematic' | ||||||||
Properties |
|
Default value, index 5:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'CinematicDialog' | ||||||
Properties |
|
Default value, index 6:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
ChildGroupNames |
|
||||||
GroupName | 'Dialog' | ||||||
Properties |
|
Default value, index 7:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Item' | ||||||
Properties |
|
Default value, index 8:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
ChildGroupNames |
|
||||||
GroupName | 'Master' | ||||||
Properties |
|
Default value, index 9:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'MovieEffects' | ||||||
Properties |
|
Default value, index 10:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'MovieVoice' | ||||||
Properties |
|
Default value, index 11:
Member | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GroupName | 'Music' | ||||||||||
Properties |
|
Default value, index 12:
Member | Value | ||||||||
---|---|---|---|---|---|---|---|---|---|
ChildGroupNames |
|
||||||||
GroupName | 'SFX' | ||||||||
Properties |
|
Default value, index 13:
Member | Value | ||||||||
---|---|---|---|---|---|---|---|---|---|
GroupName | 'Stinger' | ||||||||
Properties |
|
Default value, index 14:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'StoryDialog' | ||||||
Properties |
|
Default value, index 15:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Taunts' | ||||||
Properties |
|
Default value, index 16:
Member | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GroupName | 'UI' | ||||||||||
Properties |
|
Default value, index 17:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Vehicle' | ||||||
Properties |
|
Default value, index 18:
Member | Value | ||||||||
---|---|---|---|---|---|---|---|---|---|
GroupName | 'VoiceChat' | ||||||||
Properties |
|
Default value, index 19:
Member | Value | ||||||
---|---|---|---|---|---|---|---|
GroupName | 'Weapon' | ||||||
Properties |
|
Internal variables
AudioComponents
Type: array<AudioComponent>
Modifiers: transient, const
bGameWasTicking
Type: bool
Modifiers: native, const
bTestEQFilter
Type: bool
Modifiers: native, const
bTestLowPassFilter
Type: bool
Modifiers: native, const
CurrentMode
Type: ESoundMode
Modifiers: native, const
CurrentSoundGroups
Type: array<SoundGroup>
Modifiers: native, const
The current state of sound group constants
CurrentTick
Type: Object.qword
Modifiers: native, const
DestinationSoundGroups
Type: array<SoundGroup>
Modifiers: native, const
The sound group constants that we are interpolating to
Effects
Type: pointer{class FAudioEffectsManager}
Modifiers: native, const
Interface to audio effects processing
FreeSources
Type: array<pointer{FSoundSource}>
Modifiers: native, const
Listeners
Modifiers: native, const
MaxChannels
Type: int
Modifiers: config, const
NameToSoundGroupIndexMap
Type: Object.Map_Mirror{TMap<FName, INT>}
Modifiers: native, const
Map from name to the sound group index - used to index the following 4 arrays
SoundModeEndTime
Type: Object.double
Modifiers: native, const
SoundModeStartTime
Type: Object.double
Modifiers: native, const
Sources
Type: array<pointer{FSoundSource}>
Modifiers: native, const
SourceSoundGroups
Type: array<SoundGroup>
Modifiers: native, const
The sound group constants that we are interpolating from
TextToSpeech
Type: pointer{class FTextToSpeech}
Modifiers: native, const
Interface to text to speech processor
TransientMasterVolume
Type: float
Modifiers: transient
transient master volume multiplier that can be modified at runtime without affecting user settings automatically reset to 1.0 on level change
UseEffectsProcessing
Type: bool
Modifiers: config, const
WaveInstanceSourceMap
Type: Object.DynamicMap_Mirror{TDynamicMap<FWaveInstance*, FSoundSource*>}
Modifiers: native, const
Enums
ESoundMode
Enum describing the sound modes available for use in game.
- SOUNDMODE_NORMAL
- Normal - No EQ applied
- SOUNDMODE_SLOWMOTION
- Slowmo
- SOUNDMODE_DEATH
- Death - Death EQ applied
- SOUNDMODE_COVER
- Cover - EQ applied to indicate player is in cover
- SOUNDMODE_ROADIE_RUN
- Roadie Run - Accentuates high-pitched bullet whips, etc.
- SOUNDMODE_TACCOM
- TacCom - Tactical command EQ lowers game volumes
- SOUNDMODE_RADIO
- Applied to the radio effect
Structs
Listener
Modifiers: native
- PortalVolume PortalVolume
- Object.Vector Location
- Object.Vector Up
- Object.Vector Right
- Object.Vector Front
ModeSettings
Modifiers: native
Structure defining a sound mode (used for EQ and volume ducking)
- ESoundMode Mode
- float FadeTime
Default values:
Property | Value |
---|---|
FadeTime | 0.1 |
Mode | SOUNDMODE_NORMAL |
SoundGroup
Modifiers: native
Structure containing information about a sound group.
- SoundGroupProperties Properties
- Configurable properties like volume and priority.
- name GroupName
- Name of this sound group.
- array<name> ChildGroupNames
- Array of names of child sound groups. Empty for leaf groups.
SoundGroupAdjuster
Modifiers: native
Elements of data for sound group volume control
Default values:
Property | Value |
---|---|
GroupName | 'Master' |
PitchAdjuster | 1.0 |
VolumeAdjuster | 1.0 |
SoundGroupEffect
Modifiers: native
Group of adjusters
- array<SoundGroupAdjuster> GroupEffect
SoundGroupProperties
Modifiers: native
Structure containing configurable properties of a sound group.
- float Volume
- Volume multiplier.
- float Pitch
- Pitch multiplier.
- float VoiceCenterChannelVolume
- Voice center channel volume - Not a multiplier (no propagation)
- float VoiceRadioVolume
- Radio volume multiplier - Not a multiplier (no propagation)
- bool bApplyEffects
- Sound mode voice - whether to apply audio effects
- bool bAlwaysPlay
- Whether to artificially prioritise the component to play
- bool bIsUISound
- Whether or not this sound plays when the game is paused in the UI
- bool bIsMusic
- Whether or not this is music (propagates only if parent is TRUE)
- bool bNoReverb
- Whether or not this sound group is excluded from reverb EQ
Default values:
Property | Value |
---|---|
bAlwaysPlay | False |
bApplyEffects | False |
bIsMusic | False |
bIsUISound | False |
bNoReverb | False |
Pitch | 1.0 |
VoiceCenterChannelVolume | 0.0 |
VoiceRadioVolume | 0.0 |
Volume | 1.0 |