MovieSceneAudioSystem.cpp File Reference

#include "Systems/MovieSceneAudioSystem.h"
#include "AudioDevice.h"
#include "Components/AudioComponent.h"
#include "Engine/Engine.h"
#include "Engine/EngineTypes.h"
#include "EntitySystem/BuiltInComponentTypes.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedObjectStorage.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStateStorage.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStorageID.inl"
#include "GameFramework/WorldSettings.h"
#include "IMovieScenePlayer.h"
#include "MovieScene.h"
#include "Decorations/MovieSceneScalingAnchors.h"
#include "Decorations/MovieSceneSectionAnchorsDecoration.h"
#include "MovieSceneTracksComponentTypes.h"
#include "Sections/MovieSceneAudioSection.h"
#include "Sound/SoundAttenuation.h"
#include "Sound/SoundCue.h"
#include "Tracks/MovieSceneAudioTrack.h"

Classes
struct	UE::MovieScene::FPreAnimatedAudioStateTraits< BaseTraits >
struct	UE::MovieScene::FPreAnimatedAudioStorage
struct	UE::MovieScene::FGatherAudioInputs
struct	UE::MovieScene::FGatherAudioTriggers
struct	UE::MovieScene::FEvaluateAudio

Namespaces
namespace	UE
namespace	UE::MovieScene

Typedefs
using	UE::MovieScene::FPreAnimatedBoundObjectAudioStateTraits = FPreAnimatedAudioStateTraits< FBoundObjectPreAnimatedStateTraits >

Enumerations
enum class	UE::MovieScene::EPreAnimatedAudioStateType { UE::MovieScene::AudioComponentLifespan , UE::MovieScene::AudioPlaying }
enum class	UE::MovieScene::EAudioEvaluationType { UE::MovieScene::Skip , UE::MovieScene::Play , UE::MovieScene::StopAndPlay , UE::MovieScene::Stop }

Functions
	DECLARE_CYCLE_STAT (TEXT("Audio System Evaluate"), MovieSceneEval_AudioTasks, STATGROUP_MovieSceneECS)

Variables
FAutoConsoleVariableRef	CVarMaxSequenceAudioDesyncTolerance (TEXT("Sequencer.Audio.MaxDesyncTolerance"), MaxSequenceAudioDesyncToleranceCVar, TEXT("Controls how many seconds an audio track can be out of sync in a Sequence before we attempt a time correction.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarIgnoreAudioSyncDuringWorldTimeDilation (TEXT("Sequencer.Audio.IgnoreAudioSyncDuringWorldTimeDilation"), bIgnoreAudioSyncDuringWorldTimeDilationCVar, TEXT("Ignore correcting audio if there is world time dilation.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVaUseAudioClockForSequencerDesync (TEXT("Sequencer.Audio.UseAudioClockForAudioDesync"), UseAudioClockForSequencerDesyncCVar, TEXT("When set to 1, we will use the audio render thread directly to query whether audio has went out of sync with the sequence.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarPlayAudioWhenPlaybackJumps (TEXT("Sequencer.Audio.PlayAudioWhenPlaybackJumps"), bPlayAudioWhenPlaybackJumps, TEXT("Play audio when playback jumps.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarUseTimeDilationToAdjustPlayDuration (TEXT("Sequencer.Audio.UseTimeDilationToAdjustPlayDuration"), bUseTimeDilationToAdjustPlayDurationCVar, TEXT("Use the effective time dilation to scale the current time of audio.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarScrubWidthMilliseconds (TEXT("Sequencer.Audio.ScrubWidthMilliseconds"), ScrubWidthMillisecondsCVar, TEXT("The time-width of grains (in milliseconds) while scrubbing an audio track.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarEnableGranularScrubbing (TEXT("Sequencer.Audio.EnableGranularScrubbing"), bEnableGranularScrubbingCVar, TEXT("Whether or not to use granular scrubbing.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarEnableGranularScrubbingWhileStationary (TEXT("Sequencer.Audio.EnableGranularScrubbingWhileStationary"), bEnableGranularScrubbingWhileStationaryCVar, TEXT("Whether or not to use granular scrubbing while holding the playhead still.\n"), ECVF_Default)

Function Documentation

DECLARE_CYCLE_STAT()

DECLARE_CYCLE_STAT	(	TEXT("Audio System Evaluate")	,
		MovieSceneEval_AudioTasks	,
		STATGROUP_MovieSceneECS
	)

Variable Documentation

CVarEnableGranularScrubbing

FAutoConsoleVariableRef CVarEnableGranularScrubbing(TEXT("Sequencer.Audio.EnableGranularScrubbing"), bEnableGranularScrubbingCVar, TEXT("Whether or not to use granular scrubbing.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.EnableGranularScrubbing")	,
		bEnableGranularScrubbingCVar	,
		TEXT("Whether or not to use granular scrubbing.\n")	,
		ECVF_Default
	)

CVarEnableGranularScrubbingWhileStationary

FAutoConsoleVariableRef CVarEnableGranularScrubbingWhileStationary(TEXT("Sequencer.Audio.EnableGranularScrubbingWhileStationary"), bEnableGranularScrubbingWhileStationaryCVar, TEXT("Whether or not to use granular scrubbing while holding the playhead still.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.EnableGranularScrubbingWhileStationary")	,
		bEnableGranularScrubbingWhileStationaryCVar	,
		TEXT("Whether or not to use granular scrubbing while holding the playhead still.\n")	,
		ECVF_Default
	)

CVarIgnoreAudioSyncDuringWorldTimeDilation

FAutoConsoleVariableRef CVarIgnoreAudioSyncDuringWorldTimeDilation(TEXT("Sequencer.Audio.IgnoreAudioSyncDuringWorldTimeDilation"), bIgnoreAudioSyncDuringWorldTimeDilationCVar, TEXT("Ignore correcting audio if there is world time dilation.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.IgnoreAudioSyncDuringWorldTimeDilation")	,
		bIgnoreAudioSyncDuringWorldTimeDilationCVar	,
		TEXT("Ignore correcting audio if there is world time dilation.\n")	,
		ECVF_Default
	)

CVarMaxSequenceAudioDesyncTolerance

FAutoConsoleVariableRef CVarMaxSequenceAudioDesyncTolerance(TEXT("Sequencer.Audio.MaxDesyncTolerance"), MaxSequenceAudioDesyncToleranceCVar, TEXT("Controls how many seconds an audio track can be out of sync in a Sequence before we attempt a time correction.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.MaxDesyncTolerance")	,
		MaxSequenceAudioDesyncToleranceCVar	,
		TEXT("Controls how many seconds an audio track can be out of sync in a Sequence before we attempt a time correction.\n")	,
		ECVF_Default
	)

CVarPlayAudioWhenPlaybackJumps

FAutoConsoleVariableRef CVarPlayAudioWhenPlaybackJumps(TEXT("Sequencer.Audio.PlayAudioWhenPlaybackJumps"), bPlayAudioWhenPlaybackJumps, TEXT("Play audio when playback jumps.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.PlayAudioWhenPlaybackJumps")	,
		bPlayAudioWhenPlaybackJumps	,
		TEXT("Play audio when playback jumps.\n")	,
		ECVF_Default
	)

CVarScrubWidthMilliseconds

FAutoConsoleVariableRef CVarScrubWidthMilliseconds(TEXT("Sequencer.Audio.ScrubWidthMilliseconds"), ScrubWidthMillisecondsCVar, TEXT("The time-width of grains (in milliseconds) while scrubbing an audio track.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.ScrubWidthMilliseconds")	,
		ScrubWidthMillisecondsCVar	,
		TEXT("The time-width of grains (in milliseconds) while scrubbing an audio track.\n")	,
		ECVF_Default
	)

CVarUseTimeDilationToAdjustPlayDuration

FAutoConsoleVariableRef CVarUseTimeDilationToAdjustPlayDuration(TEXT("Sequencer.Audio.UseTimeDilationToAdjustPlayDuration"), bUseTimeDilationToAdjustPlayDurationCVar, TEXT("Use the effective time dilation to scale the current time of audio.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.UseTimeDilationToAdjustPlayDuration")	,
		bUseTimeDilationToAdjustPlayDurationCVar	,
		TEXT("Use the effective time dilation to scale the current time of audio.\n")	,
		ECVF_Default
	)

CVaUseAudioClockForSequencerDesync

FAutoConsoleVariableRef CVaUseAudioClockForSequencerDesync(TEXT("Sequencer.Audio.UseAudioClockForAudioDesync"), UseAudioClockForSequencerDesyncCVar, TEXT("When set to 1, we will use the audio render thread directly to query whether audio has went out of sync with the sequence.\n"), ECVF_Default)	(	TEXT("Sequencer.Audio.UseAudioClockForAudioDesync")	,
		UseAudioClockForSequencerDesyncCVar	,
		TEXT("When set to 1, we will use the audio render thread directly to query whether audio has went out of sync with the sequence.\n")	,
		ECVF_Default
	)