description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

module: AudioMixer

code: virtual void Serialize ( [FStructuredArchive::FRecord](API\Runtime\Core\Serialization\FStructuredArchive\FRecord) Record )


description: Sets the source key input as the provided AudioBus' output. If no object is provided, key is set to effect's input.

code: void SetAudioBus ( [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus )


description: Sets the source key input as the provided Submix's output. If no object is provided, key is set to effect's input.

code: void SetExternalSubmix ( [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * Submix )


code: void SetSettings ( const [FSubmixEffectDynamicsProcessorSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectDynamicsProcessorSe-) & Settings )


code: void UpdateSettings ( const [FSubmixEffectDynamicsProcessorSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectDynamicsProcessorSe-) & InSettings )


code: void UpdateSettings ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void([FSubmixEffectDynamicsProcessorSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectDynamicsProcessorSe-) &)> InCommand )


className: USubmixEffectDynamicsProcessorPreset

code: class USubmixEffectDynamicsProcessorPreset : public [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset)

Settings

type: FSubmixEffectDy...

SettingsCritSect

type: FCriticalSectio...


code: virtual bool CanFilter() const


code: virtual [FSoundEffectBase](API\Runtime\Engine\Sound\FSoundEffectBase) * CreateNewEffect() const


code: virtual [USoundEffectPreset](API\Runtime\Engine\Sound\USoundEffectPreset) * CreateNewPreset ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) Name, EObjectFlags Flags ) const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetActionName() const


code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSupportedClass() const


code: virtual bool HasAssetActions() const


code: void SetSettings ( const [FSubmixEffectReverbSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectReverbSettings) & InSettings )


code: void SetSettingsWithReverbEffect ( const [UReverbEffect](API\Runtime\Engine\Sound\UReverbEffect) * InReverbEffect, const float WetLevel, const float DryLevel )


code: void UpdateSettings ( const [FSubmixEffectReverbSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectReverbSettings) & InSettings )


code: void UpdateSettings ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void([FSubmixEffectReverbSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectReverbSettings) &)> InCommand )


className: USubmixEffectReverbPreset

code: class USubmixEffectReverbPreset : public [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset)

Settings

type: FSubmixEffectRe...


code: void SetSettings ( const [FSubmixEffectSubmixEQSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectSubmixEQSettings) & InSettings )


code: void UpdateSettings ( const [FSubmixEffectSubmixEQSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectSubmixEQSettings) & InSettings )


code: void UpdateSettings ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void([FSubmixEffectSubmixEQSettings](API\Runtime\AudioMixer\SubmixEffects\FSubmixEffectSubmixEQSettings) &)> InCommand )


className: USubmixEffectSubmixEQPreset

code: class USubmixEffectSubmixEQPreset : public [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset)

type: FSubmixEffectSu...


code: [Audio::FPatchInput](API\Runtime\SignalProcessing\DSP\FPatchInput) AddPatchInputForAudioBus ( [Audio::FAudioBusKey](API\Runtime\AudioMixer\FAudioBusKey) InAudioBusKey, int32 InFrames, int32 InChannels, float InGain )


code: [Audio::FPatchOutputStrongPtr](API\Runtime\Engine\FPatchOutputStrongPtr) AddPatchOutputForAudioBus ( [Audio::FAudioBusKey](API\Runtime\AudioMixer\FAudioBusKey) InAudioBusKey, int32 InFrames, int32 InChannels, float InGain )


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


description: Implement this for initialization of instances of the system

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


code: bool IsAudioBusActive ( [Audio::FAudioBusKey](API\Runtime\AudioMixer\FAudioBusKey) InAudioBusKey ) const


description: Note: This function is called on the CDO prior to instances being created!

code: virtual bool ShouldCreateSubsystem ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Outer ) const


code: void ShutdownDefaultAudioBuses()


description: Audio bus API from FMixerDevice.

code: void StartAudioBus ( [Audio::FAudioBusKey](API\Runtime\AudioMixer\FAudioBusKey) InAudioBusKey, int32 InNumChannels, bool bInIsAutomatic )


code: void StopAudioBus ( [Audio::FAudioBusKey](API\Runtime\AudioMixer\FAudioBusKey) InAudioBusKey )


className: UAudioBusSubsystem

description: UAudioBusSubsystem

code: class UAudioBusSubsystem : public [UAudioEngineSubsystem](API\Runtime\Engine\Subsystems\UAudioEngineSubsystem)


code: static [UAudioDeviceNotificationSubsystem](API\Runtime\AudioMixer\UAudioDeviceNotificationSubsyste-) * Get()


code: EAudioDeviceChangedRole GetDeviceChangedRole ( [Audio::EAudioDeviceRole](API\Runtime\AudioMixerCore\Audio__EAudioDeviceRole) InRole ) const


code: EAudioDeviceChangedState GetDeviceChangedState ( [Audio::EAudioDeviceState](API\Runtime\AudioMixerCore\Audio__EAudioDeviceState) InState ) const


code: virtual void OnDefaultCaptureDeviceChanged ( const [Audio::EAudioDeviceRole](API\Runtime\AudioMixerCore\Audio__EAudioDeviceRole) InAudioDeviceRole, const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


code: virtual void OnDefaultRenderDeviceChanged ( const [Audio::EAudioDeviceRole](API\Runtime\AudioMixerCore\Audio__EAudioDeviceRole) InAudioDeviceRole, const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


code: virtual void OnDeviceAdded ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, bool bIsRenderDevice )


code: virtual void OnDeviceRemoved ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, bool bIsRenderDevice )


code: virtual void OnDeviceStateChanged ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [Audio::EAudioDeviceState](API\Runtime\AudioMixerCore\Audio__EAudioDeviceState) InState, bool bIsRenderDevice )


code: virtual void OnDeviceSwitched ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


className: UAudioDeviceNotificationSubsystem

description: UAudioDeviceNotificationSubsystem

code: class UAudioDeviceNotificationSubsystem : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem), public [Audio::IAudioMixerDeviceChangedListener](API\Runtime\AudioMixerCore\IAudioMixerDeviceChangedListener)

DefaultCaptureDeviceChanged

type: FOnAudioDefault...

DefaultCaptureDeviceChangedNative

description: Multicast delegate triggered when default capture device changes (native code only)

DefaultRenderDeviceChangedNative

description: Multicast delegate triggered when default render device changes (native code only)

DeviceAdded

type: FOnAudioDeviceC...

DeviceAddedNative

description: Multicast delegate triggered when a device is added (native code only)

DeviceRemovedNative

description: Multicast delegate triggered when a device is removed (native code only)

DeviceStateChanged

type: FOnAudioDeviceS...

DeviceStateChangedNative

description: Multicast delegate triggered on device state change (native code only)

DeviceSwitchedNative

description: Multicast delegate triggered on device switch (native code only)


description: Adds a submix effect preset to the master submix.

code: static void AddMasterSubmixEffect ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Adds a submix effect preset to the given submix at the end of its submix effect chain. Returns the number of submix effects.

code: static int32 AddSubmixEffect ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Clears all master submix effects.

code: static void ClearMasterSubmixEffects ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject )


description: Clears all submix effect overrides on the given submix and returns it to the default effect chain.

code: static void ClearSubmixEffectChainOverride ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, float FadeTimeSec )


description:
Returns the device info in a human readable format
The data in a string format

code: static [FString](API\Runtime\Core\Containers\FString) Conv_AudioOutputDeviceInfoToString ( const [FAudioOutputDeviceInfo](API\Runtime\AudioMixer\FAudioOutputDeviceInfo) & Info )


description: Clears all submix effects on the given submix.

code: static void ClearSubmixEffects ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix )


description: Adds source effect entry to preset chain. Only effects the instance of the preset chain

code: static void AddSourceEffectToPresetChain ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSourcePresetChain](API\Runtime\Engine\Sound\USoundEffectSourcePresetChain) * PresetChain, [FSourceEffectChainEntry](API\Runtime\Engine\Sound\FSourceEffectChainEntry) Entry )


description: Gets information about all audio output devices available in the system

code: static void GetAvailableAudioOutputDevices ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [FOnAudioOutputDevicesObtained](API\Runtime\AudioMixer\FOnAudioOutputDevicesObtained) & OnObtainDevicesEvent )


description: Gets information about the currently used audio output device

code: static void GetCurrentAudioOutputDeviceName ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [FOnMainAudioOutputDeviceObtained](API\Runtime\AudioMixer\FOnMainAudioOutputDeviceObtained) & OnObtainCurrentDeviceEvent )


description: Retrieve the magnitudes for the given frequencies.

code: static void GetMagnitudeForFrequencies ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [TArray](API\Runtime\Core\Containers\TArray)< float > & Frequencies, [TArray](API\Runtime\Core\Containers\TArray)< float > & Magnitudes, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToAnalyze )


description: Returns the number of effect chain entries in the given source effect chain.

code: static int32 GetNumberOfEntriesInSourceEffectChain ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSourcePresetChain](API\Runtime\Engine\Sound\USoundEffectSourcePresetChain) * PresetChain )


description: Retrieve the phases for the given frequencies.

code: static void GetPhaseForFrequencies ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [TArray](API\Runtime\Core\Containers\TArray)< float > & Frequencies, [TArray](API\Runtime\Core\Containers\TArray)< float > & Phases, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToAnalyze )


description: Make an array of logarithmically spaced bands.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FSoundSubmixSpectralAnalysisBandSettings](API\Runtime\Engine\Sound\FSoundSubmixSpectralAnalysisBand-) > MakeFullSpectrumSpectralAnalysisBandSettings ( int32 InNumBands, float InMinimumFrequency, float InMaximumFrequency, int32 InAttackTimeMsec, int32 InReleaseTimeMsec )


description: Make an array of musically spaced bands with ascending frequency.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FSoundSubmixSpectralAnalysisBandSettings](API\Runtime\Engine\Sound\FSoundSubmixSpectralAnalysisBand-) > MakeMusicalSpectralAnalysisBandSettings ( int32 InNumSemitones, EMusicalNoteName InStartingMusicalNote, int32 InStartingOctave, int32 InAttackTimeMsec, int32 InReleaseTimeMsec )


description: Queries if the given audio bus is active (and audio can be mixed to it).

code: static bool IsAudioBusActive ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus )


description: Make an array of bands which span the frequency range of a given EAudioSpectrumBandPresetType.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FSoundSubmixSpectralAnalysisBandSettings](API\Runtime\Engine\Sound\FSoundSubmixSpectralAnalysisBand-) > MakePresetSpectralAnalysisBandSettings ( EAudioSpectrumBandPresetType InBandPresetType, int32 InNumBands, int32 InAttackTimeMsec, int32 InReleaseTimeMsec )


description: Pause recording audio, without finalizing the recording to disk.Byleaving the Submix To Record field blank, you can record the master output of the game.

code: static void PauseRecordingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToPause )


description: Begin loading a sound into the cache so that it can be played immediately.

code: static void PrimeSoundForPlayback ( [USoundWave](API\Runtime\Engine\Sound\USoundWave) * SoundWave, const [FOnSoundLoadComplete](API\Runtime\AudioMixer\FOnSoundLoadComplete) OnLoadCompletion )


description: Begin loading any sounds referenced by a sound cue into the cache so that it can be played immediately.

code: static void PrimeSoundCueForPlayback ( [USoundCue](API\Runtime\Engine\Sound\USoundCue) * SoundCue )


description: Removes a submix effect preset from the master submix.

code: static void RemoveMasterSubmixEffect ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Removes all instances of a submix effect preset from the given submix.

code: static void RemoveSubmixEffect ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Deprecated* RemoveSubmixEffectPresetAtIndex is deprecated, use RemoveSubmixEffectAtIndex.

code: static void RemoveSubmixEffectPresetAtIndex ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, int32 SubmixChainIndex )


description: Removes the submix effect at the given submix chain index, if there is a submix effect at that index.

code: static void RemoveSubmixEffectAtIndex ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, int32 SubmixChainIndex )


description: Deprecated* RemoveSubmixEffectPreset is deprecated, use RemoveSubmixEffect.

code: static void RemoveSubmixEffectPreset ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Removes source effect entry from preset chain. Only affects the instance of preset chain.

code: static void RemoveSourceEffectFromPresetChain ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSourcePresetChain](API\Runtime\Engine\Sound\USoundEffectSourcePresetChain) * PresetChain, int32 EntryIndex )


description: Deprecated* ReplaceSoundEffectSubmix is deprecated, use ReplaceSubmixEffect.

code: static void ReplaceSoundEffectSubmix ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * InSoundSubmix, int32 SubmixChainIndex, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Replaces the submix effect at the given submix chain index, adds the effect if there is none at that index.

code: static void ReplaceSubmixEffect ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * InSoundSubmix, int32 SubmixChainIndex, [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * SubmixEffectPreset )


description: Resume recording audio after pausing.Byleaving the Submix To Pause field blank, you can record the master output of the game.

code: static void ResumeRecordingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToPause )


description: Set whether or not to bypass the effect at the source effect chain index.

code: static void SetBypassSourceEffectChainEntry ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundEffectSourcePresetChain](API\Runtime\Engine\Sound\USoundEffectSourcePresetChain) * PresetChain, int32 EntryIndex, bool bBypassed )


description: Sets a submix effect chain override on the given submix. The effect chain will cross fade from the base effect chain or current override to the new override.

code: static void SetSubmixEffectChainOverride ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SoundSubmix, [TArray](API\Runtime\Core\Containers\TArray)< [USoundEffectSubmixPreset](API\Runtime\Engine\Sound\USoundEffectSubmixPreset) * > SubmixEffectPresetChain, float FadeTimeSec )


description: Start spectrum analysis of the audio output.Byleaving the Submix To Analyze blank, you can analyze the master output of the game.

code: static void StartAnalyzingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToAnalyze, EFFTSize FFTSize, EFFTPeakInterpolationMethod InterpolationMethod, EFFTWindowType WindowType, float HopSize, EAudioSpectrumType SpectrumType )


description: Starts the given audio bus.

code: static void StartAudioBus ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus )


description: Start recording audio.Byleaving the Submix To Record field blank, you can record the master output of the game.

code: static void StartRecordingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, float ExpectedDuration, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToRecord )


description: Stop spectrum analysis.

code: static void StopAnalyzingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToStopAnalyzing )


description: Stops the given audio bus.

code: static void StopAudioBus ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus )


description: Stop recording audio. Path can be absolute, or relative (to the /Saved/BouncedWavFiles folder).Byleaving the Submix To Record field blank, you can record the master output of the game.

code: static [USoundWave](API\Runtime\Engine\Sound\USoundWave) * StopRecordingOutput ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, EAudioRecordingExportType ExportType, const [FString](API\Runtime\Core\Containers\FString) & Name, [FString](API\Runtime\Core\Containers\FString) Path, [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * SubmixToRecord, [USoundWave](API\Runtime\Engine\Sound\USoundWave) * ExistingSoundWaveToOverwrite )


description: Hotswaps to the requested audio output device

code: static void SwapAudioOutputDevice ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [FString](API\Runtime\Core\Containers\FString) & NewDeviceId, const [FOnCompletedDeviceSwap](API\Runtime\AudioMixer\FOnCompletedDeviceSwap) & OnCompletedDeviceSwap )


description: Trim memory used by the audio cache. Returns the number of megabytes freed.

code: static float TrimAudioCache ( float InMegabytesToFree )


className: UAudioMixerBlueprintLibrary

code: class UAudioMixerBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: Plugin interface for Non Real-Time (NRT) Audio Analyzers.

module: AudioMixerCore

code: namespace Audio { enum EAudioDeviceRole { Console, Multimedia, Communications, COUNT, } }


code: namespace Audio { enum EAudioDeviceState { Active, Disabled, NotPresent, Unplugged, COUNT, } }


code: namespace Audio { namespace EAudioMixerStreamDataFormat { enum Type { Unknown, Float, Int16, Unsupported, } } }


description: EAudioOutputStreamState Specifies the state of the output audio stream.

code: namespace Audio { namespace EAudioOutputStreamState { enum Type { Closed, Open, Stopped, Stopping, Running, } } }


code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_ADPCM ( TEXT("ADPCM") ) }


description: Supported on all platforms:

code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_BINKA ( TEXT("BINKA") ) }


description: Not yet supported on all platforms as a selectable option so is included under "platform specific" enumeration for now.

code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_OGG ( TEXT("OGG") ) }


code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_OPUS ( TEXT("OPUS") ) }


code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_PCM ( TEXT("PCM") ) }


description: Indicates a platform-specific format.

code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_PLATFORM_SPECIFIC ( TEXT("PLATFORM_SPECIFIC") ) }


code: namespace Audio { [FName](API\Runtime\Core\UObject\FName) Audio::NAME_PROJECT_DEFINED ( TEXT("PROJECT_DEFINED") ) }


code: namespace EAudioMixerChannel { static const int32 EAudioMixerChannel::MaxSupportedChannel = EAudioMixerChannel::TopCenter; }


code: namespace EAudioMixerChannel { const TCHAR * EAudioMixerChannel::ToString ( [EAudioMixerChannel::Type](API\Runtime\AudioMixerCore\EAudioMixerChannel__Type) InType ) }


description: Enumeration values represent sound file or speaker channel types.

code: namespace EAudioMixerChannel { enum Type { FrontLeft, FrontRight, FrontCenter, LowFrequency, BackLeft, BackRight, FrontLeftOfCenter, FrontRightOfCenter, BackCenter, SideLeft, SideRight, TopCenter, TopFrontLeft, TopFrontCenter, TopFrontRight, TopBackLeft, TopBackCenter, TopBackRight, Unknown, ChannelTypeCount, DefaultChannel = FrontLeft, } }


code: FAudioMixerOpenStreamParams()


className: FAudioMixerOpenStreamParams

description: Defines parameters needed for opening a new audio stream to device.

code: struct FAudioMixerOpenStreamParams

AudioMixer

type: IAudioMixer...

description: Owning platform independent audio mixer ptr.

bRestoreIfRemoved

type: bool

description: Whether or not to try and restore audio to this stream if the audio device is removed (and the device becomes available again).

MaxSources

description: The maximum number of sources we will try to decode or playback at once.

NumBuffers

description: The number of queued buffers to use for the strea.

NumFrames

description: The number of desired audio frames in audio callback.

OutputDeviceIndex

description: The audio device index to open.

SampleRate

description: The desired sample rate


className: FAudioOutputStreamInfo

code: struct FAudioOutputStreamInfo

AudioMixer

description: The callback to use for platform-independent layer.

DeviceInfo

type: FAudioPlatformD...

NumBuffers

description: The number of queued buffers to use.

NumOutputFrames

description: Number of output frames

OutputDeviceIndex

description: The index of the output device for the audio stream.

StreamState

type: EAudioOutputStr...

description: The state of the output audio stream.


code: FAudioPlatformDeviceInfo()


className: FAudioPlatformDeviceInfo

description: Structure to hold platform device information

code: struct FAudioPlatformDeviceInfo

bIsSystemDefault

type: uint8:  1

description: Whether or not this device is the system default

DeviceId

type: FString

description: ID of the device.

Format

type: EAudioMixerStre...

description: The data format of the audio stream

Name

description: The name of the audio device

NumChannels

description: The number of channels supported by the audio device

OutputChannelArray

type: TArray<EAudioM...

description: The output channel array of the audio device

SampleRate

description: The sample rate of the audio device


className: FAudioPlatformSettings

code: struct FAudioPlatformSettings

CallbackBufferFrameSize

description: The amount of audio to compute each callback block.

MaxChannels

description: The max number of channels (simultaneous voices) to use as the limit for this platform.

NumBuffers

description: The number of buffers to keep enqueued.

NumSourceWorkers

description: The number of workers to use to compute source audio.

description: Sample rate to use on the platform for the mixing engine.


code: static [FAudioPlatformSettings](API\Runtime\AudioMixerCore\FAudioPlatformSettings) GetPlatformSettings ( const TCHAR * PlatformSettingsConfigFile )


className: FAudioRenderTimeAnalysis

description: Struct used to store render time analysis data.

code: struct FAudioRenderTimeAnalysis

AvgRenderTime

type: double


description: Pause the thread, making it sleep until woken, not consuming cycles or buffers.

code: void Pause()


code: FAudioRenderTimeAnalysis()


description: Resume a paused null renderer.

code: void Resume ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> & InCallback, float InBufferDuration )


description: Exit

code: virtual void Stop()


description: FRunnableoverride:

code: virtual uint32 Run()


description: Default constructor intentionally suppressed:


description: The destructor waits on Callback to be completed before stopping the thread.

code: virtual ~FMixerNullCallback()


description: Constructing theFMixerNullCallbackimmediately begins calling InCallback every BufferDuration seconds.

code: FMixerNullCallback ( float BufferDuration, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> InCallback, EThreadPriority ThreadPriority, bool bStartedPaused )


className: FMixerNullCallback

description: FMixerNullCallbackThis class, when started, spawns a new high priority thread that exists to query an FAudioMixerPlatformInterface and immediately throw out whatever buffers it receives.

code: class FMixerNullCallback : protected [FRunnable](API\Runtime\Core\HAL\FRunnable)


description: Returns the format of the buffer.


description: Initialize the buffer with the given samples and output format.

code: void Init ( [IAudioMixer](API\Runtime\AudioMixerCore\IAudioMixer) * InAudioMixer, const int32 InNumSamples, const int32 InNumBuffers, const [EAudioMixerStreamDataFormat::Type](API\Runtime\AudioMixerCore\Audio__EAudioMixerStreamDataForm-) InDataFormat )


description: Gets the number of frames of the buffer.

code: int32 GetNumSamples() const


description: Gets the next mixed buffer from the audio mixer. Returns false if our buffer is already full.

code: bool MixNextBuffer()


description: Gets the buffer data ptrs. Returns aTArrayViewfor the full buffer size requested, but in the case of an underrun, OutBytesPopped will be less that the size of the returnedTArrayView.

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > PopBufferData ( int32 & OutBytesPopped ) const


className: FOutputBuffer

description: Class which wraps an output float buffer and handles conversion to device stream formats.

code: class FOutputBuffer


code: virtual [FAudioDevice](API\Runtime\Engine\FAudioDevice) * CreateAudioDevice()


className: IAudioDeviceModule

description: Defines the interface of a module implementing an audio device and associated classes.

code: class IAudioDeviceModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Creates a new instance of the audio device implemented by the module.

code: virtual bool IsAudioMixerModule() const


code: bool IsMainAudioMixer() const


description: Callback to generate a new audio stream buffer.

code: bool OnProcessAudioStream ( [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutputBuffer )


description: Called by FWindowsMMNotificationClient to bypass notifications for audio device changes:

code: static bool ShouldIgnoreDeviceSwaps()


description: Called when audio render thread stream is shutting down. Last function called. Allows cleanup on render thread.

code: void OnAudioStreamShutdown()


description: Called by FWindowsMMNotificationClient to toggle logging for audio device changes:

code: static bool ShouldLogDeviceSwaps()


description: Called by AudioMixer to see if it should reycle the threads:

code: static bool ShouldRecycleThreads()


description: Called by AudioMixer if it should use Cache for DeviceInfo Enumeration

code: static bool ShouldUseDeviceInfoCache()


description: Called by AudioMixer to see if we should do a multithreaded device swap


className: IAudioMixer

description: Platform independent audio mixer interface.

code: class IAudioMixer


className: EDisconnectReason

code: enum EDisconnectReason { DeviceRemoval, ServerShutdown, FormatChanged, SessionLogoff, SessionDisconnected, ExclusiveModeOverride, }


code: virtual [FString](API\Runtime\Core\Containers\FString) GetDeviceId() const


className: FFormatChangedData

code: struct FFormatChangedData


code: virtual void OnDefaultCaptureDeviceChanged ( const [EAudioDeviceRole](API\Runtime\AudioMixerCore\Audio__EAudioDeviceRole) InAudioDeviceRole, const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


code: virtual void OnDeviceAdded ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, bool bIsRenderDevice )


code: virtual void OnDefaultRenderDeviceChanged ( const [EAudioDeviceRole](API\Runtime\AudioMixerCore\Audio__EAudioDeviceRole) InAudioDeviceRole, const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


code: virtual void OnDeviceStateChanged ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [EAudioDeviceState](API\Runtime\AudioMixerCore\Audio__EAudioDeviceState) InState, bool bIsRenderDevice )


code: virtual void OnDeviceRemoved ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, bool bIsRenderDevice )


code: virtual void OnFormatChanged ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceId, const [FFormatChangedData](API\Runtime\AudioMixerCore\IAudioMixerDeviceChangedListener\FFormatChangedData) & InFormat )


code: virtual void OnSessionDisconnect ( [EDisconnectReason](API\Runtime\AudioMixerCore\IAudioMixerDeviceChangedListener\EDisconnectReason) InReason )


className: IAudioMixerDeviceChangedListener

description: Abstract interface for receiving audio device changed notifications

code: class IAudioMixerDeviceChangedListener


code: template<typename BufferType> void ApplyAttenuationInternal ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< BufferType > & InOutBuffer )


description: Deprecated - use ApplyPrimaryAttenuation

code: void ApplyMasterAttenuation ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > & InOutPoppedAudio )


description: Performs buffer fades for shutdown/startup of audio mixer.

code: void ApplyPrimaryAttenuation ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > & InOutPoppedAudio )


description: Is called when an error, warning or log is generated.

code: void AudioMixerPlatformLogOnce ( const [FString](API\Runtime\Core\Containers\FString) & LogDetails, const [FString](API\Runtime\Core\Containers\FString) & FileName, int32 LineNumber, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity )


description: Start generating audio from our mixer.

code: void BeginGeneratingAudio()


description: Check if audio device changed if applicable. Return true if audio device changed.

code: virtual bool CheckAudioDeviceChange()


description: Closes the audio stream (if it's open).

code: bool CloseAudioStream()


description: Creates a Compressed audio info class suitable for decompressing this SoundWave. OVerride to create platform-specific decoders.

code: virtual [ICompressedAudioInfo](API\Runtime\Engine\ICompressedAudioInfo) * CreateCompressedAudioInfo ( const [FName](API\Runtime\Core\UObject\FName) & InRuntimeFormat ) const


description: Called by platform specific logic to pre-create or create the null renderer thread

code: void CreateNullDeviceThread ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> InCallback, float InBufferDuration, bool bShouldPauseOnStart )


description: Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms)

code: virtual bool DisablePCMAudioCaching() const


description: Reset the fade state (use if reusing audio platform interface, e.g. in main audio device.

code: virtual void FadeIn()


description: Start a fadeout. Prevents pops during shutdown.

code: virtual void FadeOut()


description: Helper function to gets the channel map type at the given index.

code: static bool GetChannelTypeAtIndex ( const int32 Index, [EAudioMixerChannel::Type](API\Runtime\AudioMixerCore\EAudioMixerChannel__Type) & OutType )


description: Returns the name of the currently used audio device.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetCurrentDeviceName() const


description: Return any optional device name defined in platform configuratio.


description: Returns the default device index.

code: virtual bool GetDefaultOutputDeviceIndex ( uint32 & OutDefaultDeviceIndex ) const


description: Get the DeviceInfo Cache if one exists.

code: virtual [IAudioPlatformDeviceInfoCache](API\Runtime\AudioMixerCore\IAudioPlatformDeviceInfoCache) * GetDeviceInfoCache() const


description: Can be used to look up the current index for a given device name. On most platforms, this index may be invalidated if any devices are added or removed. Returns INDEX_NONE if no mapping is found

code: virtual int32 GetIndexForDevice ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName )


description: Allows platforms to filter the requested number of frames to render. Some platforms only support specific frame counts.

code: virtual int32 GetNumFrames ( const int32 InNumReqestedFrames )


description: Returns the last error generated.


description: Returns the number of output devices.

code: virtual bool GetNumOutputDevices ( uint32 & OutNumOutputDevices )


description: Gets the device information of the given device index.

code: bool GetOutputDeviceInfo ( const uint32 InDeviceIndex, [FAudioPlatformDeviceInfo](API\Runtime\AudioMixerCore\FAudioPlatformDeviceInfo) & OutInfo )


description: Returns the platform API name.


description: Returns the platform device info of the currently open audio stream.


description: Gets the platform specific audio settings.


description: Returns theFNameversion of a given sound wave's format. Override to provide a runtime format (codec) that is platform specific.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetRuntimeFormat ( const [USoundWave](API\Runtime\Engine\Sound\USoundWave) * InSoundWave ) const


description: FSingleThreadRunnableaccessor for ticking thisFRunnablewhen multi-threading is disabled.FSingleThreadRunnableInterface for thisFRunnableobject.

code: virtual [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable) * GetSingleThreadInterface()


description: Initialize the hardware.

code: bool InitializeHardware()


description: Whether this is an interface for a non-realtime renderer. If true, synch events will behave differently to avoid deadlocks.

code: virtual bool IsNonRealtime() const


description: Is the hardware initialized.

code: bool IsInitialized() const


description: Run the "main" audio device.

code: uint32 MainAudioDeviceRun()


description: Resets the audio stream to use a new audio device with the given device ID (empty string means default).

code: virtual bool MoveAudioStreamToNewAudioDevice ( const [FString](API\Runtime\Core\Containers\FString) & InNewDeviceId )


className: NextInstanceID

description: IAudioMixerPlatformInterface


description: Opens up a new audio stream with the given parameters.

code: bool OpenAudioStream ( const [FAudioMixerOpenStreamParams](API\Runtime\AudioMixerCore\FAudioMixerOpenStreamParams) & Params )


description: Function called at the beginning of every call of UpdateHardware on the audio thread.

code: virtual void OnHardwareUpdate()


description: This is called afterInitializeHardware()is called.

code: void PostInitializeHardware()


description: Retrieves the next generated buffer and feeds it to the platform mixer output stream.

code: void ReadNextBuffer()


description: Function to resume audio rendering. Used on mobile platforms which can suspend the application.

code: virtual void ResumeContext()


description: Sends a command to swap which output device is being used

code: virtual bool RequestDeviceSwap ( const [FString](API\Runtime\Core\Containers\FString) & DeviceID, bool bInForce, const TCHAR * InReason )


description: Resumes playback on new audio device after device change.


description: Wrapper around the thread Run. This is virtualized so a platform can fundamentally override the render function.

code: virtual uint32 RunInternal()


description: Exit

code: virtual uint32 Run()


description: Starts the audio stream processing and generating audio.

code: bool StartAudioStream()


description: When called, spins up a thread to start consuming output when no audio device is available.

code: void StartRunningNullDevice()


description: Stops the render thread from generating audio.

code: void StopGeneratingAudio()


description: Submit the given buffer to the platform's output audio device.

code: virtual void SubmitBuffer ( const uint8 * Buffer )


description: When called, terminates the null device.

code: void StopRunningNullDevice()


description: Stops the audio stream (but keeps the audio stream open).

code: bool StopAudioStream()


description: Whether or not this platform has hardware decompression.

code: virtual bool SupportsHardwareDecompression() const


description: Function to stop all audio from rendering. Used on mobile platforms which can suspend the application.

code: virtual void SuspendContext()


description: Teardown the hardware.

code: bool TeardownHardware()


description: Tick function.

code: virtual void Tick()


description: Virtual destructor.

code: virtual ~IAudioMixerPlatformInterface()


description: Constructor.

code: IAudioMixerPlatformInterface()


className: IAudioMixerPlatformInterface

description: Abstract interface for mixer platform.

code: class IAudioMixerPlatformInterface : public [FRunnable](API\Runtime\Core\HAL\FRunnable), public [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable), public [Audio::IAudioMixerDeviceChangedListener](API\Runtime\AudioMixerCore\IAudioMixerDeviceChangedListener)

AudioFadeEvent

type: FEvent*

description: Event allows you to block until fadeout is complete.

AudioRenderEvent

description: The render thread sync event.

AudioRenderThread

type: TUniquePtr<FRu...

description: FRunnableThread* AudioRenderThread;.

AudioStreamInfo

type: FAudioOutputStr...

description: The audio device stream info.

bFadedOut

type: FThreadSafeBool

bIsInDeviceSwap

description: This is used if we are attempting to TryLock on DeviceSwapCriticalSection, but a buffer callback is being called in the current thread.

bWarnedBufferUnderrun

description: Whether or not we warned of buffer underrun.

CurrentDeviceName

description: This device name can be used to override the default device being used on platforms that use strings to identify audio devices.

DeviceSwapCriticalSection

description: Critical Section used for times when we need the render loop to halt for the device swap.

FadeParam

type: FParam

description: Source param used to fade in and out audio device.

FadeVolume

type: float

description: The fade value. Used for fading in/out primary audio.

InstanceID

type: const int32

description: A Unique ID Identifying this instance. Mostly used for logging.

LastError

description: String containing the last generated error.

NumOutputBuffers

description: The number of mixer buffers to queue on the output source voice.

OpenStreamParams

type: FAudioMixerOpen...

OutputBuffer

description: List of generated output buffers.


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FAudioPlatformDeviceInfo](API\Runtime\AudioMixerCore\FAudioPlatformDeviceInfo) > FindDefaultOutputDevice() const


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FAudioPlatformDeviceInfo](API\Runtime\AudioMixerCore\FAudioPlatformDeviceInfo) > FindActiveOutputDevice ( [FName](API\Runtime\Core\UObject\FName) InDeviceID ) const


className: IAudioPlatformDeviceInfoCache

description: Interface for Caching Device Info.

code: class IAudioPlatformDeviceInfoCache


description: Plugin interface for Non Real-Time (NRT) Audio Analyzers.

module: AudioPlatformConfiguration

code: namespace Audio { enum EResamplingMethod { BestSinc = 0, ModerateSinc = 1, FastSinc = 2, ZeroOrderHold = 3, Linear = 4, } }


className: FAlignedFloatBuffer

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< float, [TAlignedHeapAllocator](API\Runtime\Core\Containers\TAlignedHeapAllocator)< 16 >> FAlignedFloatBuffer


code: FAudioStreamCachingSettings()


className: FAudioStreamCachingSettings

description: FAudioStreamCachingSettingsProperties used to determine chunk sizes for the two caches used when the experimental Stream Caching feature is used.

code: struct FAudioStreamCachingSettings

bForceLegacyStreamChunking

description: Bool flag for keeping sounds flagged for streaming chunked in the style of the legacy streaming manager.

CacheSizeKB

description: Target memory usage, in kilobytes.

MaxChunkSizeOverrideKB

description: Will be ignored if < 0


description: This is used to invalidate compressed audio for a specific platform.

code: static void GetHashSuffix ( const [FPlatformAudioCookOverrides](API\Runtime\AudioPlatformConfiguration\FPlatformAudioCookOverrides) * InOverrides, [FString](API\Runtime\Core\Containers\FString) & OutSuffix )


className: DefaultCacheSize

code: static constexpr int32 DefaultCacheSize = 64 * 1024;


code: FPlatformAudioCookOverrides()


className: FPlatformAudioCookOverrides

description: FPlatformAudioCookOverridesThis struct is used for settings used during the cook to a target platform (platform-specific compression quality and resampling, etc.)

code: struct FPlatformAudioCookOverrides

bInlineStreamedAudioChunks

description: Whether to put streamed audio chunks inline in the Pak file or not (only matters if bUseStreamCaching is true)

CompressionQualityModifier

description: Scales all compression qualities when cooking to this platform. For example, 0.5 will halve all compression qualities, and 1.0 will leave them unchanged.

PlatformSampleRates

type: TMap< ESoundwav...

description: Mapping of which sample rates are used for each sample rate quality for a specific platform.

SoundCueCookQualityIndex

description: If set, the cooker will keep only this level of quality.

StreamCachingSettings

type: FAudioStreamCac...

description: If Load On Demand is enabled, these settings are used to determine chunks and cache sizes.


description: Increment this return value to force a recook on all Stream Caching assets. For testing, it's useful to set this to either a negative number or absurdly large number, to ensure you do not pollute the DDC.

code: static int32 GetStreamCachingVersion()


className: DefaultCompressionOverrides

code: static [FPlatformRuntimeAudioCompressionOverrides](API\Runtime\AudioPlatformConfiguration\FPlatformRuntimeAudioCompression-) * DefaultCompressionOverrides = nullptr;


description: Get singleton containing default settings for compression.


bOverrideCompressionTimes

type: bool

description: When true, overrides the Sound Group on each Sound Wave, and instead uses the Duration Threshold value to determine whether a sound should be fully decompressed during initial loading.

DurationThreshold

description: When Override Compression Times is set to true, any sound under this threshold (in seconds) will be fully decompressed on load.

MaxNumRandomBranches

description: On this platform, any random nodes on Sound Cues will automatically only preload this number of branches and dispose of any others on load.

SoundCueQualityIndex

description: On this platform, use the specified quality at this index to override the quality used for SoundCues on this platform.


code: void Init ( [EResamplingMethod](API\Runtime\AudioPlatformConfiguration\Audio__EResamplingMethod) ResamplingMethod, float StartingSampleRateRatio, int32 InNumChannels )


code: int32 ProcessAudio ( float * InAudioBuffer, int32 InSamples, bool bEndOfInput, float * OutAudioBuffer, int32 MaxOutputFrames, int32 & OutNumFrames )


code: void SetSampleRateRatio ( float InRatio )


className: FResampler

code: class FResampler


code: FResamplerResults()


className: FResamplerResults

code: struct FResamplerResults


className: FResamplingParameters

code: struct FResamplingParameters

ResamplerMethod

type: EResamplingMeth...


module: AugmentedReality

code: [UARComponent](API\Runtime\AugmentedReality\UARComponent) * AddARComponent ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UARComponent](API\Runtime\AugmentedReality\UARComponent) > InComponentClass, const [FGuid](API\Runtime\Core\Misc\FGuid) & NativeID )


code: static void RequestSpawnARActor ( [FGuid](API\Runtime\Core\Misc\FGuid) NativeID, [UClass](API\Runtime\CoreUObject\UObject\UClass) * InComponentClass )


code: static void RequestDestroyARActor ( [AARActor](API\Runtime\AugmentedReality\AARActor) * InActor )


description: Used by the AR system to get the origin actor for the current world

code: static [AAROriginActor](API\Runtime\AugmentedReality\AAROriginActor) * GetOriginActor()


className: AARActor

code: class AARActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)


code: AAROriginActor ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AAROriginActor

description: Simple actor that is spawned at the origin for AR systems that want to hang components on an actor Spawned as a custom class for easierTObjectIteratoruse

code: class AAROriginActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)


description: the game state for this game mode


description: Sets the image data for the shared world game session

code: void SetARSharedWorldData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > ARWorldData )


description: Tells the game mode that the AR data is ready and should be replicated to all connected clients

code: void SetARWorldSharingIsReady()


code: void SetPreviewImageData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > ImageData )


className: AARSharedWorldGameMode

code: class AARSharedWorldGameMode : public [AGameMode](API\Runtime\Engine\GameFramework\AGameMode)

BufferSizePerChunk

description: The size of the buffer to use per send request.


code: AARSharedWorldGameMode ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Used to setup the initial values and size the arrays (client)

code: void InitSharedWorld ( int32 PreviewImageSize, int32 ARWorldDataSize )


code: void K2_OnARWorldMapIsReady()


description: Copies the buffer into the AR world data (client)

code: void UpdateARWorldData ( int32 Offset, const uint8 * Buffer, int32 Size )


description: Copies the buffer into the image data (client)

code: void UpdatePreviewImageData ( int32 Offset, const uint8 * Buffer, int32 Size )


code: AARSharedWorldGameState ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AARSharedWorldGameState

code: class AARSharedWorldGameState : public [AGameState](API\Runtime\Engine\GameFramework\AGameState)

ARWorldBytesDelivered

description: The amount of the AR world data that has been replicated to this client so far

ARWorldBytesTotal

description: The size of the AR world data that will be replicated to each client

ARWorldData

type: TArray< uint8 >

PreviewImageBytesDelivered

description: The amount of the preview image data that has been replicated to this client so far

PreviewImageBytesTotal

description: The size of the image that will be replicated to each client

PreviewImageData

description: Each client and the host have a copy of the shared world data The image taken at the time of world saving for use when aligning the AR world later in the session


code: void ClientInitSharedWorld ( int32 PreviewImageSize, int32 ARWorldDataSize )


code: void ClientUpdatePreviewImageData ( int32 Offset, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer )


code: void ClientUpdateARWorldData ( int32 Offset, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer )


description: whether this player can start receiving the ar world data

code: bool IsReadyToReceive() const


description: Tells the server it is ready for receiving any shared world data

code: void ServerMarkReadyForReceiving()


code: AARSharedWorldPlayerController ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AARSharedWorldPlayerController

code: class AARSharedWorldPlayerController : public [APlayerController](API\Runtime\Engine\GameFramework\APlayerController)


code: AARSkyLight ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AARSkyLight

description: This sky light class forces a refresh of the cube map data when an AR environment probe changes

code: class AARSkyLight : public [ASkyLight](API\Runtime\Engine\Engine\ASkyLight)


description: Sets the environment capture probe that this sky light is driven by

code: void SetEnvironmentCaptureProbe ( [UAREnvironmentCaptureProbe](API\Runtime\AugmentedReality\UAREnvironmentCaptureProbe) * InCaptureProbe )


code: template<typename VertexType> static void CalculateVertexNormals ( [TArray](API\Runtime\Core\Containers\TArray)< [FAccumulatedNormal](API\Runtime\AugmentedReality\FAccumulatedNormal) > & AccumulatedNormals, const [TArray](API\Runtime\Core\Containers\TArray)< VertexType > & Vertices, const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & Indices, [TArray](API\Runtime\Core\Containers\TArray)< [FPackedNormal](API\Runtime\RenderCore\FPackedNormal) > & OutTangentData, FVector MeshCenter, float PositionScale )


className: FAccumulatedNormal

code: struct FAccumulatedNormal

Normal

type: FVector


description: whether the task succeeded or not

code: bool HadError() const


description: whether the task has completed or not

code: bool IsDone() const


description: information about the error if there was one


className: FARAsyncTask

description: Base class for async AR requests

code: class FARAsyncTask

Error

type: FString


className: FARCameraIntrinsics

description: AR camera intrinsics

code: struct FARCameraIntrinsics

FocalLength

description: Camera focal length in pixels

ImageResolution

type: FIntPoint

description: Camera image resolution in pixels

PrincipalPoint

description: Camera principal point in pixels


className: FAREnvironmentProbeUpdatePayload

code: struct FAREnvironmentProbeUpdatePayload

WorldTransform

type: FTransform


description: the candidate object that you can use for detection later

code: virtual [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * GetCandidateObject()


code: FARErrorGetCandidateObjectAsyncTask ( [FString](API\Runtime\Core\Containers\FString) InError )


className: FARErrorGetCandidateObjectAsyncTask

code: class FARErrorGetCandidateObjectAsyncTask : public [FARGetCandidateObjectAsyncTask](API\Runtime\AugmentedReality\FARGetCandidateObjectAsyncTask)


code: FARErrorSaveWorldAsyncTask ( [FString](API\Runtime\Core\Containers\FString) InError )


className: FARFaceUpdatePayload

code: struct FARFaceUpdatePayload

SessionPayload

type: FARSessionPaylo...


className: FARErrorSaveWorldAsyncTask

code: class FARErrorSaveWorldAsyncTask : public [FARSaveWorldAsyncTask](API\Runtime\AugmentedReality\FARSaveWorldAsyncTask)


className: FARGeoAnchorUpdatePayload

code: struct FARGeoAnchorUpdatePayload

AltitudeSource

type: EARAltitudeSour...


className: FARGetCandidateObjectAsyncTask

description: Async task that builds a candidate object used for detection from the ar session

code: class FARGetCandidateObjectAsyncTask : public [FARAsyncTask](API\Runtime\AugmentedReality\FARAsyncTask)


className: FARGetCandidateObjectPin

code: class FARGetCandidateObjectPin


className: FARImageUpdatePayload

code: struct FARImageUpdatePayload

DetectedImage

type: TObjectPtr<UAR...


className: FARMeshUpdatePayload

code: struct FARMeshUpdatePayload

ObjectClassification

type: EARObjectClassi...


className: FARPlaneUpdatePayload

code: struct FARPlaneUpdatePayload

BoundaryVertices

type: TArray< FVector...


className: FARObjectUpdatePayload

code: struct FARObjectUpdatePayload


description: Represents a human pose tracked in the 2D space

code: struct FARPose2D

IsJointTracked

type: TArray< bool >

description: Flags indicating if each joint is tracked

JointLocations

description: The location of each joint in 2D normalized space

SkeletonDefinition

type: FARSkeletonDefi...

description: The definition of this skeleton


className: FARPointUpdatePayload

code: struct FARPointUpdatePayload


description: Represents a human pose tracked in the 3D space

code: struct FARPose3D

JointTransforms

type: TArray< FTransf...

description: The transform of each join in the model space

JointTransformSpace

type: EARJointTransfo...

description: The definition of this skeleton


className: FARPoseUpdatePayload

code: struct FARPoseUpdatePayload


className: FARQRCodeUpdatePayload

code: struct FARQRCodeUpdatePayload


description: the byte array that the world was saved into. Note uses MoveTemp() for efficiency so only valid once

code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > GetSavedWorldData()


className: FARSaveWorldPin

code: class FARSaveWorldPin


code: void FromSessionConfig ( const [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) & InConfig )


className: FARSaveWorldAsyncTask

description: Async task that saves the world data into a buffer

code: class FARSaveWorldAsyncTask : public [FARAsyncTask](API\Runtime\AugmentedReality\FARAsyncTask)


code: bool HasFlag ( EARSessionConfigFlags InFlag ) const


code: void SetFlag ( EARSessionConfigFlags InFlag )


code: bool ShouldCreateMeshComponent() const


className: FARSessionPayload

code: struct FARSessionPayload

DefaultMeshMaterial

type: TObjectPtr<UMa...


code: FARSessionStatus ( EARSessionStatus InStatus, [FString](API\Runtime\Core\Containers\FString) InExtraInfo )


className: FARSessionStatus

description: The current state of the AR subsystem including an optional explanation string.

code: struct FARSessionStatus

AdditionalInfo

description: Optional information about the current status of the system.

Status

type: EARSessionStatu...

description: The current status of the AR subsystem.


code: FARSharedWorldReplicationState()


className: FARSkeletonDefinition

description: Represents a hierarchy of a human pose skeleton tracked by the AR system

code: struct FARSkeletonDefinition

JointNames

type: TArray<FName>

description: The name of each joint in this skeleton

NumJoints

description: How many joints this skeleton has

ParentIndices

type: TArray< int32 >

description: The parent index of each joint in this skeleton


className: FARSharedWorldReplicationState

description: Per player information about what data has been sent to them

code: struct FARSharedWorldReplicationState

ARWorldOffset

description: The offset in the overall ARWorld data buffer

PreviewImageOffset

description: The offset in the overall image data buffer


description: UARBlueprintLibrary::AddEnvironmentCaptureProbe()

code: bool AddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate & Delegate )


description: Pass through helpers to create the methods needed to add/remove delegates from the AR system.

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate & Delegate )


description: UARBlueprintLibrary::AddRuntimeCandidateImage()

code: [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * AddRuntimeCandidateImage ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CandidateTexture, [FString](API\Runtime\Core\Containers\FString) FriendlyName, float PhysicalWidth )


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate & Delegate )


description: UARBlueprintLibrary::AddTrackedPointWithName()

code: bool AddTrackedPointWithName ( const FTransform & WorldTransform, const [FString](API\Runtime\Core\Containers\FString) & PointName, bool bDeletePointsWithSameName )


code: bool ArePinsReadyToLoad()


code: void ClearOnTrackableAddedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: void ClearOnTrackableRemovedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: void ClearOnTrackableUpdatedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: void ClearOnTrackableAddedDelegates ( void * Object )


code: void ClearOnTrackableRemovedDelegates ( void * Object )


code: void ClearOnTrackableUpdatedDelegates ( void * Object )


code: const FTransform & GetAlignmentTransform() const


description: UARBlueprintLibrary::GetAllPins()

code: [TArray](API\Runtime\Core\Containers\TArray)< [UARPin](API\Runtime\AugmentedReality\UARPin) * > GetAllPins() const


description: UARBlueprintLibrary::GetAllTrackedGeometries()

code: [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * > GetAllTrackedGeometries() const


description: UARBlueprintLibrary::GetARSessionStatus()


code: void * GetARSessionRawPointer()


description: UARBlueprintLibrary::GetCameraIntrinsics()

code: bool GetCameraIntrinsics ( [FARCameraIntrinsics](API\Runtime\AugmentedReality\FARCameraIntrinsics) & OutCameraIntrinsics ) const


description: UARBlueprintLibrary::GetARTexture()

code: [UARTexture](API\Runtime\AugmentedReality\UARTexture) * GetARTexture ( EARTextureType TextureType ) const


description: UARBlueprintLibrary::GetCurrentLightEstimate()

code: [UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate) * GetCurrentLightEstimate() const


description: Creates an async task that will perform the work in the background

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARGetCandidateObjectAsyncTask](API\Runtime\AugmentedReality\FARGetCandidateObjectAsyncTask), ESPMode::ThreadSafe > GetCandidateObject ( FVector Location, FVector Extent ) const


code: void * GetGameThreadARFrameRawPointer()


description: UARBlueprintLibrary::GetNumberOfTrackedFacesSupported()


description: the current point cloud data for the ar scene

code: [TArray](API\Runtime\Core\Containers\TArray)< FVector > GetPointCloud() const


description: Overload this method to report a name for your referencer

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReferencerName() const


code: const [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) & GetSessionConfig() const


description: UARBlueprintLibrary::GetSupportedVideoFormats()

code: [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > GetSupportedVideoFormats ( EARSessionType SessionType ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FARPose2D](API\Runtime\AugmentedReality\FARPose2D) > GetTracked2DPose() const


description: UARBlueprintLibrary::GetTrackingQuality()


description: UARBlueprintLibrary::GetTrackingQualityReason()


description: the current mapping status


description: UARBlueprintLibrary::IsARSupported()

code: bool IsARAvailable() const


description: UARBlueprintLibrary::IsEnvironmentCaptureSupported()


code: void InitializeARSystem()


code: bool IsLocalPinSaveSupported() const


description: UARBlueprintLibrary::IsSessionTrackingFeatureSupported()

code: bool IsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature ) const


description: UARBlueprintLibrary::IsSceneReconstructionSupported()

code: bool IsSceneReconstructionSupported ( EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod ) const


description: UARBlueprintLibrary::IsSessionTypeSupported()

code: bool IsSessionTypeSupported ( EARSessionType SessionType ) const


description: UARBlueprintLibrary::LineTraceTrackedObjects()

code: [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > LineTraceTrackedObjects ( const FVector2D ScreenCoords, EARLineTraceChannels TraceChannels )


code: void LoadARPins ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [UARPin](API\Runtime\AugmentedReality\UARPin) * > & LoadedPins )


description: UARBlueprintLibrary::PauseARSession()

code: void PauseARSession()


code: [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > LineTraceTrackedObjects ( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels )


description: UARBlueprintLibrary::PinComponentToTraceResult()

code: [UARPin](API\Runtime\AugmentedReality\UARPin) * PinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & HitResult, const [FName](API\Runtime\Core\UObject\FName) DebugName )


description: Pin Interface

code: bool PinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


description: UARBlueprintLibrary::PinComponent()

code: [UARPin](API\Runtime\AugmentedReality\UARPin) * PinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const FTransform & PinToWorldTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, const [FName](API\Runtime\Core\UObject\FName) DebugName )


description: UARBlueprintLibrary::RemovePin()

code: void RemovePin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * PinToRemove )


code: void RemoveAllSavedARPins()


code: void RemoveSavedARPin ( [FName](API\Runtime\Core\UObject\FName) InName )


code: bool SaveARPin ( [FName](API\Runtime\Core\UObject\FName) InName, [UARPin](API\Runtime\AugmentedReality\UARPin) * InPin )


description: UARBlueprintLibrary::ToggleARCapture()

code: void SetEnabledXRCamera ( bool bOnOff )


description: IARSystemSupport.

code: void SetAlignmentTransform ( const FTransform & InAlignmentTransform )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSaveWorldAsyncTask](API\Runtime\AugmentedReality\FARSaveWorldAsyncTask), ESPMode::ThreadSafe > SaveWorld() const


code: bool StartARGameFrame ( [FWorldContext](API\Runtime\Engine\Engine\FWorldContext) & WorldContext )


description: UARBlueprintLibrary::StartARSession()

code: void StartARSession ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * InSessionConfig )


description: UARBlueprintLibrary::ToggleARCapture()

code: bool ToggleARCapture ( const bool bOnOff, const EARCaptureType CaptureType )


description: UARBlueprintLibrary::StopARSession()

code: void StopARSession()


code: FARSupportInterface ( [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * InARImplementation, [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) * InXRTrackingSystem )


description: UARBlueprintLibrary::ToggleARCapture()

code: FIntPoint ResizeXRCamera ( const FIntPoint & InSize )


code: virtual ~FARSupportInterface()


code: bool TryGetOrCreatePinForNativeResource ( void * InNativeResource, const [FString](API\Runtime\Core\Containers\FString) & InAnchorName, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutAnchor )


description:
Pin a component to an existing ARPin. If the component is alreayd pinned it will first be removed from that pin, which will be left empty. If the target Pin is already in use the component previously pinned to it will be unpinned.
true if the operation was successful

code: virtual bool OnPinComponentToARPin ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


className: FARSupportInterface

description: Composition Components for tracking system features

code: class FARSupportInterface : public [TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)

OnAlignmentTransformUpdated

type: FARSystemOnAlig...

OnARSessionStarted

type: FARSystemOnSess...


className: FARSystemSupportBase

code: class FARSystemSupportBase : public [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport)


className: FARTraceResultComparer

code: struct FARTraceResultComparer


code: bool operator&40;&41; &40; const FARTraceResult & A, const FARTraceResult & B &41; const


code: float GetDistanceFromCamera() const


code: FTransform GetLocalTransform() const


code: [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * GetTrackedGeometry() const


code: void SetLocalToWorldTransform ( const FTransform & LocalToWorldTransform )


code: FARTraceResult ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InARSystem, float InDistanceFromCamera, EARLineTraceChannels InTraceChannel, const FTransform & InLocalToTrackingTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * InTrackedGeometry )


className: FARTraceResult

description: A result of an intersection found during a hit-test.

code: struct FARTraceResult


code: bool operator== ( const [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) & Other ) const


code: FARVideoFormat ( int32 InFPS, int32 InWidth, int32 InHeight )


className: FARVideoFormat

description: A specific AR video format

code: struct FARVideoFormat

FPS

description: The desired or supported number of frames per second for this video format

Height

description: The desired or supported height in pixels for this video format

Width

description: The desired or supported width in pixels for this video format


description: Finish the task with an error.

code: void FinishWithError ( const [FString](API\Runtime\Core\Containers\FString) & InError )


className: FCheckGeoTrackingAvailabilityAsyncTask

description: Async task to check Geo tracking availability.

code: class FCheckGeoTrackingAvailabilityAsyncTask : public [FARAsyncTask](API\Runtime\AugmentedReality\FARAsyncTask)


code: bool IsAvailable() const


description: the altitude of the converted Geo location.

code: float GetAltitude() const


description: Finish the task with a Geo location.

code: void FinishWithGeoLocation ( float InLongitude, float InLatitude, float InAltitude )


description: the longitude of the converted Geo location.

code: float GetLongitude() const


description: Finish the task with the availability result.

code: void FinishWithAvailability ( bool bInIsAvailable )


description: the latitude of the converted Geo location.

code: float GetLatitude() const


className: FGetGeoLocationAsyncTask

description: Async task to convert Geo location.

code: class FGetGeoLocationAsyncTask : public [FARAsyncTask](API\Runtime\AugmentedReality\FARAsyncTask)


className: FOnARTransformUpdated

code: class FOnARTransformUpdated


className: FOnARTrackingStateChanged

code: class FOnARTrackingStateChanged


className: FTrackableDelegate

code: class FTrackableDelegate


className: FTrackableFaceDelegate

code: class FTrackableFaceDelegate


className: FTrackableEnvProbeDelegate

code: class FTrackableEnvProbeDelegate


className: FTrackableImageDelegate

code: class FTrackableImageDelegate


className: FTrackableObjectDelegate

code: class FTrackableObjectDelegate


className: FTrackablePointDelegate

code: class FTrackablePointDelegate


className: FTrackablePlaneDelegate

code: class FTrackablePlaneDelegate


code: FTrackedGeometryGroup ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * InTrackedGeometry )


className: FTrackedGeometryGroup

code: struct FTrackedGeometryGroup

ARActor

type: TObjectPtr<AAR...


className: IARRef

description: A reference to a system-level AR object

code: class IARRef


code: void OnSerializeSessionConfig ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SerializedARCandidateImageDatabase )


className: IARSessionConfigCookSupport

code: class IARSessionConfigCookSupport : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate & Delegate )


code: virtual bool ArePinsReadyToLoad()


code: virtual void ClearOnTrackableAddedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnTrackableUpdatedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnTrackableAddedDelegates ( void * Object )


code: virtual void ClearOnTrackableRemovedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnTrackableRemovedDelegates ( void * Object )


code: virtual void ClearOnTrackableUpdatedDelegates ( void * Object )


description: Given a scene component find the ARPin which it is pinned by, if any.

code: [UARPin](API\Runtime\AugmentedReality\UARPin) * FindARPinByComponent ( const [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component ) const


code: void * GetARSessionRawPointer()


code: void * GetGameThreadARFrameRawPointer()


description: Returns true/false based on whether AR features are available

code: bool IsARAvailable() const


description: ARPin Local Store support. Some Platforms/Devices have the ability to persist AR Anchors (real world positiosn) to the device or user account. They are saved and loaded with a string identifier.

code: virtual bool IsLocalPinSaveSupported() const


description: Tells the ARSystem to generate a capture probe at the specified location if supported

code: bool OnAddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )


code: virtual void LoadARPins ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [UARPin](API\Runtime\AugmentedReality\UARPin) * > & LoadedPins )


description:
Add candidate image at runtime
True if it added the iamge successfully

code: bool OnAddRuntimeCandidateImage ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CandidateTexture, [FString](API\Runtime\Core\Containers\FString) FriendlyName, float PhysicalWidth )


code: virtual bool OnAddTrackedPointWithName ( const FTransform & WorldTransform, const [FString](API\Runtime\Core\Containers\FString) & PointName, bool bDeletePointsWithSameName )


description: Invoked after the base AR system has been initialized.

code: virtual void OnARSystemInitialized()


description: aTArrayof all the tracked geometries known to your ar system

code: [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * > OnGetAllTrackedGeometries() const


description: aTArrayof all the pins that attach components to TrackedGeometries

code: [TArray](API\Runtime\Core\Containers\TArray)< [UARPin](API\Runtime\AugmentedReality\UARPin) * > OnGetAllPins() const


description: the info about whether the session is running normally or encountered some kind of error.


code: virtual bool OnGetCameraIntrinsics ( [FARCameraIntrinsics](API\Runtime\AugmentedReality\FARCameraIntrinsics) & OutCameraIntrinsics ) const


description: the AR texture for the specified type

code: virtual [UARTexture](API\Runtime\AugmentedReality\UARTexture) * OnGetARTexture ( EARTextureType TextureType ) const


description: the best available light estimate; nullptr if light estimation is inactive or not available

code: [UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate) * OnGetCurrentLightEstimate() const


description: Generates aUARCandidateObjectfrom the point cloud data within the location and its extent using an async task

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARGetCandidateObjectAsyncTask](API\Runtime\AugmentedReality\FARGetCandidateObjectAsyncTask), ESPMode::ThreadSafe > OnGetCandidateObject ( FVector Location, FVector Extent ) const


description: the max number of faces can be tracked at the same time

code: virtual int32 OnGetNumberOfTrackedFacesSupported() const


description: the current point cloud data for the ar scene

code: [TArray](API\Runtime\Core\Containers\TArray)< FVector > OnGetPointCloud() const


description: The list of supported video formats for this device and session type

code: [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > OnGetSupportedVideoFormats ( EARSessionType SessionType ) const


description: all the tracked 2D poses in AR

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FARPose2D](API\Runtime\AugmentedReality\FARPose2D) > OnGetTracked2DPose() const


description: the current mapping status


description: the tracking quality; if unable to determine tracking quality, return EARTrackingQuality::NotAvailable


description: the reason of limited tracking quality; if the state is not limited, return EARTrackingQualityReason::None


description: the required scene construction method is supported

code: virtual bool OnIsSceneReconstructionSupported ( EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod ) const


description: if a particular session feature is supported on this device

code: virtual bool OnIsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature ) const


description: whether the specified tracking type is supported by this device

code: bool OnIsTrackingTypeSupported ( EARSessionType SessionType ) const


description:
Trace all the tracked geometries and determine which have been hit by a ray cast fromScreenCoord_. Only geometries specified inTraceChannels_ are considered.
a list of all the geometries that were hit, sorted by distance

code: [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > OnLineTraceTrackedObjects ( const FVector2D ScreenCoord, EARLineTraceChannels TraceChannels )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > OnLineTraceTrackedObjects ( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels )


description: Stop the AR system but leave its internal state intact.

code: void OnPauseARSession()


description:
Pin an Unreal Component to a location in the world. Optionally, associate with a TrackedGeometry to receive transform updates that effectively attach the component to the geometry.
theUARPinobject that is pinning the component to the world and (optionally) a TrackedGeometry

code: [UARPin](API\Runtime\AugmentedReality\UARPin) * OnPinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const FTransform & PinToWorldTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, const [FName](API\Runtime\Core\UObject\FName) DebugName )


description:
Pin a component to an existing ARPin. If the component is alreayd pinned it will first be removed from that pin, which will be left empty. If the target Pin is already in use the component previously pinned to it will be unpinned.
true if the operation was successful

code: bool OnPinComponentToARPin ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


description: Given a pin, remove it and stop updating the associated component based on the tracked geometry. The component in question will continue to track with the world, but will not get updates specific to a TrackedGeometry.

code: void OnRemovePin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * PinToRemove )


code: virtual FIntPoint OnResizeXRCamera ( const FIntPoint & InSize )


description: Set a transform that will align the Tracking Space origin to the World Space origin. This is useful for supporting static geometry and static lighting in AR. Note: Usually, an app will ask the user to select an appropriate location for some experience. This allows us to choose an appropriate alignment transform.

code: void OnSetAlignmentTransform ( const FTransform & InAlignmentTransform )


description: Saves the AR world to a byte array using an async task

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSaveWorldAsyncTask](API\Runtime\AugmentedReality\FARSaveWorldAsyncTask), ESPMode::ThreadSafe > OnSaveWorld() const


code: virtual void OnSetEnabledXRCamera ( bool bOnOff )


code: virtual bool OnStartARGameFrame ( [FWorldContext](API\Runtime\Engine\Engine\FWorldContext) & WorldContext )


description:
Start the AR system.
true if the system was successfully started

code: void OnStartARSession ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig )


description: Stop the AR system and reset its internal state; this task must succeed.

code: void OnStopARSession()


code: virtual bool OnToggleARCapture ( const bool bOnOff, const EARCaptureType CaptureType )


description:
Given the platform specific native resource for a pin, create a pin.
true when a pin is successfully created, otherwise false

code: virtual bool OnTryGetOrCreatePinForNativeResource ( void * InNativeResource, const [FString](API\Runtime\Core\Containers\FString) & InPinName, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutPin )


code: virtual void RemoveAllSavedARPins()


code: virtual void RemoveSavedARPin ( [FName](API\Runtime\Core\UObject\FName) InName )


code: virtual bool SaveARPin ( [FName](API\Runtime\Core\UObject\FName) InName, [UARPin](API\Runtime\AugmentedReality\UARPin) * InPin )


code: virtual void TriggerOnTrackableAddedDelegates ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Param1 )


code: virtual void TriggerOnTrackableRemovedDelegates ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Param1 )


code: virtual void TriggerOnTrackableUpdatedDelegates ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Param1 )


code: virtual ~IARSystemSupport()


className: IARSystemSupport

description:
* [TrackingSpace]--(AlignmentTransform)-->[AlignedTrackingSpace]--(TrackingToWorld)-->[WorldSpace]
*

code: class IARSystemSupport


code: static const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & GetARSystem()


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if object is ready to be ticked, false otherwise.

code: virtual bool IsTickable() const


code: static void RegisterAsARSystem ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & NewArSystem )


className: RegisteredARSystem

code: static [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > RegisteredARSystem = nullptr;


code: virtual void ReportFailure()


code: virtual void ReportSuccess()


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


code: UARBaseAsyncTaskBlueprintProxy ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UARBaseAsyncTaskBlueprintProxy

code: class UARBaseAsyncTaskBlueprintProxy : public [UBlueprintAsyncActionBase](API\Runtime\Engine\Kismet\UBlueprintAsyncActionBase), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)

AsyncTask

type: TSharedPtr<FAR...

description: The async task to check duringTick()


code: float GetAmbientIntensityLumens() const


code: void SetLightEstimate ( FVector InRGBScaleFactor, float InPixelIntensity )


code: void SetLightEstimate ( float InAmbientIntensityLumens, float InColorTemperatureKelvin )


code: void SetLightEstimate ( float InColorTemperatureKelvin, [FLinearColor](API\Runtime\Core\Math\FLinearColor) InAmbientColor )


className: UARBasicLightEstimate

code: class UARBasicLightEstimate : public [UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate)


description: Adds an environment capture probe to the ar world

code: static bool AddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )


description: Static helpers to create the methods needed to add/remove delegates from the AR system.

code: static [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate & Delegate )


code: static [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate & Delegate )


code: static [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate & Delegate )


description:
On ARCore platform, you can leave the PhysicalWidth to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.
A `UARCandidateImage_ Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

code: static [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * AddRuntimeCandidateImage ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CandidateTexture, [FString](API\Runtime\Core\Containers\FString) FriendlyName, float PhysicalWidth )


description:
Manually add a tracked point with name and world transform. : transform in the world space where the point should be created. : the name of the created point, must be non-empty. : if existing points with the same name should be deleted.
if the operation succeeds. Note that this is an async operation - the added point won't be available until a few frames later.

code: static bool AddTrackedPointWithName ( const FTransform & WorldTransform, const [FString](API\Runtime\Core\Containers\FString) & PointName, bool bDeletePointsWithSameName )


description: Computes a transform that aligns two coordinate systems. Requires the transform of the same known point in each coordinate system.

code: static void CalculateAlignmentTransform ( const FTransform & TransformInFirstCoordinateSystem, const FTransform & TransformInSecondCoordinateSystem, FTransform & AlignmentTransform )


description: Alignment helpers.

code: static void CalculateClosestIntersection ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & StartPoints, const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & EndPoints, FVector & ClosestIntersection )


code: static void ClearOnTrackableAddedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: static void ClearOnTrackableUpdatedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: static void ClearOnTrackableAddedDelegates ( void * Object )


code: static void ClearOnTrackableRemovedDelegates ( void * Object )


code: static void ClearOnTrackableUpdatedDelegates ( void * Object )


description: Given a `UARPin_, draw it for debugging purposes.

code: static void DebugDrawPin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPin, [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [FLinearColor](API\Runtime\Core\Math\FLinearColor) Color, float Scale, float PersistForSeconds )


description: Given some real-world geometry being tracked by the Augmented Reality system, draw it on the screen for debugging purposes (rudimentary)

code: static void DebugDrawTrackedGeometry ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [FLinearColor](API\Runtime\Core\Math\FLinearColor) Color, float OutlineThickness, float PersistForSeconds )


description: a list of the tracked points with the given name

code: static [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedPoint](API\Runtime\AugmentedReality\UARTrackedPoint) * > FindTrackedPointsByName ( const [FString](API\Runtime\Core\Containers\FString) & PointName )


description: the alignment transform, see "SetAlignmentTransform"


description: a list of all the real-world geometry as currently seen by the Augmented Reality system

code: static [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * > GetAllGeometries()


description: a list of all the real-world geometry of the specified class as currently seen by the Augmented Reality system

code: static [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * > GetAllGeometriesByClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) > GeometryClass )


code: template<class T> static [TArray](API\Runtime\Core\Containers\TArray)< T * > GetAllGeometriesByClass()


code: static void ClearOnTrackableRemovedDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


description: Get a list of all the `UARPin_ objects that the Augmented Reality session is currently using to connect virtual objects to real-world, tracked locations.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [UARPin](API\Runtime\AugmentedReality\UARPin) * > GetAllPins()


description: all the 2D poses tracked by the AR system

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FARPose2D](API\Runtime\AugmentedReality\FARPose2D) > GetAllTracked2DPoses()


description:
It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly. e.g. if the session stopped for an unexpected reason, you might give the user a prompt to re-start the session
The status of a current Augmented Reality session: e.g. Running or Not running for a specific reason.


description: the AR texture for the specified type

code: static [UARTexture](API\Runtime\AugmentedReality\UARTexture) * GetARTexture ( EARTextureType TextureType )


description: the AR world scale, see "SetARWorldScale"

code: static float GetARWorldScale()


description: the intrinsics of the AR camera.

code: static bool GetCameraIntrinsics ( [FARCameraIntrinsics](API\Runtime\AugmentedReality\FARCameraIntrinsics) & OutCameraIntrinsics )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARGetCandidateObjectAsyncTask](API\Runtime\AugmentedReality\FARGetCandidateObjectAsyncTask), ESPMode::ThreadSafe > GetCandidateObject ( FVector Location, FVector Extent )


description:
An AugmentedReality session can be configured to provide light estimates. The specific approach to light estimation can be configured by the[UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig)_ specified duringStartARSession(). This function assumes that you will cast the returned[UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate)_ to a derived type corresponding to your session config.
aUARLighEstimatethat can be cast to a derived class.

code: static [UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate) * GetCurrentLightEstimate()


description: the max number of faces can be tracked at the same time


code: static bool GetObjectClassificationAtLocation ( const FVector & InWorldLocation, EARObjectClassification & OutClassification, FVector & OutClassificationLocation, float MaxLocationDiff )


description: the raw point cloud view of the AR scene

code: static [TArray](API\Runtime\Core\Containers\TArray)< FVector > GetPointCloud()


description: the configuration that the current session was started with.

code: static [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * GetSessionConfig()


description: The list of supported video formats for this device

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > GetSupportedVideoFormats ( EARSessionType SessionType )


description: how well the tracking system is performing at the moment


description: The reason for the current limited tracking state


description: the current world mapping status for the AR world


description:
Is ARPin Local Store Supported
True if Local Pin saving is supported by the device/platform.


description:
Is ARPin Local Store Ready
True if local store is ready for use.

code: static bool IsARPinLocalStoreReady()


description: Checks if the current device can support AR

code: static bool IsARSupported()


description: if a particular scene reconstruction method is supported with the specified session type on the current platform

code: static bool IsSceneReconstructionSupported ( EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod )


description: if a particular session feature is supported with the specified session type on the current platform

code: static bool IsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature )


description: Test whether this type of session is supported by the current Augmented Reality platform. e.g. is your device capable of doing positional tracking or orientation only?

code: static bool IsSessionTypeSupported ( EARSessionType SessionType )


description:
Perform a line trace against any real-world geometry as tracked by the AR system.
a list of `FARTraceResult_ sorted by distance from camera.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > LineTraceTrackedObjects ( const FVector2D ScreenCoord, bool bTestFeaturePoints, bool bTestGroundPlane, bool bTestPlaneExtents, bool bTestPlaneBoundaryPolygon )


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > LineTraceTrackedObjects3D ( const FVector Start, const FVector End, bool bTestFeaturePoints, bool bTestGroundPlane, bool bTestPlaneExtents, bool bTestPlaneBoundaryPolygon )


description:
Load all ARPins from local save Note: Multiple loads of a saved pin may result in duplicate pins OR overwritten pins. It is reccomended to only load once.
Map of SaveName:ARPin.

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [UARPin](API\Runtime\AugmentedReality\UARPin) * > LoadARPinsFromLocalStore()


description: Pause a running Augmented Reality session without clearing existing state.

code: static void PauseARSession()


description:
Pin an Unreal Component to a location in tracking spce (i.e. the real world).
an object representing the pin that connectsComponentToPin_ component to a real-world location and optionally to theTrackedGeometry_.

code: static [UARPin](API\Runtime\AugmentedReality\UARPin) * PinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const FTransform & PinToWorldTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, const [FName](API\Runtime\Core\UObject\FName) DebugName )


description:
Associate a component with an ARPin, so that its transform will be updated by the pin. Any previously associated component will be detached.
True if the operation was successful.

code: static bool PinComponentToARPin ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


description: A convenient version of[PinComponent()](API\Runtime\AugmentedReality\UARBlueprintLibrary\PinComponent)_ that can be used in conjunction with a result of aLineTraceTrackedObjects_ call.

code: static [UARPin](API\Runtime\AugmentedReality\UARPin) * PinComponentToTraceResult ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult, const [FName](API\Runtime\Core\UObject\FName) DebugName )


code: static void RegisterAsARSystem ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & NewArSystem )


code: static [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > RegisteredARSystem = nullptr;


description: Remove all ARPins from the local store


description: Remove an ARPin from the local store

code: static void RemoveARPinFromLocalStore ( [FName](API\Runtime\Core\UObject\FName) InSaveName )


description: Remove a pin such that it no longer updates the associated component.

code: static void RemovePin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * PinToRemove )


description:
Save an ARPin to local store
True if saved successfully.

code: static bool SaveARPinToLocalStore ( [FName](API\Runtime\Core\UObject\FName) InSaveName, [UARPin](API\Runtime\AugmentedReality\UARPin) * InPin )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSaveWorldAsyncTask](API\Runtime\AugmentedReality\FARSaveWorldAsyncTask), ESPMode::ThreadSafe > SaveWorld()


description: PinComponentToTraceResult

code: static void SetAlignmentTransform ( const FTransform & InAlignmentTransform )


description: Helper function that modifies the alignment transform scale so that virtual content in the world space appears to be "scaled". Note that ultimately the scaling effect is achieved through modifying the translation of the camera: moving the camera further away from the origin makes objects appear to be smaller, and vice versa.

code: static void SetARWorldScale ( float InWorldScale )