CriWare Unreal Engine
Plug-ins for CriWare solutions.
読み取り中…
検索中…
一致する文字列を見つけられません
UAtomBus クラス

#include <AtomBus.h>

UAtomBus の継承関係図

公開メンバ関数

CRIWARECORE_API UAtomBus (const FObjectInitializer &ObjectInitializer)
CRIWARECORE_API void AddEnvelopeFollowerDelegate (const UObject *WorldContextObject, const FOnAtomBusEnvelopeBP &OnAtomBusEnvelopeBP)
CRIWARECORE_API void AddSpectralAnalysisDelegate (const UObject *WorldContextObject, const TArray< FAtomBusSpectralAnalysisBandSettings > &InBandSettings, const FOnAtomBusSpectralAnalysisBP &OnAtomBusSpectralAnalysisBP, float UpdateRate=10.f, float DecibelNoiseFloor=-40.f, bool bDoNormalize=true, bool bDoAutoRange=false, float AutoRangeAttackTime=0.1f, float AutoRangeReleaseTime=60.f)
CRIWARECORE_API int32 FindEffectPreset (UAtomBusEffectPreset *InEffectPreset) const
CRIWARECORE_API float GetBusDryLevel () const
FORCEINLINE const FStringGetBusName () const
CRIWARECORE_API float GetBusOutputVolume (const UObject *WorldContextObject) const
CRIWARECORE_API float GetBusWetLevel () const
CRIWARECORE_API float GetChannelLevel (EAtomSpeaker InChannel, EAtomSpeaker OutChannel)
CRIWARECORE_API UAtomBusEffectPresetGetEffectPreset (int32 InEffectIndex)
CRIWARECORE_API int32 GetNumEffectPresets ()
CRIWARECORE_API FAtomPanning GetPanning () const
CRIWARECORE_API UAtomRackBaseGetRack () const
CRIWARECORE_API float GetSendLevel (int SendIndex)
void Init (const FString &InBusName, int InBusIndex)
CRIWARECORE_API bool IsMainBus () const
virtual CRIWARECORE_API void PostInitProperties () override
CRIWARECORE_API bool RemoveEffectPreset (UAtomBusEffectPreset *InEffectPreset)
CRIWARECORE_API void RemoveSpectralAnalysisDelegate (const UObject *WorldContextObject, const FOnAtomBusSpectralAnalysisBP &OnAtomBusSpectralAnalysisBP)
CRIWARECORE_API void Reset (bool bApplyToAtom=true)
CRIWARECORE_API void ResetChannelLevelMatrix ()
CRIWARECORE_API void SetBusDryLevel (const UObject *WorldContextObject, float InDryLevel)
CRIWARECORE_API void SetBusOutputVolume (const UObject *WorldContextObject, float InOutputVolume)
CRIWARECORE_API void SetBusWetLevel (const UObject *WorldContextObject, float InWetLevel)
CRIWARECORE_API void SetChannelLevel (EAtomSpeaker InChannel, EAtomSpeaker OutChannel, float Level)
CRIWARECORE_API bool SetDefaultEffectPreset (int32 InEffectIndex)
CRIWARECORE_API bool SetEffectPreset (UAtomBusEffectPreset *InEffectPreset)
CRIWARECORE_API void SetPanning (const FAtomPanning &PanningSetting)
CRIWARECORE_API void SetSendLevel (int SendIndex, float Level)
CRIWARECORE_API void StartEnvelopeFollowing (const UObject *WorldContextObject)
CRIWARECORE_API void StartEnvelopeFollowing (FAtomRuntime *InAtomRuntime)
CRIWARECORE_API void StartSpectralAnalysis (const UObject *WorldContextObject, EAtomFFTSize FFTSize=EAtomFFTSize::DefaultSize, EAtomFFTPeakInterpolationMethod InterpolationMethod=EAtomFFTPeakInterpolationMethod::Linear, EAtomFFTWindowType WindowType=EAtomFFTWindowType::Hann, float HopSize=0, EAtomSpectrumType SpectrumType=EAtomSpectrumType::MagnitudeSpectrum)
CRIWARECORE_API void StartSpectralAnalysis (FAtomRuntime *InAtomRuntime, EAtomFFTSize FFTSize=EAtomFFTSize::DefaultSize, EAtomFFTPeakInterpolationMethod InterpolationMethod=EAtomFFTPeakInterpolationMethod::Linear, EAtomFFTWindowType WindowType=EAtomFFTWindowType::Hann, float HopSize=0, EAtomSpectrumType SpectrumType=EAtomSpectrumType::MagnitudeSpectrum)
CRIWARECORE_API void StopEnvelopeFollowing (const UObject *WorldContextObject)
CRIWARECORE_API void StopEnvelopeFollowing (FAtomRuntime *InAtomRuntime)
CRIWARECORE_API void StopSpectralAnalysis (const UObject *WorldContextObject)
CRIWARECORE_API void StopSpectralAnalysis (FAtomRuntime *InAtomRuntime)

静的公開メンバ関数

static CRIWARECORE_API FAtomSoundSpectrumAnalyzerDelegateSettings GetSpectrumAnalysisDelegateSettings (const TArray< FAtomBusSpectralAnalysisBandSettings > &InBandSettings, float UpdateRate, float DecibelNoiseFloor, bool bDoNormalize, bool bDoAutoRange, float AutoRangeAttackTime, float AutoRangeReleaseTime)
static CRIWARECORE_API FAtomSoundSpectrumAnalyzerSettings GetSpectrumAnalyzerSettings (EAtomFFTSize FFTSize, EAtomFFTPeakInterpolationMethod InterpolationMethod, EAtomFFTWindowType WindowType, float HopSize, EAtomSpectrumType SpectrumType)

公開変数類

bool bOverrideEndpoint = false
FAtomChannelLevelMatrix ChannelLevelMatrix
FAtomSoundModulationSettings DryLevelModulation
TObjectPtr< UAtomEndpointBaseEndpoint = nullptr
int32 EnvelopeFollowerAttackTime
int32 EnvelopeFollowerReleaseTime
FAtomSoundModulationSettings OutputVolumeModulation
TArray< FAtomBusSendSends
EAtomSpatializationType SpatializationType
FAtomSoundModulationSettings WetLevelModulation

限定公開メンバ関数

int AddEffect (const FName &InEffectName, bool bIsBypassed, bool bUseRuntimeValues)
void ApplyAll () const
void ApplyChannelLevelMatrix () const
void ApplyEffectBypass (const UAtomBusEffectPreset *EffectPreset) const
void ApplyEffectParameter (const UAtomBusEffectPreset *EffectPreset, int ParameterIndex) const
void ApplyEffectPreset (const UAtomBusEffectPreset *EffectPreset) const
void ApplyEndpoint (const UAtomEndpointBase *Endpoint) const
void ApplyPanning () const
void ApplySendLevel (const FAtomBusSend &InSend) const
void ApplyVolume (const UObject *WorldContextObject, float InOutputVolume) const
void PushModulationChanges ()
void ResetEffectChain (bool bUseRuntimeDefaults=false)
void ResetSends ()
void SetDryVolumeModulation (const FAtomSoundModulationSettings &InVolMod)
void SetOutputVolumeModulation (const FAtomSoundModulationSettings &InVolMod)
void SetWetVolumeModulation (const FAtomSoundModulationSettings &InVolMod)
void SyncAll ()

限定公開変数類

TArray< TObjectPtr< UAtomBusEffectPreset > > BusEffectChain
TArray< TSubclassOf< UAtomBusEffectPreset > > BusEffectChainClasses
FString BusName
FAtomPanning Panning

非公開メンバ関数

FORCEINLINE int GetBusIndex () const

非公開変数類

int BusIndex = INDEX_NONE

フレンド

class Atom::FAtomExPlayback
class Atom::FMixerSubmix
class FAtomRuntime
class UAtomBusEffectPreset
class UAtomRack
class UAtomRackWithParentBase

構築子と解体子

◆ UAtomBus()

UAtomBus::UAtomBus ( const FObjectInitializer & ObjectInitializer)

関数詳解

◆ AddEffect()

int UAtomBus::AddEffect ( const FName & InEffectName,
bool bIsBypassed,
bool bUseRuntimeValues )
protected

Add an effect slot based on its name.

◆ AddEnvelopeFollowerDelegate()

void UAtomBus::AddEnvelopeFollowerDelegate ( const UObject * WorldContextObject,
const FOnAtomBusEnvelopeBP & OnAtomBusEnvelopeBP )

Adds an envelope follower delegate to the Atom bus when envelope following is enabled on this DSP bus.

引数
OnAtomBusEnvelopeBPEvent to fire when new envelope data is available.

◆ AddSpectralAnalysisDelegate()

void UAtomBus::AddSpectralAnalysisDelegate ( const UObject * WorldContextObject,
const TArray< FAtomBusSpectralAnalysisBandSettings > & InBandSettings,
const FOnAtomBusSpectralAnalysisBP & OnAtomBusSpectralAnalysisBP,
float UpdateRate = 10.f,
float DecibelNoiseFloor = -40.f,
bool bDoNormalize = true,
bool bDoAutoRange = false,
float AutoRangeAttackTime = 0.1f,
float AutoRangeReleaseTime = 60.f )

Adds a spectral analysis delegate to receive notifications when this Atom bus has spectrum analysis enabled.

引数
InBandsettingsThe frequency bands to analyze and their envelope-following settings.
OnAtomBusSpectralAnalysisBPEvent to fire when new spectral data is available.
UpdateRateHow often to retrieve the data from the spectral analyzer and broadcast the event. Max is 30 times per second.
InterpMethodMethod to used for band peak calculation.
SpectrumTypeMetric to use when returning spectrum values.
DecibelNoiseFloorDecibel Noise Floor to consider as silence when using a Decibel Spectrum Type.
bDoNormalizeIf true, output band values will be normalized between zero and one.
bDoAutoRangeIf true, output band values will have their ranges automatically adjusted to the minimum and maximum values in the audio. Output band values will be normalized between zero and one.
AutoRangeAttackTimeThe time (in seconds) it takes for the range to expand to 90% of a larger range.
AutoRangeReleaseTimeThe time (in seconds) it takes for the range to shrink to 90% of a smaller range.

◆ ApplyAll()

void UAtomBus::ApplyAll ( ) const
protected

Sync the native bus with all current settings from this AtomBus.

◆ ApplyChannelLevelMatrix()

void UAtomBus::ApplyChannelLevelMatrix ( ) const
protected

Sync the native bus with current level matrix.

◆ ApplyEffectBypass()

void UAtomBus::ApplyEffectBypass ( const UAtomBusEffectPreset * EffectPreset) const
protected

Sync the native bus effect bypass with given value.

◆ ApplyEffectParameter()

void UAtomBus::ApplyEffectParameter ( const UAtomBusEffectPreset * EffectPreset,
int ParameterIndex ) const
protected

Sync the native bus effect parameter with given value.

◆ ApplyEffectPreset()

void UAtomBus::ApplyEffectPreset ( const UAtomBusEffectPreset * EffectPreset) const
protected

Sync the native bus effect with all preset settings (parameters and bypass).

◆ ApplyEndpoint()

void UAtomBus::ApplyEndpoint ( const UAtomEndpointBase * Endpoint) const
protected

Sync the native bus output type with given endpoint settings.

◆ ApplyPanning()

void UAtomBus::ApplyPanning ( ) const
protected

Sync the native bus with current spatialization panning settings.

◆ ApplySendLevel()

void UAtomBus::ApplySendLevel ( const FAtomBusSend & InSend) const
protected

Sync the native bus with given bus send level.

◆ ApplyVolume()

void UAtomBus::ApplyVolume ( const UObject * WorldContextObject,
float InOutputVolume ) const
protected

Sync the native bus with current volume.

◆ FindEffectPreset()

int32 UAtomBus::FindEffectPreset ( UAtomBusEffectPreset * InEffectPreset) const

Finds the given preset if it is actualy used in this bus.

◆ GetBusDryLevel()

float UAtomBus::GetBusDryLevel ( ) const

◆ GetBusIndex()

FORCEINLINE int UAtomBus::GetBusIndex ( ) const
inlineprivate

◆ GetBusName()

FORCEINLINE const FString & UAtomBus::GetBusName ( ) const
inline

Gets the bus name identifier.

◆ GetBusOutputVolume()

float UAtomBus::GetBusOutputVolume ( const UObject * WorldContextObject) const

◆ GetBusWetLevel()

float UAtomBus::GetBusWetLevel ( ) const

◆ GetChannelLevel()

float UAtomBus::GetChannelLevel ( EAtomSpeaker InChannel,
EAtomSpeaker OutChannel )

◆ GetEffectPreset()

CRIWARECORE_API UAtomBusEffectPreset * UAtomBus::GetEffectPreset ( int32 InEffectIndex)
inline

◆ GetNumEffectPresets()

CRIWARECORE_API int32 UAtomBus::GetNumEffectPresets ( )
inline

◆ GetPanning()

FAtomPanning UAtomBus::GetPanning ( ) const

◆ GetRack()

UAtomRackBase * UAtomBus::GetRack ( ) const

Gets the Parent holder rack of this bus.

◆ GetSendLevel()

float UAtomBus::GetSendLevel ( int SendIndex)

◆ GetSpectrumAnalysisDelegateSettings()

FAtomSoundSpectrumAnalyzerDelegateSettings UAtomBus::GetSpectrumAnalysisDelegateSettings ( const TArray< FAtomBusSpectralAnalysisBandSettings > & InBandSettings,
float UpdateRate,
float DecibelNoiseFloor,
bool bDoNormalize,
bool bDoAutoRange,
float AutoRangeAttackTime,
float AutoRangeReleaseTime )
static

◆ GetSpectrumAnalyzerSettings()

FAtomSoundSpectrumAnalyzerSettings UAtomBus::GetSpectrumAnalyzerSettings ( EAtomFFTSize FFTSize,
EAtomFFTPeakInterpolationMethod InterpolationMethod,
EAtomFFTWindowType WindowType,
float HopSize,
EAtomSpectrumType SpectrumType )
static

◆ Init()

void UAtomBus::Init ( const FString & InBusName,
int InBusIndex )

◆ IsMainBus()

CRIWARECORE_API bool UAtomBus::IsMainBus ( ) const
inline

Whether this bus is a main bus.

◆ PostInitProperties()

void UAtomBus::PostInitProperties ( )
overridevirtual

◆ PushModulationChanges()

void UAtomBus::PushModulationChanges ( )
protected

◆ RemoveEffectPreset()

bool UAtomBus::RemoveEffectPreset ( UAtomBusEffectPreset * InEffectPreset)

Removes preset to corresponding bus effect, default bus effect settings will be restored.

◆ RemoveSpectralAnalysisDelegate()

void UAtomBus::RemoveSpectralAnalysisDelegate ( const UObject * WorldContextObject,
const FOnAtomBusSpectralAnalysisBP & OnAtomBusSpectralAnalysisBP )

Remove a spectral analysis delegate.

引数
OnAtomBusSpectralAnalysisBPThe event delegate to remove.

◆ Reset()

void UAtomBus::Reset ( bool bApplyToAtom = true)

Reset this bus to default values, uses DspSetting if available (Editor).

◆ ResetChannelLevelMatrix()

void UAtomBus::ResetChannelLevelMatrix ( )

◆ ResetEffectChain()

void UAtomBus::ResetEffectChain ( bool bUseRuntimeDefaults = false)
protected

Reset Effect chain to defaults.

◆ ResetSends()

void UAtomBus::ResetSends ( )
protected

Reset sends to default values.

◆ SetBusDryLevel()

void UAtomBus::SetBusDryLevel ( const UObject * WorldContextObject,
float InDryLevel )

Sets the output volume of the bus in linear gain. This dynamic level acts as a multiplier on the DryLevel property of this bus.

◆ SetBusOutputVolume()

void UAtomBus::SetBusOutputVolume ( const UObject * WorldContextObject,
float InOutputVolume )

Sets the output volume of the bus in linear gain. This dynamic volume acts as a multiplier on the OutputVolume property of this bus.

◆ SetBusWetLevel()

void UAtomBus::SetBusWetLevel ( const UObject * WorldContextObject,
float InWetLevel )

Sets the output volume of the bus in linear gain. This dynamic level acts as a multiplier on the WetLevel property of this bus.

◆ SetChannelLevel()

void UAtomBus::SetChannelLevel ( EAtomSpeaker InChannel,
EAtomSpeaker OutChannel,
float Level )

◆ SetDefaultEffectPreset()

bool UAtomBus::SetDefaultEffectPreset ( int32 InEffectIndex)

◆ SetDryVolumeModulation()

void UAtomBus::SetDryVolumeModulation ( const FAtomSoundModulationSettings & InVolMod)
protected

◆ SetEffectPreset()

bool UAtomBus::SetEffectPreset ( UAtomBusEffectPreset * InEffectPreset)

Sets preset to corresponding bus effect, overriding previous preset if present and retrun false when effect type is not valid with this bus.

◆ SetOutputVolumeModulation()

void UAtomBus::SetOutputVolumeModulation ( const FAtomSoundModulationSettings & InVolMod)
protected

◆ SetPanning()

void UAtomBus::SetPanning ( const FAtomPanning & PanningSetting)

◆ SetSendLevel()

void UAtomBus::SetSendLevel ( int SendIndex,
float Level )

◆ SetWetVolumeModulation()

void UAtomBus::SetWetVolumeModulation ( const FAtomSoundModulationSettings & InVolMod)
protected

◆ StartEnvelopeFollowing() [1/2]

void UAtomBus::StartEnvelopeFollowing ( const UObject * WorldContextObject)

◆ StartEnvelopeFollowing() [2/2]

void UAtomBus::StartEnvelopeFollowing ( FAtomRuntime * InAtomRuntime)

◆ StartSpectralAnalysis() [1/2]

void UAtomBus::StartSpectralAnalysis ( const UObject * WorldContextObject,
EAtomFFTSize FFTSize = EAtomFFTSize::DefaultSize,
EAtomFFTPeakInterpolationMethod InterpolationMethod = EAtomFFTPeakInterpolationMethod::Linear,
EAtomFFTWindowType WindowType = EAtomFFTWindowType::Hann,
float HopSize = 0,
EAtomSpectrumType SpectrumType = EAtomSpectrumType::MagnitudeSpectrum )

Start spectrum analysis of the audio output.

◆ StartSpectralAnalysis() [2/2]

void UAtomBus::StartSpectralAnalysis ( FAtomRuntime * InAtomRuntime,
EAtomFFTSize FFTSize = EAtomFFTSize::DefaultSize,
EAtomFFTPeakInterpolationMethod InterpolationMethod = EAtomFFTPeakInterpolationMethod::Linear,
EAtomFFTWindowType WindowType = EAtomFFTWindowType::Hann,
float HopSize = 0,
EAtomSpectrumType SpectrumType = EAtomSpectrumType::MagnitudeSpectrum )

◆ StopEnvelopeFollowing() [1/2]

void UAtomBus::StopEnvelopeFollowing ( const UObject * WorldContextObject)

◆ StopEnvelopeFollowing() [2/2]

void UAtomBus::StopEnvelopeFollowing ( FAtomRuntime * InAtomRuntime)

◆ StopSpectralAnalysis() [1/2]

void UAtomBus::StopSpectralAnalysis ( const UObject * WorldContextObject)

Stop spectrum analysis of the audio output.

◆ StopSpectralAnalysis() [2/2]

void UAtomBus::StopSpectralAnalysis ( FAtomRuntime * InAtomRuntime)

◆ SyncAll()

void UAtomBus::SyncAll ( )
protected

Sync this AtomBus with all possible settings from the native bus.

◆ Atom::FAtomExPlayback

friend class Atom::FAtomExPlayback
friend

◆ Atom::FMixerSubmix

friend class Atom::FMixerSubmix
friend

◆ FAtomRuntime

friend class FAtomRuntime
friend

◆ UAtomBusEffectPreset

friend class UAtomBusEffectPreset
friend

◆ UAtomRack

friend class UAtomRack
friend

◆ UAtomRackWithParentBase

friend class UAtomRackWithParentBase
friend

メンバ詳解

◆ bOverrideEndpoint

bool UAtomBus::bOverrideEndpoint = false

Whether to override settings of the current endpoint for this bus.

◆ BusEffectChain

TArray<TObjectPtr<UAtomBusEffectPreset> > UAtomBus::BusEffectChain
protected

The presets to apply to bus.

◆ BusEffectChainClasses

TArray<TSubclassOf<UAtomBusEffectPreset> > UAtomBus::BusEffectChainClasses
protected

The presets classes used by this bus. (Hidden by Customization.)

◆ BusIndex

int UAtomBus::BusIndex = INDEX_NONE
private

◆ BusName

FString UAtomBus::BusName
protected

Name of this bus.

◆ ChannelLevelMatrix

FAtomChannelLevelMatrix UAtomBus::ChannelLevelMatrix

The level matrix for each channels for this bus.

◆ DryLevelModulation

FAtomSoundModulationSettings UAtomBus::DryLevelModulation

The dry level of the bus in Decibels. Applied before bus effects and analysis are performed.

◆ Endpoint

TObjectPtr<UAtomEndpointBase> UAtomBus::Endpoint = nullptr

The current mixer output endpoint for this bus. Overrides to setup specfic output settings.

◆ EnvelopeFollowerAttackTime

int32 UAtomBus::EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this DSP bus.

◆ EnvelopeFollowerReleaseTime

int32 UAtomBus::EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this DSP bus.

◆ OutputVolumeModulation

FAtomSoundModulationSettings UAtomBus::OutputVolumeModulation

The output volume of the bus in Decibels. Applied after bus effects and analysis are performed.

◆ Panning

FAtomPanning UAtomBus::Panning
protected

The panning settings for this bus.

◆ Sends

TArray<FAtomBusSend> UAtomBus::Sends

◆ SpatializationType

EAtomSpatializationType UAtomBus::SpatializationType

The type of spatialization of the multi-channels for this bus.

◆ WetLevelModulation

FAtomSoundModulationSettings UAtomBus::WetLevelModulation

The wet level of the bus in Decibels. Applied after bus effects and analysis are performed.


このクラス詳解は次のファイルから抽出されました:
  • C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomBus.h
  • C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomBus.cpp