Mostly Harmless

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
(Talk)
(One intermediate revision by one other user not shown)
Line 5: Line 5:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
==Properties==
 
==Properties==
Line 137: Line 137:
 
|}
 
|}
  
−
'''Default value, index 10:'''  
+
'''Default value, index 2:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 143: Line 143:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'MovieVoice'
+
| 'Briefing'
 
|-
 
|-
 
| Properties
 
| Properties
Line 150: Line 150:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
 +
|-
 +
| bAlwaysPlay
 +
| True
 +
|-
 +
| bIsUISound
 +
| True
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 159: Line 165:
 
|}
 
|}
  
−
'''Default value, index 11:'''  
+
'''Default value, index 3:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 165: Line 171:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Music'
+
| 'Character'
 
|-
 
|-
 
| Properties
 
| Properties
Line 172: Line 178:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
−
|-
 
−
| bAlwaysPlay
 
−
| True
 
−
|-
 
−
| bNoReverb
 
−
| True
 
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 187: Line 187:
 
|}
 
|}
  
−
'''Default value, index 12:'''  
+
'''Default value, index 4:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
−
|-
 
−
| ChildGroupNames
 
−
|
 
−
#'Character'
 
−
#'Item'
 
−
#'Stinger'
 
−
#'Vehicle'
 
−
#'Weapon'
 
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'SFX'
+
| 'Cinematic'
 
|-
 
|-
 
| Properties
 
| Properties
Line 220: Line 212:
 
|}
 
|}
  
−
'''Default value, index 13:'''  
+
'''Default value, index 5:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 226: Line 218:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Stinger'
+
| 'CinematicDialog'
 
|-
 
|-
 
| Properties
 
| Properties
Line 233: Line 225:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
−
|-
 
−
| bNoReverb
 
−
| True
 
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 245: Line 234:
 
|}
 
|}
  
−
'''Default value, index 14:'''  
+
'''Default value, index 6:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
 +
|-
 +
| ChildGroupNames
 +
|
 +
#'StoryDialog'
 +
#'CinematicDialog'
 +
#'Taunts'
 +
#'Briefing'
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'StoryDialog'
+
| 'Dialog'
 
|-
 
|-
 
| Properties
 
| Properties
Line 267: Line 263:
 
|}
 
|}
  
−
'''Default value, index 15:'''  
+
'''Default value, index 7:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 273: Line 269:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Taunts'
+
| 'Item'
 
|-
 
|-
 
| Properties
 
| Properties
Line 289: Line 285:
 
|}
 
|}
  
−
'''Default value, index 16:'''  
+
'''Default value, index 8:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
 +
|-
 +
| ChildGroupNames
 +
|
 +
#'SFX'
 +
#'Cinematic'
 +
#'Music'
 +
#'Announcer'
 +
#'VoiceChat'
 +
#'Dialog'
 +
#'MovieEffects'
 +
#'MovieVoice'
 +
#'UI'
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'UI'
+
| 'Master'
 
|-
 
|-
 
| Properties
 
| Properties
Line 302: Line 310:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
−
|-
 
−
| bIsUISound
 
−
| True
 
−
|-
 
−
| bNoReverb
 
−
| True
 
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 317: Line 319:
 
|}
 
|}
  
−
'''Default value, index 17:'''  
+
'''Default value, index 9:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 323: Line 325:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Vehicle'
+
| 'MovieEffects'
 
|-
 
|-
 
| Properties
 
| Properties
Line 339: Line 341:
 
|}
 
|}
  
−
'''Default value, index 18:'''  
+
'''Default value, index 10:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 345: Line 347:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'VoiceChat'
+
| 'MovieVoice'
 
|-
 
|-
 
| Properties
 
| Properties
Line 352: Line 354:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
−
|-
 
−
| bNoReverb
 
−
| True
 
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 364: Line 363:
 
|}
 
|}
  
−
'''Default value, index 19:'''  
+
'''Default value, index 11:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 370: Line 369:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Weapon'
+
| 'Music'
 
|-
 
|-
 
| Properties
 
| Properties
Line 377: Line 376:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
 +
|-
 +
| bAlwaysPlay
 +
| True
 +
|-
 +
| bNoReverb
 +
| True
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 386: Line 391:
 
|}
 
|}
  
−
'''Default value, index 20:'''  
+
'''Default value, index 12:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
 +
|-
 +
| ChildGroupNames
 +
|
 +
#'Character'
 +
#'Item'
 +
#'Stinger'
 +
#'Vehicle'
 +
#'Weapon'
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Briefing'
+
| 'SFX'
 
|-
 
|-
 
| Properties
 
| Properties
Line 400: Line 413:
 
! Value
 
! Value
 
|-
 
|-
−
| bAlwaysPlay
+
| bNoReverb
−
| True
+
−
|-
+
−
| bIsUISound
+
 
| True
 
| True
 
|-
 
|-
Line 414: Line 424:
 
|}
 
|}
  
−
'''Default value, index 21:'''  
+
'''Default value, index 13:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 420: Line 430:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Character'
+
| 'Stinger'
 
|-
 
|-
 
| Properties
 
| Properties
Line 427: Line 437:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
 +
|-
 +
| bNoReverb
 +
| True
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 436: Line 449:
 
|}
 
|}
  
−
'''Default value, index 22:'''  
+
'''Default value, index 14:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 442: Line 455:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Cinematic'
+
| 'StoryDialog'
 
|-
 
|-
 
| Properties
 
| Properties
Line 449: Line 462:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
−
|-
 
−
| bNoReverb
 
−
| True
 
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 461: Line 471:
 
|}
 
|}
  
−
'''Default value, index 23:'''  
+
'''Default value, index 15:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 467: Line 477:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'CinematicDialog'
+
| 'Taunts'
 
|-
 
|-
 
| Properties
 
| Properties
Line 483: Line 493:
 
|}
 
|}
  
−
'''Default value, index 24:'''  
+
'''Default value, index 16:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
−
|-
 
−
| ChildGroupNames
 
−
|
 
−
#'StoryDialog'
 
−
#'CinematicDialog'
 
−
#'Taunts'
 
−
#'Briefing'
 
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Dialog'
+
| 'UI'
 
|-
 
|-
 
| Properties
 
| Properties
Line 503: Line 506:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
 +
|-
 +
| bIsUISound
 +
| True
 +
|-
 +
| bNoReverb
 +
| True
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 512: Line 521:
 
|}
 
|}
  
−
'''Default value, index 25:'''  
+
'''Default value, index 17:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 518: Line 527:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Item'
+
| 'Vehicle'
 
|-
 
|-
 
| Properties
 
| Properties
Line 534: Line 543:
 
|}
 
|}
  
−
'''Default value, index 26:'''  
+
'''Default value, index 18:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
 
! Value
 
! Value
−
|-
 
−
| ChildGroupNames
 
−
|
 
−
#'SFX'
 
−
#'Cinematic'
 
−
#'Music'
 
−
#'Announcer'
 
−
#'VoiceChat'
 
−
#'Dialog'
 
−
#'MovieEffects'
 
−
#'MovieVoice'
 
−
#'UI'
 
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'Master'
+
| 'VoiceChat'
 
|-
 
|-
 
| Properties
 
| Properties
Line 559: Line 556:
 
! {{tl|SoundGroupProperties|||Member}}
 
! {{tl|SoundGroupProperties|||Member}}
 
! Value
 
! Value
 +
|-
 +
| bNoReverb
 +
| True
 
|-
 
|-
 
| Pitch
 
| Pitch
Line 568: Line 568:
 
|}
 
|}
  
−
'''Default value, index 27:'''  
+
'''Default value, index 19:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|SoundGroup|||Member}}
 
! {{tl|SoundGroup|||Member}}
Line 574: Line 574:
 
|-
 
|-
 
| GroupName
 
| GroupName
−
| 'MovieEffects'
+
| 'Weapon'
 
|-
 
|-
 
| Properties
 
| Properties

Revision as of 02:44, 26 July 2008

UT3 Object >> Subsystem >> AudioDevice
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.

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
Member Value
GroupName 'Weapon'
PitchAdjuster 0.4
Member Value
GroupName 'Ambient'
PitchAdjuster 0.4
Member Value
GroupName 'Character'
PitchAdjuster 0.4
Member Value
GroupName 'Item'
PitchAdjuster 0.4
Member Value
GroupName 'Vehicle'
PitchAdjuster 0.4

SoundGroups

Type: array<SoundGroup>

Modifiers: config

Array of sound groups read from ini file

Default value, index 0:

Member Value
GroupName 'Ambient'
Properties
Member Value
Pitch 1.0
Volume 0.24

Default value, index 1:

Member Value
GroupName 'Announcer'
Properties
Member Value
bAlwaysPlay True
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 2:

Member Value
GroupName 'Briefing'
Properties
Member Value
bAlwaysPlay True
bIsUISound True
Pitch 1.0
Volume 1.0

Default value, index 3:

Member Value
GroupName 'Character'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 4:

Member Value
GroupName 'Cinematic'
Properties
Member Value
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 5:

Member Value
GroupName 'CinematicDialog'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 6:

Member Value
ChildGroupNames
  1. 'StoryDialog'
  2. 'CinematicDialog'
  3. 'Taunts'
  4. 'Briefing'
GroupName 'Dialog'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 7:

Member Value
GroupName 'Item'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 8:

Member Value
ChildGroupNames
  1. 'SFX'
  2. 'Cinematic'
  3. 'Music'
  4. 'Announcer'
  5. 'VoiceChat'
  6. 'Dialog'
  7. 'MovieEffects'
  8. 'MovieVoice'
  9. 'UI'
GroupName 'Master'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 9:

Member Value
GroupName 'MovieEffects'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 10:

Member Value
GroupName 'MovieVoice'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 11:

Member Value
GroupName 'Music'
Properties
Member Value
bAlwaysPlay True
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 12:

Member Value
ChildGroupNames
  1. 'Character'
  2. 'Item'
  3. 'Stinger'
  4. 'Vehicle'
  5. 'Weapon'
GroupName 'SFX'
Properties
Member Value
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 13:

Member Value
GroupName 'Stinger'
Properties
Member Value
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 14:

Member Value
GroupName 'StoryDialog'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 15:

Member Value
GroupName 'Taunts'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 16:

Member Value
GroupName 'UI'
Properties
Member Value
bIsUISound True
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 17:

Member Value
GroupName 'Vehicle'
Properties
Member Value
Pitch 1.0
Volume 1.0

Default value, index 18:

Member Value
GroupName 'VoiceChat'
Properties
Member Value
bNoReverb True
Pitch 1.0
Volume 1.0

Default value, index 19:

Member Value
GroupName 'Weapon'
Properties
Member Value
Pitch 1.0
Volume 1.0

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

Type: array<Listener>

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

name GroupName 
float VolumeAdjuster 
float PitchAdjuster 

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
Retrieved from "https://wiki.beyondunreal.com/UE3:AudioDevice_(UT3)?oldid=32429"