className: operator^

code: constexpr [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) operator^ ( [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) Lhs, [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) Rhs )


className: operator^=

module: AVCodecsCore

code: [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) & operator^= ( [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) & Lhs, [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) Rhs )


className: operator!

code: constexpr bool operator! ( [EPictureUsage](API\Plugins\AVCodecsCore\Video\Decoders\Configs\EPictureUsage) E )


description: True if this decoder has been initialized by sending through a packet.

code: bool IsInitialized() const


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance )


description: FAVResult.

code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReceiveFrame ( [TResolvableVideoResource](API\Plugins\AVCodecsCore\Video\TResolvableVideoResource)< TResource > & InOutResource )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendPacket ( [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) const & Packet )


code: virtual void SetMinimalConfig ( [FVideoDecoderConfig](API\Plugins\AVCodecsCore\Video\FVideoDecoderConfig) const & MinimalConfig )


className: TStreamVideoDecoder

description: Configuration-less decoder that detects the bitstream type and creates an appropriate child decoder that can handle it.

code: template<typename TResource> class TStreamVideoDecoder : public [TVideoDecoder< TResource >](API\Plugins\AVCodecsCore\Video\TVideoDecoder_TResource)

Child

type: TSharedPtr<TVi...

description: The child decoder, invalid until this decoder is initialized by sending through a packet.


className: EMultipassMode

code: enum EMultipassMode { Unknown, Disabled, Quarter, Full, }


code: FVideoEncoderConfigH264 ( [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) Preset )


description: Configuration settings for H264 encoders.

code: struct FVideoEncoderConfigH264 : public [FVideoEncoderConfig](API\Plugins\AVCodecsCore\Video\FVideoEncoderConfig)

RepeatSPSPPS

type: bool


code: FVideoEncoderConfigH265 ( [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) Preset )


description: Configuration settings for H265 encoders.

code: struct FVideoEncoderConfigH265 : public [FVideoEncoderConfig](API\Plugins\AVCodecsCore\Video\FVideoEncoderConfig)


className: ERateControlMode

description: Implementation of Video Encoding domain, seeTAVCoderfor inheritance model

code: enum ERateControlMode { Unknown, ConstQP, VBR, CBR, }


className: EVideoFormat

code: enum EVideoFormat { BGRA = EPixelFormat::PF_B8G8R8A8, ABGR10 = EPixelFormat::PF_A2B10G10R10, NV12 = EPixelFormat::PF_NV12, P010 = EPixelFormat::PF_P010, R8 = EPixelFormat::PF_R8, G16 = EPixelFormat::PF_G16, YUV444 = 254U, YUV444_16 = 255U, }


code: FVideoDecoderConfig ( [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) Preset )


className: FVideoDecoderConfig

description: Implementation of Video Decoding domain, seeTAVCoderfor inheritance model

code: struct FVideoDecoderConfig : public [FAVConfig](API\Plugins\AVCodecsCore\FAVConfig)


description: Planar formats are treated as single channel.

code: uint8 GetNumChannels() const


description: TODO(Nick): Try and remove this in favour of external initialisation.

code: uint32 GetSizeInBytes() const


code: bool operator== ( [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & RHS ) const


code: bool operator!= ( [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & RHS ) const


code: FVideoDescriptor ( const [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) & Descriptor )


code: FVideoDescriptor ( [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) Format, uint32 Width, uint32 Height )


code: FVideoDescriptor ( [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) Format, uint32 Width, uint32 Height, const [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) & RawDescriptor )


className: FVideoDescriptor

description: This struct defines how the allocated resource memory is used in the context of a video.

code: struct FVideoDescriptor

Format

type: EVideoFormat

description: Format of the pixel data.

Height

description: Height in pixels.

RawDescriptor

type: FVideoDescripto...

description: If this is a descriptor stored in a different format than it really is for transport then its raw descriptor should be described in this variable

Width

description: Width in pixels.


code: FVideoEncoderConfig ( [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) Preset )


className: FVideoEncoderConfig

code: struct FVideoEncoderConfig : public [FAVConfig](API\Plugins\AVCodecsCore\FAVConfig)

bFillData

type: uint8:  1

KeyframeInterval

description: TODO (Remove and derive from latency mode)

MultipassMode

type: EMultipassMode

RateControlMode

type: ERateControlMod...


code: FVideoPacket ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< uint8 > const & DataPtr, uint64 DataSize, uint64 Timestamp, uint64 Index, uint32 QP, bool bIsKeyframe )


description: Get the descriptor of our video data.

code: [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & GetDescriptor() const


className: FVideoPacket

description: Video-specific packet container.

code: struct FVideoPacket : public [FAVPacket](API\Plugins\AVCodecsCore\FAVPacket)

bIsKeyframe

description: Whether this frame is a keyframe.

QP

description: QP that the raw data was encoded with.


description: Get the Size in bytes of our Resource.

code: uint32 GetSize() const


description: Get the format of our data.


description: Get the height of our data.

code: uint32 GetHeight() const


description: Get the descriptor of our video data in device memory.

code: [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & GetRawDescriptor() const


description: Get the width of our data.

code: uint32 GetWidth() const


code: FVideoResource ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


className: FVideoResource

description: Base wrapper for a video device resource.

code: class FVideoResource : public [FAVResource](API\Plugins\AVCodecsCore\FAVResource)


className: operator==

code: bool operator== ( EPixelFormat LHS, [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) RHS )


code: bool operator== ( [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) LHS, EPixelFormat RHS )


className: operator!=

code: bool operator!= ( EPixelFormat LHS, [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) RHS )


code: bool operator!= ( [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) LHS, EPixelFormat RHS )


className: FVideoContextCPU

description: CPU video context and resource.

code: class FVideoContextCPU : public [FAVContext](API\Plugins\AVCodecsCore\FAVContext)


code: FVideoContextVulkan ( VkInstance const & Instance, VkDevice const & Device, VkPhysicalDevice const & PhysicalDevice, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< PFN_vkVoidFunction(const char *)> const & GetDeviceProcAddrFunc )


className: FVideoContextVulkan

description: Vulkan platform video context and resource.

code: class FVideoContextVulkan : public [FAVContext](API\Plugins\AVCodecsCore\FAVContext)

Device

type: VkDevice

Instance

type: VkInstance

PhysicalDevice

type: VkPhysicalDevic...

vkGetDeviceProcAddr

type: TFunction< PFN_...


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< uint8 > const & GetRaw() const


description: FAVResult.

code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Validate() const


code: FVideoResourceCPU ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< uint8 > const & Raw, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


code: virtual ~FVideoResourceCPU()


className: FVideoResourceCPU

code: class FVideoResourceCPU : public [TVideoResource< FVideoContextCPU >](API\Plugins\AVCodecsCore\Video\TVideoResource)


code: [FVulkanSharedHandle](API\Plugins\AVCodecsCore\Video\Resources\FVulkanSharedHandle) const & GetFenceSharedHandle() const


code: VkDeviceMemory GetRaw() const


code: [FVulkanSharedHandle](API\Plugins\AVCodecsCore\Video\Resources\FVulkanSharedHandle) const & GetSharedHandle() const


code: FVideoResourceVulkan ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, VkDeviceMemory Raw, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


code: virtual ~FVideoResourceVulkan()


className: FVideoResourceVulkan

code: class FVideoResourceVulkan : public [TVideoResource< FVideoContextVulkan >](API\Plugins\AVCodecsCore\Video\TVideoResource)


className: FVulkanSharedHandle

code: typedef int FVulkanSharedHandle


className: TDelegatedVideoResource

description: Wrapper for delegated resolvable video resources.

code: typedef [TDelegated](API\Plugins\AVCodecsCore\TDelegated)< TResource, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) >, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) > TDelegatedVideoResource


code: virtual bool IsResolved ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor ) const


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< TResource > TryResolve ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


className: TPooledVideoResource

description: A simple pool-based resolvable video resource. The contents of the pool must be manually managed by the application.

code: template<typename TResource> class TPooledVideoResource : public [TResolvable< TResource >](API\Plugins\AVCodecsCore\TResolvable)

Pool

type: TArray<TShared...


className: TResolvableVideoResource

description: Wrapper for resolvable video resources.

code: typedef [TResolvable](API\Plugins\AVCodecsCore\TResolvable)< TResource, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) >, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) > TResolvableVideoResource


description: Set generic configuration values.

code: virtual void SetMinimalConfig ( [FVideoDecoderConfig](API\Plugins\AVCodecsCore\Video\FVideoDecoderConfig) const & MinimalConfig )


code: virtual FAVResult ReceiveFrame &40; TResolvableVideoResource< TResource > & InOutResource &41;


code: virtual FAVResult SendPacket &40; FVideoPacket const & Packet &41;


code: TWrapper &40; TSharedRef< TVideoDecoder< TChildResource, TChildConfig >> const & Child &41;


className: TWrapper

description: Wrapper decoder that transforms resource/config types for use with a differently typed child decoder.

code: template<typename TChildResource, typename TChildConfig> class TWrapper : public TAVCoder::template TWrapper< TChildResource, TChildConfig >


description:
Get generic configuration values.
The current minimal configuration.


className: TVideoDecoder

description: TAVCodec

code: template<typename TResource, typename TConfig> class TVideoDecoder : public [TAVCoder< TVideoDecoder, TResource, TConfig >](API\Plugins\AVCodecsCore\TAVCoder)


description: FAVResult.

code: FAVResult FlushFrames&40;&41;


description: Set generic configuration values.

code: void SetMinimalConfig &40; FVideoDecoderConfig const & MinimalConfig &41;


description: FAVResult.

code: FAVResult SendPacket &40; FVideoPacket const & Packet &41;


className: TVideoDecoder<>

description: TAVCodec

code: template<> class TVideoDecoder<> : public [TAVCoder< TVideoDecoder >](API\Plugins\AVCodecsCore\TAVCoder)


description: FAVResult.

code: FAVResult ReceiveFrame &40; TResolvableVideoResource< TResource > & InOutResource &41;


className: TVideoDecoder< TResource >

description: TAVCodec

code: template<typename TResource> class TVideoDecoder< TResource >


description: Set generic configuration values.

code: virtual void SetMinimalConfig ( [FVideoEncoderConfig](API\Plugins\AVCodecsCore\Video\FVideoEncoderConfig) const & MinimalConfig )


code: virtual FAVResult ReceivePacket &40; FVideoPacket & OutPacket &41;


code: virtual FAVResult SendFrame &40; TSharedPtr< TResource > const & Resource, uint32 Timestamp, bool bForceKeyframe &41;


code: TWrapper &40; TSharedRef< TVideoEncoder< TChildResource, TChildConfig >> const & Child &41;


description: Wrapper encoder that transforms resource/config types for use with a differently typed child encoder.


className: TVideoEncoder

description: TAVCodec

code: template<typename TResource, typename TConfig> class TVideoEncoder : public [TAVCoder< TVideoEncoder, TResource, TConfig >](API\Plugins\AVCodecsCore\TAVCoder)


description: FAVResult.

code: FAVResult ReceivePacket &40; FVideoPacket & OutPacket &41;


description: FAVResult.

code: virtual FAVResult ReceivePackets &40; TArray< FVideoPacket > & OutPackets &41;


description: Set generic configuration values.

code: void SetMinimalConfig &40; FVideoEncoderConfig const & MinimalConfig &41;


className: TVideoEncoder<>

description: TAVCodec

code: template<> class TVideoEncoder<> : public [TAVCoder< TVideoEncoder >](API\Plugins\AVCodecsCore\TAVCoder)


description: FAVResult.

code: FAVResult FlushAndReceivePackets &40; TArray< FVideoPacket > & OutPackets &41;


description: FAVResult.

code: FAVResult FlushPackets&40;&41;


className: TVideoEncoder< TResource >::SendFrame

description: FAVResult.

code: FAVResult SendFrame &40; TSharedPtr< TResource > const & Resource, uint32 Timestamp, bool bForceKeyframe &41;


className: TVideoEncoder< TResource >

description: TAVCodec

code: template<typename TResource> class TVideoEncoder< TResource >


code: TVideoResource ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


className: TVideoResource

description: Convenience wrapper for a video device resource that requires a specific device context to function.

code: template<typename TContext> class TVideoResource : public [FVideoResource](API\Plugins\AVCodecsCore\Video\FVideoResource)


module: AVCodecsCoreRHI

code: operator FAudioEncoderConfig() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< TContext > GetContext() const


code: FSimpleAudioEncoderConfig ( [ESimpleAVPreset](API\Plugins\AVCodecsCoreRHI\ESimpleAVPreset) Preset )


code: FSimpleAudioEncoderConfig ( [FAudioEncoderConfig](API\Plugins\AVCodecsCore\Audio\FAudioEncoderConfig) const & From )


className: FSimpleAudioEncoderConfig


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") void Close()


description: Configuration.


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") bool IsAsync() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") bool IsOpen() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") bool Open ( [ESimpleAudioCodec](API\Plugins\AVCodecsCoreRHI\Audio\ESimpleAudioCodec) Codec, [FSimpleAudioEncoderConfig](API\Plugins\AVCodecsCoreRHI\Audio\Encoders\FSimpleAudioEncoderConfig) Config, bool bAsynchronous )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") bool ReceivePacket ( [FSimpleAudioPacket](API\Plugins\AVCodecsCoreRHI\Audio\FSimpleAudioPacket) & OutPacket )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") void ReceivePackets ( [TArray](API\Runtime\Core\Containers\TArray)< [FSimpleAudioPacket](API\Plugins\AVCodecsCoreRHI\Audio\FSimpleAudioPacket) > & OutPackets )


code: bool SendFrame ( [Audio::TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer)< float > const & Resource, double Timestamp )


code: bool SendFrame ( float const * ResourceData, double Timestamp, int32 NumSamples, float SampleDuration )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio", Meta=(DisplayName="Send Frame (PCM16)")) bool SendFrameFloat ( [TArray](API\Runtime\Core\Containers\TArray)< float > const & Resource, double Timestamp, int32 NumSamples, float SampleDuration )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Audio") void SetConfig ( [FSimpleAudioEncoderConfig](API\Plugins\AVCodecsCoreRHI\Audio\Encoders\FSimpleAudioEncoderConfig) NewConfig )


className: USimpleAudioEncoder

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable) class USimpleAudioEncoder : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FRunnable](API\Runtime\Core\HAL\FRunnable)


className: ESimpleAudioCodec

code: enum ESimpleAudioCodec { AAC = 0, }


className: FSimpleAudioPacket

RawPacket

type: FAudioPacket


code: static [ESimpleAudioCodec](API\Plugins\AVCodecsCoreRHI\Audio\ESimpleAudioCodec) GuessCodec ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & Instance )


className: USimpleAudioHelper

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class USimpleAudioHelper : public [USimpleAVHelper](API\Plugins\AVCodecsCoreRHI\USimpleAVHelper)


className: ESimpleAVPreset

code: enum ESimpleAVPreset { Default, UltraLowQuality, LowQuality, HighQuality, Lossless, }


code: static [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) ConvertPreset ( [ESimpleAVPreset](API\Plugins\AVCodecsCoreRHI\ESimpleAVPreset) From )


description: FAVResult.


code: virtual bool IsOpen() const


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance )


className: USimpleAVHelper

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class USimpleAVHelper : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReceiveFrame ( [TResolvableVideoResource](API\Plugins\AVCodecsCore\Video\TResolvableVideoResource)< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI) > & InOutResource )


code: template<typename TChildConfig> static FVideoDecoder::TFactory< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI), TConfig > & Register()


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendPacket ( [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) const & Packet )


className: TVideoDecoderRHI

code: template<typename TConfig> class TVideoDecoderRHI : public [TVideoDecoder< FVideoResourceRHI, TConfig >](API\Plugins\AVCodecsCore\Video\TVideoDecoder)


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") void Close()


description: Configuration.


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool IsAsync() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool IsOpen() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool Open ( [ESimpleVideoCodec](API\Plugins\AVCodecsCoreRHI\Video\ESimpleVideoCodec) Codec, bool bAsynchronous )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool ReceiveFrame ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * Resource )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool SendPacket ( [FSimpleVideoPacket](API\Plugins\AVCodecsCoreRHI\Video\FSimpleVideoPacket) const & Packet )


className: USimpleVideoDecoder

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable) class USimpleVideoDecoder : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FRunnable](API\Runtime\Core\HAL\FRunnable)


code: operator FVideoEncoderConfig() const


code: FSimpleVideoEncoderConfig ( [ESimpleAVPreset](API\Plugins\AVCodecsCoreRHI\ESimpleAVPreset) Preset )


code: FSimpleVideoEncoderConfig ( [FVideoEncoderConfig](API\Plugins\AVCodecsCore\Video\FVideoEncoderConfig) const & From )


className: FSimpleVideoEncoderConfig


description: FAVResult.


code: virtual bool IsOpen() const


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReceivePacket ( [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) & OutPacket )


code: template<typename TChildConfig> static FVideoEncoder::TFactory< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI), TConfig > & Register()


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendFrame ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI) > const & Resource, uint32 Timestamp, bool bForceKeyframe )


className: TVideoEncoderRHI

code: template<typename TConfig> class TVideoEncoderRHI : public [TVideoEncoder< FVideoResourceRHI, TConfig >](API\Plugins\AVCodecsCore\Video\TVideoEncoder)


description: Configuration.


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool Open ( [ESimpleVideoCodec](API\Plugins\AVCodecsCoreRHI\Video\ESimpleVideoCodec) Codec, [FSimpleVideoEncoderConfig](API\Plugins\AVCodecsCoreRHI\Video\Encoders\FSimpleVideoEncoderConfig) Config, bool bAsynchronous )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") bool ReceivePacket ( [FSimpleVideoPacket](API\Plugins\AVCodecsCoreRHI\Video\FSimpleVideoPacket) & OutPacket )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") void ReceivePackets ( [TArray](API\Runtime\Core\Containers\TArray)< [FSimpleVideoPacket](API\Plugins\AVCodecsCoreRHI\Video\FSimpleVideoPacket) > & OutPackets )


code: bool SendFrame ( FTextureRHIRef const & Resource, double Timestamp, bool bForceKeyframe )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video", Meta=(DisplayName="Send Frame (Render Target)")) bool SendFrameRenderTarget ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * Resource, double Timestamp, bool bForceKeyframe )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video") void SetConfig ( [FSimpleVideoEncoderConfig](API\Plugins\AVCodecsCoreRHI\Video\Encoders\FSimpleVideoEncoderConfig) NewConfig )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video", Meta=(DisplayName="Send Frame (Texture)")) bool SendFrameTexture ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * Resource, double Timestamp, bool bForceKeyframe )


className: USimpleVideoEncoder

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable) class USimpleVideoEncoder : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FRunnable](API\Runtime\Core\HAL\FRunnable)


className: ESimpleVideoCodec

code: enum ESimpleVideoCodec { H264 = 0, H265 = 1, }


className: FSimpleVideoPacket

type: FVideoPacket


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI) > TryResolve ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


className: FResolvableVideoResourceRHI

code: class FResolvableVideoResourceRHI : public [TResolvable< FVideoResourceRHI >](API\Plugins\AVCodecsCore\TResolvable)

AdditionalFlags

type: ETextureCreateF...


className: FVideoContextRHI

code: class FVideoContextRHI : public [FAVContext](API\Plugins\AVCodecsCore\FAVContext)


code: void CopyFrom ( TArrayView64< uint8 > const & From )


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


code: void CopyFrom ( TArray64< uint8 > const & From )


code: void CopyFrom ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > const & From )


code: void CopyFrom ( FTextureRHIRef const & From )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI) > Create ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor, ETextureCreateFlags AdditionalFlags, bool bIsSRGB )


className: FRawData

code: struct FRawData

Fence

type: FGPUFenceRHIRef

Texture

type: FTextureRHIRef


code: static [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) GetDescriptorFrom ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, FTextureRHIRef const & Raw )


code: static [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) GetLayoutFrom ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, FTextureRHIRef const & Raw )


code: [FRawData](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI\FRawData) const & GetRaw() const


description: Lock this resource for internal use. Is a blocking call until the lock can be taken.

code: virtual void Lock()


description:
Lock this resource for internal use, within the current scope. Is a blocking call until the lock can be taken.
The lock object. Capture this, because when it goes out of scope it will unlock the resource.


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceRHI](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI) > TransformResource ( [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & OutDescriptor )


code: void TransformResourceTo ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTextureRHIRef Target, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & OutDescriptor )


description: FAVResult.

code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Validate() const


code: FVideoResourceRHI ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FRawData](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI\FRawData) const & Raw )


code: FVideoResourceRHI ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, [FRawData](API\Plugins\AVCodecsCoreRHI\Video\Resources\FVideoResourceRHI\FRawData) const & Raw, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & OverrideDescriptor )


code: virtual ~FVideoResourceRHI()


className: FVideoResourceRHI

code: class FVideoResourceRHI : public [TVideoResource< FVideoContextRHI >](API\Plugins\AVCodecsCore\Video\TVideoResource)


code: static [ESimpleVideoCodec](API\Plugins\AVCodecsCoreRHI\Video\ESimpleVideoCodec) GuessCodec ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & Instance )


className: USimpleVideoHelper

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class USimpleVideoHelper : public [USimpleAVHelper](API\Plugins\AVCodecsCoreRHI\USimpleAVHelper)


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Video", Meta=(WorldContext="WorldContext")) static void ShareRenderTarget2D ( class [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * RenderTarget )


description: Default constructor.

module: AvfMediaFactory

code: UAvfMediaSettings()


className: UAvfMediaSettings

description: Settings for the AvfMedia plug-in.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine) class UAvfMediaSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

NativeAudioOut

description: Play audio tracks via the operating system's native sound mixer.


module: AvidDNxMedia

code: typedef struct DNXMXF_Writer DNXMXF_Writer


code: typedef struct _DNX_Encoder * DNX_Encoder


description: Finalize the video file and finish writing it to disk. Called by the destructor if not automatically called.

code: void Finalize()


description: Call to initialize the encoder. This must be done before attempting to write data to it.

code: bool Initialize()


description: Appends a new frame onto the output file.

code: bool WriteFrame ( const uint8 * InFrameData )


code: FAvidDNxEncoder ( const [FAvidDNxEncoderOptions](API\Plugins\AvidDNxMedia\AvidDNxEncoder\FAvidDNxEncoderOptions) & InOptions )


className: FAvidDNxEncoder

description: Encoder class that takes sRGB 8-bit RGBA data and encodes it to AvidDNxHR or AvidDNxHD before placing it in an mxf container. The mxf container writer currently implemented does not support audio, so audio writing APIs have been omitted from this encoder.

code: class FAvidDNxEncoder


className: FAvidDNxEncoderOptions

description: Options to initialize the AvidDNx encoder with. Choosing compression will choose the AvidDNxHR HD compression.

code: struct FAvidDNxEncoderOptions

bCompress

description: Should we use a compression codec or not

FrameRate

type: FFrameRate

description: Frame Rate of the output video.

Height

description: The height of the video file.

NumberOfEncodingThreads

description: Number of Encoding Threads. Must be at least 1.

OutputFilename

type: FString

description: The absolute path on disk to try and save the video file to.

Width

description: The width of the video file.


module: AxFImporter

code: IAxFFileImporter * CreateFileImporter()


code: static [IAxFImporterModule](API\Plugins\AxFImporter\IAxFImporterModule) & Get()


code: FAxFImporter & GetAxFImporter()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: ModuleName

code: static const TCHAR * ModuleName = TEXT("AxFImporter");


className: IAxFImporterModule

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


className: AzureSpatialAnchors

module: AzureSpatialAnchors

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


className: EAzureSpatialAnchorDataCategory

description: Note: this must match winrt::Microsoft::Azure::SpatialAnchors::AnchorDataCategory.

code: enum EAzureSpatialAnchorDataCategory { None = 0, Properties = 1, Spatial = 2, }


className: EAzureSpatialAnchorsLocateStrategy

description: Note: this must match winrt::Microsoft::Azure::SpatialAnchors::LocateStrategy.

code: enum EAzureSpatialAnchorsLocateStrategy { AnyStrategy = 0, VisualInformation = 1, Relationship = 2, }


className: EAzureSpatialAnchorsLocateAnchorStatus

description: Note: this must match winrt::Microsoft::Azure::SpatialAnchors::LocateAnchorStatus.

code: enum EAzureSpatialAnchorsLocateAnchorStatus { AlreadyTracked = 0, Located = 1, NotLocated = 2, NotLocatedAnchorDoesNotExist = 3, }


className: EAzureSpatialAnchorsLogVerbosity

description: Note: this must match winrt::Microsoft::Azure::SpatialAnchors::SessionLogLevel.

code: enum EAzureSpatialAnchorsLogVerbosity { None = 0, Error = 1, Warning = 2, Information = 3, Debug = 4, All = 5, }


className: EAzureSpatialAnchorsResult

description: Note: this Result enum must match AzureSpatialAnchorsInterop::AsyncResult in MixedRealityInterop.h.

code: enum EAzureSpatialAnchorsResult { Success, NotStarted, Started, FailAlreadyStarted, FailNoARPin, FailBadLocalAnchorID, FailBadCloudAnchorIdentifier, FailAnchorIdAlreadyUsed, FailAnchorDoesNotExist, FailAnchorAlreadyTracked, FailNoAnchor, FailNoCloudAnchor, FailNoLocalAnchor, FailNoSession, FailNoWatcher, FailNotEnoughData, FailBadLifetime, FailSeeErrorString, NotLocated, Canceled, FailUnknown, }


className: EAzureSpatialAnchorsSessionUserFeedback

description: Note: this must match winrt::Microsoft::Azure::SpatialAnchors::SessionUserFeedback.

code: enum EAzureSpatialAnchorsSessionUserFeedback { None = 0, NotEnoughMotion = 1, MotionTooQuick = 2, NotEnoughFeatures = 4, }


description: FGCObjectImplementation.

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


code: void CacheSessionStatus ( float, float, int, int, [EAzureSpatialAnchorsSessionUserFeedback](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsSessionUserF-) )


code: void AnchorLocatedCallback ( int32 WatcherIdentifier, int32 LocateAnchorStatus, [IAzureSpatialAnchors::CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) CloudAnchorID )


code: virtual bool ConstructCloudAnchor ( class [UARPin](API\Runtime\AugmentedReality\UARPin) *& InARPin, class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutCloudAnchor )


code: virtual void DestroySession()


code: [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * GetCloudAnchor ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) CloudAnchorID ) const


code: virtual bool GetCloudAnchor ( class [UARPin](API\Runtime\AugmentedReality\UARPin) *& InARPin, class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutCloudAnchor )


code: virtual void GetCloudAnchors ( [TArray](API\Runtime\Core\Containers\TArray)< class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * > & OutCloudAnchors )


code: virtual [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * GetOrConstructCloudAnchor ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) CloudAnchorID )


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

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


description: These functions provide basic housekeeping forAzureSpatialAnchors. The AzureSpatialAnchorsBase layer implements them.

code: virtual const [FAzureSpatialAnchorsSessionStatus](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionStatu-) & GetSessionStatus()


code: void SessionUpdatedCallback ( float ReadyForCreateProgress, float RecommendedForCreateProgress, int SessionCreateHash, int SessionLocateHash, int32 SessionUserFeedback )


code: void LocateAnchorsCompletedCallback ( int32 WatcherIdentifier, bool WasCanceled )


className: FAzureSpatialAnchorsBase

code: class FAzureSpatialAnchorsBase : public [IAzureSpatialAnchors](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)

CachedSessionStatus

type: FAzureSpatialAn...

CacheSessionHandle

type: FDelegateHandle

CloudAnchors

type: TArray<TObject...


className: FAzureSpatialAnchorsDiagnosticsConfig

bImagesEnabled

type: bool

LogLevel

type: EAzureSpatialAn...

MaxDiskSizeInMB

type: int


className: FAzureSpatialAnchorsLocateCriteria

bBypassCache

description: If true the device local cache of anchors is ignored.

bSearchNearDevice

description: Specify whether to search near the device location.

Identifiers

type: TArray<FString...

description: List of specific anchor identifiers to locate.

NearAnchor

type: TObjectPtr< cla...

description: Specify (optionally) an anchor around which to locate anchors.

NearAnchorDistance

type: float

description: Specify the distance at which to locate anchors near the NearAnchor, in cm.

NearAnchorMaxResultCount

description: Specify the maximum number of anchors around the NearAnchor to locate.

NearDeviceDistance

description: Specify the distance at which to locate anchors near the device, in cm.

NearDeviceMaxResultCount

description: Specify the maximum number of anchors around the device to locate.

RequestedCategories

description: Specify what data to retrieve.

Strategy

description: Specify the method by which anchors will be located.


className: FAzureSpatialAnchorsSessionStatus


className: FCoarseLocalizationSettings

bEnable

description: If true coarse localization will be active

bEnableGPS

description: If true GPS can be used for localization ("location" must also be enabled in Project Settings->Platforms->Hololens->Capabilities)

bEnableWifi

description: If true WiFi can be used for localization ("wiFiControl" must also be enabled in Project Settings->Platforms->Hololens->Capabilities)

BLEBeaconUUIDs

description: List of bluetooth beacon uuids that can be used for localization ("bluetooth" must also be enabled in Project Settings->Platforms->Hololens->Capabilities)


className: ASAAnchorLocatedDelegate


className: ASALocateAnchorsCompletedDelegate


className: ASASessionUpdatedDelegate


code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult)Result, const wchar_t *ErrorString)> Callback_Result


code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult)Result, const wchar_t *ErrorString, const wchar_t *InString)> Callback_Result_String


className: CloudAnchorID

code: typedef int32_t CloudAnchorID


code: static const [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) CloudAnchorID_Invalid = -1;


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) ConstructAnchor ( [UARPin](API\Runtime\AugmentedReality\UARPin) * InARPin, [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) & OutCloudAnchorID )


code: bool ConstructCloudAnchor ( class [UARPin](API\Runtime\AugmentedReality\UARPin) *& InARPin, class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutCloudAnchor )


code: void CreateAnchorAsync ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [Callback_Result](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result) Callback )


code: bool CreateARPinAroundAzureCloudSpatialAnchor ( const [FString](API\Runtime\Core\Containers\FString) & PinId, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * InAzureCloudSpatialAnchor, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutARPin )


code: void CreateDiagnosticsManifestAsync ( const [FString](API\Runtime\Core\Containers\FString) & Description, [Callback_Result_String](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result_String) Callback )


description: Functions that must be implemented per-platform.

code: void CreateNamedARPinAroundAnchor ( const [FString](API\Runtime\Core\Containers\FString) & LocalAnchorId, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutARPin )


description: These functions alias theAzureSpatialAnchorsAPI. They must be implemented for each platform.

code: bool CreateSession()


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) CreateWatcher ( const [FAzureSpatialAnchorsLocateCriteria](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsLocateCriter-) & InLocateCriteria, float InWorldToMetersScale, [WatcherID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\WatcherID) & OutWatcherID, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: void DeleteAnchorAsync ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [Callback_Result](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result) Callback )


code: void DestroySession()


code: void DisposeSession()


className: FASAAnchorLocatedDelegate

description: Delegates that will be cast by the ASA platform implementations. These delegates should only be fired from the game thread

code: typedef TMulticastDelegate_ThreeParams< void, int32, [EAzureSpatialAnchorsLocateAnchorStatus](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsLocateAnchor-), [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * > FASAAnchorLocatedDelegate


code: void DoTask &40; ENamedThreads::Type CurrentThread, const FGraphEventRef & MyCompletionGraphEvent &41;


code: static TStatId GetStatId&40;&41;


code: FASAAnchorLocatedTask &40; int32 InWatcherIdentifier, EAzureSpatialAnchorsLocateAnchorStatus InStatus, CloudAnchorID InCloudAnchorID, class IAzureSpatialAnchors & InIASA &41;


className: FASALocateAnchorsCompletedDelegate

description: WatcherIdentifier, canceled.

code: typedef TMulticastDelegate_TwoParams< void, int32, bool > FASALocateAnchorsCompletedDelegate


className: FASAAnchorLocatedTask

description: If an implementation generates events from a thread other than the game thread it should launch these tasks that will fire the delegates on the game thread

code: class FASAAnchorLocatedTask


code: FASALocateAnchorsCompletedTask &40; int32 InWatcherIdentifier, bool InWasCanceled &41;


className: FASALocateAnchorsCompletedTask

code: class FASALocateAnchorsCompletedTask


className: FASASessionUpdatedDelegate

description: ReadyForCreateProgress, RecommendedForCreateProgress, SessionCreateHash, SessionLocateHash, feedback.

code: typedef TMulticastDelegate_FiveParams< void, float, float, int, int, [EAzureSpatialAnchorsSessionUserFeedback](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsSessionUserF-) > FASASessionUpdatedDelegate


className: FASASessionUpdatedTask

code: class FASASessionUpdatedTask


code: FASASessionUpdatedTask &40; float InReadyForCreateProgress, float InRecommendedForCreateProgress, int InSessionCreateHash, int InSessionLocateHash, EAzureSpatialAnchorsSessionUserFeedback InFeedback &41;


code: static [IAzureSpatialAnchors](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors) * Get()


code: void GetAccessTokenWithAccountKeyAsync ( const [FString](API\Runtime\Core\Containers\FString) & AccountKey, [Callback_Result_String](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result_String) Callback )


code: void GetAccessTokenWithAuthenticationTokenAsync ( const [FString](API\Runtime\Core\Containers\FString) & AccountKey, [Callback_Result_String](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result_String) Callback )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetActiveWatchers ( [TArray](API\Runtime\Core\Containers\TArray)< [WatcherID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\WatcherID) > & OutWatcherIDs )


code: void GetAnchorPropertiesAsync ( const [FString](API\Runtime\Core\Containers\FString) & InCloudAnchorIdentifier, [Callback_Result_CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result_-_1) Callback )


code: bool GetCloudAnchor ( class [UARPin](API\Runtime\AugmentedReality\UARPin) *& InARPin, class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutCloudAnchor )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetCloudAnchorAppProperties ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & OutAppProperties )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetCloudAnchorExpiration ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, float & OutLifetimeInSeconds )


code: void GetCloudAnchors ( [TArray](API\Runtime\Core\Containers\TArray)< class [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * > & OutCloudAnchors )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetCloudSpatialAnchorIdentifier ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [FString](API\Runtime\Core\Containers\FString) & OutCloudAnchorIdentifier )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetConfiguration ( [FAzureSpatialAnchorsSessionConfiguration](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionConfi-) & OutConfig )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetLogLevel ( [EAzureSpatialAnchorsLogVerbosity](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsLogVerbosity) & OutLogVerbosity )


code: [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * GetOrConstructCloudAnchor ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) CloudAnchorID )


description: Virtual EAzureSpatialAnchorsResult GetSession() = 0; virtual EAzureSpatialAnchorsResult SetSession() = 0;

code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) GetSessionId ( [FString](API\Runtime\Core\Containers\FString) & OutSessionID )


description: These functions provide basic housekeeping forAzureSpatialAnchors. The AzureSpatialAnchorsBase layer implements them.


code: static bool IsAvailable()


code: void GetSessionStatusAsync ( [Callback_Result_SessionStatus](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result_-) Callback )


className: LogFunctionPtr

code: typedef void(* LogFunctionPtr


code: static void OnLog ( const wchar_t * LogMsg )


code: void RefreshAnchorPropertiesAsync ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [Callback_Result](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result) Callback )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) SetCloudAnchorAppProperties ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InAppProperties )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) SetCloudAnchorExpiration ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, float InLifetimeInSeconds )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) SetConfiguration ( const [FAzureSpatialAnchorsSessionConfiguration](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionConfi-) & InConfig )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) SetDiagnosticsConfig ( [FAzureSpatialAnchorsDiagnosticsConfig](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsDiagnosticsC-) & InConfig )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) SetLocationProvider ( const [FCoarseLocalizationSettings](API\Plugins\AzureSpatialAnchors\FCoarseLocalizationSettings) & InConfig )


code: [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) StopWatcher ( [WatcherID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\WatcherID) WatcherID )


code: void SubmitDiagnosticsManifestAsync ( const [FString](API\Runtime\Core\Containers\FString) & ManifestPath, [Callback_Result](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result) Callback )


className: WatcherID

code: typedef int32_t WatcherID


code: void UpdateAnchorPropertiesAsync ( [CloudAnchorID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\CloudAnchorID) InCloudAnchorID, [Callback_Result](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\Callback_Result) Callback )


code: static const [WatcherID](API\Plugins\AzureSpatialAnchors\IAzureSpatialAnchors\WatcherID) WatcherID_Invalid =-1;


code: virtual ~IAzureSpatialAnchors()


className: IAzureSpatialAnchors

description: UAzureSpatialAnchorsLibrary::LoadCloudAnchor/ FAzureSpatialAnchorsLoadCloudAnchorAction is the most complicated.  It creates a watcher then registers for the delegates so it can handle AnchorLocated and AnchorLocateCompleted events.

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


code: static const [AzureCloudAnchorID](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor\AzureCloudAnchorID) AzureCloudAnchorID_Invalid = -1;


className: AzureCloudAnchorID

description: The UE Cloud Anchor ID. This maps to a CloudSpatialAnchor within the microsoft api. It is unique per UE app instance. It is different from the CloudSpatialAnchorIdentifier, which uniquely identifies an anchor in the Azure cloud. This is not exposed to blueprint, blueprint should use theUAzureCloudSpatialAnchorobject as a whole.

code: typedef int AzureCloudAnchorID


description: The AppProperties dictionary of the cloud anchor.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > GetAppProperties() const


description: The Azure Cloud identifier of the spatial anchor is the persistent identifier by which a cloud anchor can be requested from the azure cloud service. Empty if the anchor has not been saved or loaded yet.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) [FString](API\Runtime\Core\Containers\FString) GetAzureCloudIdentifier() const


description: The Expiration time of the cloud anchor as seconds into the future.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) float GetExpiration() const


description: Set the AppProperties dictionary of the cloud anchor. You must call SaveCloudAnchor or UpdateCloudAnchorProperties before these will be persisted on azure.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) void SetAppProperties ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InAppProperties )


description: Set the Expiration time of the cloud anchor as seconds into the future. You must call SaveCloudAnchor or UpdateCloudAnchorProperties before this will be persisted on azure.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) void SetExpiration ( const float Lifetime )


className: UAzureCloudSpatialAnchor

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Experimental, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) class UAzureCloudSpatialAnchor : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

ARPin

type: TObjectPtr<UAR...

description: The ARPin with which this cloud anchor is associated, or null.

CloudAnchorID

type: AzureCloudAncho...


description: Delegates that will be cast by the ASA platform implementations.

code: class FASAAnchorLocatedDelegate


code: class FASASessionUpdatedDelegate


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


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


className: UAzureSpatialAnchorsEventComponent

description: AzureSpatialAnchorsEventComponent.h: Component to handle receiving notifications fromAzureSpatialAnchors

ASAAnchorLocatedDelegate

type: FASAAnchorLocat...

ASALocateAnchorsCompleteDelegate

type: FASALocateAncho...

ASASessionUpdatedDelegate

type: FASASessionUpda...


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(DeprecatedFunction, DeprecationMessage="ConfigSession is deprecated, use ConfigSession2 instead.")) static *staticbool ConfigSession ( const [FString](API\Runtime\Core\Containers\FString) & AccountId, const [FString](API\Runtime\Core\Containers\FString) & AccountKey, const [FCoarseLocalizationSettings](API\Plugins\AzureSpatialAnchors\FCoarseLocalizationSettings) CoarseLocalizationSettings, [EAzureSpatialAnchorsLogVerbosity](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsLogVerbosity) LogVerbosity )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid ConstructCloudAnchor ( [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPin, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool ConfigSession2 ( const [FAzureSpatialAnchorsSessionConfiguration](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionConfi-) & SessionConfiguration, const [FCoarseLocalizationSettings](API\Plugins\AzureSpatialAnchors\FCoarseLocalizationSettings) CoarseLocalizationSettings, [EAzureSpatialAnchorsLogVerbosity](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsLogVerbosity) LogVerbosity )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool CreateSession()


code: static *staticbool CreateARPinAroundAzureCloudSpatialAnchor ( [FString](API\Runtime\Core\Containers\FString) PinId, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * InAzureCloudSpatialAnchor, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutARPin )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid CreateWatcher ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [FAzureSpatialAnchorsLocateCriteria](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsLocateCriter-) & InLocateCriteria, int32 & OutWatcherIdentifier, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid DeleteCloudAnchor ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * CloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool DestroySession()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool GetCachedSessionStatus ( [FAzureSpatialAnchorsSessionStatus](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionStatu-) & OutStatus )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid GetCloudAnchor ( [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPin, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutAzureCloudSpatialAnchor )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid GetSessionStatus ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [FAzureSpatialAnchorsSessionStatus](API\Plugins\AzureSpatialAnchors\FAzureSpatialAnchorsSessionStatu-) & OutStatus, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid GetCloudAnchors ( [TArray](API\Runtime\Core\Containers\TArray)< [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * > & OutCloudAnchors )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid LoadCloudAnchor ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [FString](API\Runtime\Core\Containers\FString) CloudIdentifier, [FString](API\Runtime\Core\Containers\FString) PinId, [UARPin](API\Runtime\AugmentedReality\UARPin) *& OutARPin, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid RefreshCloudAnchorProperties ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * InAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid SaveCloudAnchor ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * InAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid SavePinToCloud ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPin, float Lifetime, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid SavePinToCloudWithAppProperties ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UARPin](API\Runtime\AugmentedReality\UARPin) * ARPin, float Lifetime, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InAppProperties, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) *& OutAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool StartSession()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AR|AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool StopSession()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticbool StopWatcher ( int32 InWatcherIdentifier )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="AzureSpatialAnchors", Meta=(Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", Keywords="azure spatial anchor hololens wmr pin ar all")) static *staticvoid UpdateCloudAnchorProperties ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UAzureCloudSpatialAnchor](API\Plugins\AzureSpatialAnchors\UAzureCloudSpatialAnchor) * InAzureCloudSpatialAnchor, [EAzureSpatialAnchorsResult](API\Plugins\AzureSpatialAnchors\EAzureSpatialAnchorsResult) & OutResult, [FString](API\Runtime\Core\Containers\FString) & OutErrorString )


className: UAzureSpatialAnchorsLibrary

description: A function library that provides static/Blueprint functions forAzureSpatialAnchors.


module: BackChannel

code: FBackChannelPacketType ( char A, char B, char C, char D )


className: FBackChannelPacketType

code: struct FBackChannelPacketType


description: Bind a delegate to a message address

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddRouteDelegate ( FStringView Path, FBackChannelRouteDelegate::FDelegate Delegate )


code: TBackChannelSharedPtr< [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) > CreatePacket()


description: Remove a delegate handle

code: void RemoveRouteDelegate ( FStringView Path, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & InHandle )


code: int SendPacket ( const TBackChannelSharedPtr< [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) > & Packet )


description: Set the specified send and receive buffer sizes, if supported

code: void SetBufferSizes ( int32 DesiredSendSize, int32 DesiredReceiveSize )


code: virtual ~IBackChannelConnection()


className: IBackChannelConnection

description: Declares the interface for a BackChannel connection

code: class IBackChannelConnection


description: Return the path of this packet (if supported)


description: Read an int32 from the message

code: int Read ( const TCHAR * Name, int32 & Value )


description: Read an int32 from the message

code: int Read ( const TCHAR * Name, float & Value )


description: Read a bool from the message

code: int Read ( const TCHAR * Name, bool & Value )


description: Read a string from the message

code: int Read ( const TCHAR * Name, [FString](API\Runtime\Core\Containers\FString) & Value )


description: Read aTArrayfrom the message

code: int Read ( const TCHAR * Name, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


description: Read a block of data from the message

code: int Read ( const TCHAR * InName, void * OutBlob, int32 MaxBlobSize, int32 & OutBlobSize )


description: Set the path of this packet (if supported)

code: int SetPath ( const TCHAR * InPath )


description: Write an int32 into the message

code: int Write ( const TCHAR * Name, const int32 Value )


description: Write an int32 into message

code: int Write ( const TCHAR * Name, const float Value )


description: Write a string into the message

code: int Write ( const TCHAR * Name, const TCHAR * Value )


description: Write a bool into the message

code: int Write ( const TCHAR * Name, const bool Value )


description: Write a string into the message

code: int Write ( const TCHAR * Name, const [FString](API\Runtime\Core\Containers\FString) & Value )


description: Write aTArrayinto the message

code: int Write ( const TCHAR * Name, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Value )


description: Write a block of data into the message

code: int Write ( const TCHAR * Name, const void * InBlob, int32 BlobSize )


code: virtual ~IBackChannelPacket()


className: IBackChannelPacket

description: Declares the interface for a BackChannel packet

code: class IBackChannelPacket


code: void AddElement ( const void * InData, const int32 InSize )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FBackChannelOSCBundle](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCBundle) > CreateFromBuffer ( const void * Data, int32 DataLength )


className: ElementData

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


className: BundleHeader

code: static const ANSICHAR * BundleHeader = "#bundle";


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetElement ( const int32 Index ) const


code: int32 GetElementCount() const


description: Return the total size in bytes of this message

code: virtual int32 GetSize() const


description: Return the type of this packet

code: virtual [OSCPacketType](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketType) GetType() const


code: [FBackChannelOSCBundle](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCBundle) & operator= ( [FBackChannelOSCBundle](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCBundle) && RHS )


description: Return a buffer with a copy of the contents of this packet

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< uint8 > WriteToBuffer() const


description: Write the contents of this packet into the specified buffer starting at an offset ofBuffer.Num()

code: virtual void WriteToBuffer ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer ) const


code: FBackChannelOSCBundle ( [OSCPacketMode](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketMode) InMode )


code: FBackChannelOSCBundle ( [FBackChannelOSCBundle](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCBundle) && RHS )


code: virtual ~FBackChannelOSCBundle()


className: FBackChannelOSCBundle

code: class FBackChannelOSCBundle : public [FBackChannelOSCPacket](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCPacket)

Elements

type: TArray<Element...

Mode

type: OSCPacketMode


description: Bind a delegate to a message address

code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddRouteDelegate ( FStringView Path, FBackChannelRouteDelegate::FDelegate Delegate )


code: virtual TBackChannelSharedPtr< [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) > CreatePacket()


description: Dispatch all queued messages

code: void DispatchMessages()


code: int32 GetMessageCountForPath ( const TCHAR * Path )


code: int32 GetMessageLimitForPath ( const TCHAR * Path )


description: Returns our connection state as determined by the underlying BackChannel connection

code: bool IsConnected() const


description: IBackChannelConnectionimplementation

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


description: Returns true if running in the background

code: bool IsThreaded() const


description: Checks for and dispatches any incoming messages. MaxTime is how long to wait if no data is ready to be read. This function is thread-safe and be called from a backfround thread manually or by callingStartReceiveThread()

code: void ReceiveAndDispatchMessages ( const float MaxTime )


code: void ReceiveMessages ( const float MaxTime )


code: void RemoveMessagesWithPath ( const TCHAR * Path, const int32 Num )


description: Remove a delegate handle

code: virtual void RemoveRouteDelegate ( FStringView Path, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & InHandle )


description: Exit

code: virtual uint32 Run()


code: virtual int SendPacket ( const TBackChannelSharedPtr< [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) > & Packet )


description: Send the provided OSC packet

code: bool SendPacket ( [FBackChannelOSCPacket](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCPacket) & Packet )


description: Sets the send and receive buffer sizes

code: virtual void SetBufferSizes ( int32 DesiredSendSize, int32 DesiredReceiveSize )


code: bool SendPacketData ( const void * Data, const int32 DataLen )


description: Set options for the specified message path

code: void SetMessageOptions ( const TCHAR * Path, int32 MaxQueuedMessages )


description: Exit

code: virtual void Stop()


code: FBackChannelOSCConnection ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IBackChannelSocketConnection](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection) > InConnection )


className: FBackChannelOSCConnection

description: A class that wraps an existing BackChannel connection and provides an OSC-focused interface and a background thread. Incoming messages are received on a background thread and queued untilDispatchMessages()is called. Outgoing messages are sent immediately

code: class FBackChannelOSCConnection : private [FRunnable](API\Runtime\Core\HAL\FRunnable), public [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection)

Connection

type: TSharedPtr<IBa...

DispatchMap

type: FBackChannelDis...

ExitRequested

type: FThreadSafeBool

ExpectedSizeOfNextPacket

description: How much data do we expect to receive next time? This is for OSC over TCP where the size of a packet is sent, then the packet

HasErrorState

description: Is the connection in an error state

MessageLimits

type: TMap<FString, ...

PacketMutex

type: FCriticalSectio...

PingTime

type: double

description: Time where we'll send a ping if no packets arrive to check the connection is alive

ReceiveBuffer

type: TArray< uint8 >

ReceivedDataSize

description: How much data has been received this check?

ReceivedPackets

type: TArray<TShared...


className: bIsLegacyConnection

code: static bool bIsLegacyConnection = false;


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FBackChannelOSCMessage](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCMessage) > CreateFromBuffer ( const void * Data, int32 DataLength )


description: Returns the number of arguments in this message

code: int32 GetArgumentCount() const


description: Return the size (plus padding) of all our arguments)

code: const int32 GetArgumentSize() const


description: Return our sizes for each item (plus any necessary padding)

code: void GetComponentSizes ( int32 & OutAddressSize, int32 & OutTagSize, int32 & OutBufferSize ) const


description: Returns the type of our next argument

code: TCHAR GetNextArgumentType() const


description: Returns the address of this packet

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


code: virtual [FBackChannelPacketType](API\Plugins\BackChannel\BackChannel\FBackChannelPacketType) GetProtocolID() const


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


description: Return our size (plus any necessary padding)

code: virtual int32 GetSize() const


description: Return our argument tags

code: const [FString](API\Runtime\Core\Containers\FString) & GetTags() const


description: Return our type

code: virtual [OSCPacketType](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketType) GetType() const


code: static bool IsLegacyConnection()


code: virtual bool IsReadable() const


description: Helper to check our read/write status

code: bool IsReading() const


code: virtual bool IsWritable() const


description: Helper to check our read/write status

code: bool IsWriting() const


description: Move operator

code: [FBackChannelOSCMessage](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCMessage) & operator= ( [FBackChannelOSCMessage](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCMessage) && RHS )


description: Read an int32 from our arguments

code: virtual int Read ( const TCHAR * InName, int32 & Value )


description: Read a float from our arguments

code: virtual int Read ( const TCHAR * InName, float & OutValue )


description: Read a bool from our arguments

code: virtual int Read ( const TCHAR * InName, bool & Value )


description: Read a string from our arguments.

code: virtual int Read ( const TCHAR * InName, [FString](API\Runtime\Core\Containers\FString) & OutValue )


description: Read data from the message into aTArray. It must have been serialized by the Read form forTArray(!). Note - data will be appended to the array.

code: virtual int Read ( const TCHAR * InName, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & DataArray )


description: Read aTArrayof type T from our arguments. This is a helper that reads an int for the size, then allocated and reads a blob of sizeof(t) * NumItems

code: template<typename T> int Read ( const TCHAR * InName, [TArray](API\Runtime\Core\Containers\TArray)< T > & DataArray )


description: Read a blob of data from our arguments

code: virtual int Read ( const TCHAR * InName, void * InBlob, int32 MaxBlobSize, int32 & OutBlobSize )


code: int ReadData ( void * InData, int32 InSize )


code: TCHAR ReadTag ( const TCHAR ExpectedTag, bool SuppressWarning )


code: int ReadTagAndData ( const TCHAR ExpectedTag, void * InData, int32 InSize )


description: Reset us for reading. The next argument read will be our first argument

code: void ResetRead()


code: static int32 RoundedArgumentSize ( int32 ArgSize )


description: Serialize helper that will read/write based on the open mode of this message

code: template<typename T> void Serialize ( const TCHAR * Name, T & Value )


code: void Serialize ( const TCHAR * Name, void * InBlob, int32 BlobSize )


code: int Serialize ( const TCHAR Code, void * InData, int32 InSize )


code: static void SetLegacyMode ( const bool bEnable )


description: Set our destination address

code: virtual int SetPath ( const TCHAR * Address )


description: Write a float to our arguments

code: virtual int Write ( const TCHAR * InName, const float Value )


description: Write a bool to our arguments

code: virtual int Write ( const TCHAR * InName, const bool Value )


description: Write a string to our arguments

code: virtual int Write ( const TCHAR * InName, const [FString](API\Runtime\Core\Containers\FString) & Value )


description: Write a string to our arguments

code: virtual int Write ( const TCHAR * InName, const TCHAR * Value )


description: Write aTArrayViewinto the message

code: template<typename T> int Write ( const TCHAR * InName, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const T > InValues )


code: virtual int Write ( const TCHAR * InName, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InValues )


description: Write an int32 into our arguments

code: virtual int Write ( const TCHAR * InName, const int32 Value )


description: Write a blob of data to our arguments

code: virtual int Write ( const TCHAR * InName, const void * InBlob, int32 BlobSize )


code: int WriteData ( const void * InData, int32 InSize )


code: int WriteTag ( const TCHAR Code )


code: int WriteTagAndData ( const TCHAR Code, const void * InData, int32 InSize )


description: Returns a buffer with the contents of this message. Data is padded per OSC requirements

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< uint8 > WriteToBuffer() const


description: Writes this message into the provided buffer at an offset ofBuffer.Num()

code: virtual void WriteToBuffer ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer ) const


code: FBackChannelOSCMessage ( [OSCPacketMode](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketMode) InMode )


code: FBackChannelOSCMessage ( const TCHAR * Address )


description: Move constructor

code: FBackChannelOSCMessage ( [FBackChannelOSCMessage](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCMessage) && RHS )


code: virtual ~FBackChannelOSCMessage()


className: FBackChannelOSCMessage

description: Any failed Reads() will result in the default value of the type (e.g. 0, 0.0, false, "") being returned.

code: class FBackChannelOSCMessage : public [FBackChannelOSCPacket](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCPacket), public [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket)

Address

type: FString

BufferIndex

type: int


description: Return the total size in bytes of this message

code: virtual int32 GetSize() const


description: Return the type of this packet

code: virtual [OSCPacketType](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketType) GetType() const


className: FBackChannelOSCNullPacket

code: class FBackChannelOSCNullPacket : public [FBackChannelOSCPacket](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCPacket)


description: Helper to construct a packet (and in the case of a bundle, any sub-packets) from the specified buffer

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FBackChannelOSCPacket](API\Plugins\BackChannel\BackChannel\Protocol\OSC\FBackChannelOSCPacket) > CreateFromBuffer ( const void * Data, int32 DataLength )


code: int32 GetSize() const


description: Return the type of this packet


description: Static helper to determine the type of packet (if any) at the specified address

code: static [OSCPacketType](API\Plugins\BackChannel\BackChannel\Protocol\OSC\OSCPacketType) GetType ( const void * Data, int32 DataLength )


description: Return a buffer with a copy of the contents of this packet

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


description: Write the contents of this packet into the specified buffer starting at an offset ofBuffer.Num()

code: void WriteToBuffer ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer ) const


code: virtual ~FBackChannelOSCPacket()


className: FBackChannelOSCPacket

description: Base class for OSC messages

code: class FBackChannelOSCPacket


className: OSCPacketType

code: enum OSCPacketType { Invalid, Message, Bundle, }


className: OSCPacketMode

code: enum OSCPacketMode { Read, Write, }


description: Close the connection

code: void Close()


description: Todo (agrant 2017/12/29): Should remove 'Connect' and instead return a connected (or null..) socket from the factory Start connecting to the specified port for incoming connections. Use WaitForConnection to check status.

code: bool Connect ( const TCHAR * InEndPoint )


description: Return stats about this connection

code: const [FConnectionStats](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection\FConnectionStats) & GetConnectionStats() const


className: FConnectionStats

code: struct FConnectionStats

LastSendTime

description: Time these events occurred

PacketsSent

description: Lifetime stats


description: Return the underlying socket (if any) for this connection


description: Todo - Proper stats

code: uint32 GetPacketsReceived() const


description: Returns true if this connection is connected to another

code: bool IsConnected() const


description: Start listening on the specified port for incoming connections. Use WaitForConnection to accept one.

code: bool Listen ( const int16 Port )


description: Returns true if this connection is currently listening for incoming connections

code: bool IsListening() const


description: Receive data from our connection. The returned value is the number of bytes read, to a max of BufferSize

code: int32 ReceiveData ( void * OutBuffer, const int32 BufferSize )


description: Send data via our connection

code: int32 SendData ( const void * InData, const int32 InSize )


description: Waits for an icoming or outgoing connection to be made

code: bool WaitForConnection ( double InTimeout, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IBackChannelSocketConnection](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection) >)> InDelegate )


code: IBackChannelSocketConnection()


code: virtual ~IBackChannelSocketConnection()


className: IBackChannelSocketConnection

description: Base class that describes a back-channel connection. The underlying behavior will depend on the type of connection that was requested from the factory

code: class IBackChannelSocketConnection


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelSocketConnection](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection) > CreateConnection ( const int32 Type )


code: static [IBackChannelTransport](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelTransport) * Get()


description: Set the specified send and receive buffer sizes, if supported

code: void SetBufferSizes ( int32 DesiredSendSize, int32 DesiredReceiveSize )


code: virtual ~IBackChannelTransport()


className: IBackChannelTransport

description: Main module and factory interface for Backchannel connections

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


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddRoute ( FStringView Path, FBackChannelRouteDelegate::FDelegate Delegate )


code: bool DispatchMessage ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: void RemoveRoute ( FStringView Path, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) DelegateHandle )


className: FBackChannelDispatchMap

code: class FBackChannelDispatchMap


code: virtual ~FBackChannelDispatchMap()


className: FBackChannelListenerDelegate

code: typedef TBaseDelegate_OneParam< bool, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IBackChannelSocketConnection](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection) > > FBackChannelListenerDelegate


description: Exit

code: virtual uint32 Run()


code: void Start ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IBackChannelSocketConnection](API\Plugins\BackChannel\BackChannel\Transport\IBackChannelSocketConnection) > InConnection, [FBackChannelListenerDelegate](API\Plugins\BackChannel\BackChannel\Utils\FBackChannelListenerDelegate) InDelegate )


description: Exit

code: virtual void Stop()


code: FBackChannelThreadedListener()


code: ~FBackChannelThreadedListener()


className: FBackChannelThreadedListener

description: BackChannelClient implementation.

code: class FBackChannelThreadedListener : public [FRunnable](API\Runtime\Core\HAL\FRunnable), public [TSharedFromThis< FBackChannelThreadedListener >](API\Runtime\Core\Templates\TSharedFromThis)


module: BaseCharacterFXEditor

code: virtual void ClearNotification()


description: Active tool name to display in the ViewportOverlay

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


code: virtual void ClearWarning()


description: Should be implemented in the concrete subclass since it will likely have to know where to look for UI resources.

code: virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetActiveToolIcon ( const [FString](API\Runtime\Core\Containers\FString) & Identifier ) const


description: Returns the mode's toolbox

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetInlineContent() const


description: Returns human readable name for the specific palette tool category

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetToolPaletteDisplayName ( [FName](API\Runtime\Core\UObject\FName) PaletteName ) const


description: Returns the Mode specific tabs in the mode toolbar

code: virtual void GetToolPaletteNames ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & InPaletteName ) const


description: Exclusive Tool Palettes only allow users to use tools from one palette at a time

code: virtual bool HasExclusiveToolPalettes() const


description: Informs the built-inFModeToolkitpalette building routines about how we want the toolbars to be set up

code: virtual bool HasIntegratedToolPalettes() const


description: FModeToolkit.

code: virtual void Init ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IToolkitHost](API\Editor\EditorFramework\Toolkits\IToolkitHost) > & InitToolkitHost, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UEdMode](API\Editor\UnrealEd\Tools\UEdMode) > InOwningMode )


code: void InvalidateCachedDetailPanelState ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * ChangedObject )


code: virtual void OnToolEnded ( [UInteractiveToolManager](API\Runtime\InteractiveToolsFramework\UInteractiveToolManager) * Manager, [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) * Tool )


description: FModeToolkit.

code: virtual void OnToolStarted ( [UInteractiveToolManager](API\Runtime\InteractiveToolsFramework\UInteractiveToolManager) * Manager, [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) * Tool )


description: Set/clear notification message area

code: virtual void PostNotification ( const [FText](API\Runtime\Core\Internationalization\FText) & Message )


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > PaletteNames_Standard = { ToolsTabName };


description: Set/clear warning message area

code: virtual void PostWarning ( const [FText](API\Runtime\Core\Internationalization\FText) & Message )


className: ToolsTabName

description: The editor can have multiple tabs in the mode toolbar. ToolsTabName is the "Tools" tab maintained by this base class. PaletteNames_Standard is the set of all tab names in the concrete editor. Set these in the concrete subclass when adding additional toolbar tabs

code: static const [FName](API\Runtime\Core\UObject\FName) ToolsTabName = TEXT("Tools");


code: void UpdateActiveToolProperties()


code: FBaseCharacterFXEditorModeToolkit()


code: ~FBaseCharacterFXEditorModeToolkit()


className: FBaseCharacterFXEditorModeToolkit

description: The editor mode toolkit is responsible for the panel on the side in the editor that shows mode and tool properties. Tool buttons would go inInit().

code: class FBaseCharacterFXEditorModeToolkit : public [FModeToolkit](API\Editor\UnrealEd\Toolkits\FModeToolkit)

ActiveToolIcon

type: constFSlateBru...

ActiveToolMessageHandle

type: FStatusBarMessa...

ActiveToolName

type: FText

description: Tool name, icon and message to display in viewport.

ToolDetailsContainer

type: TSharedPtr<SBo...

description: A container for the tool settings that is populated by the DetailsView managed inFModeToolkit.

ToolWarningArea

type: TSharedPtr<STe...

description: A place for tools to write out any warnings.

ViewportOverlayWidget

type: TSharedPtr<SWi...

description: Contains the widget container for the Accept/Cancel buttons, etc. for tools.


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > GetModeMenuCategory() const


description: Called by SLevelEditor to notify the toolbox about a new toolkit being hosted

code: virtual void OnToolkitHostingStarted ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IToolkit](API\Editor\EditorFramework\Toolkits\IToolkit) > & Toolkit )


description: Called by SLevelEditor to notify the toolbox about an existing toolkit no longer being hosted

code: virtual void OnToolkitHostingFinished ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IToolkit](API\Editor\EditorFramework\Toolkits\IToolkit) > & Toolkit )


code: void SetModeMenuCategory ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > MenuCategoryIn )


code: FBaseCharacterFXEditorModeUILayer ( const [IToolkitHost](API\Editor\EditorFramework\Toolkits\IToolkitHost) * InToolkitHost )


className: FBaseCharacterFXEditorModeUILayer

description: Handles the hosting of additional toolkits, such as the mode toolkit, within the CharacterFXEditor's toolkit.

code: class FBaseCharacterFXEditorModeUILayer : public [FAssetEditorModeUILayer](API\Editor\EditorFramework\Toolkits\FAssetEditorModeUILayer)

CharacterFXEditorMenuCategory

type: TSharedPtr<FWo...


className: FOnRegisterLayoutExtensions

description: Used by the EditorUISubsystem.

code: class FOnRegisterLayoutExtensions : public TBaseMulticastDelegate_OneParam< void, FLayoutExtender & >


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FBaseCharacterFXEditorModule

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


description: Called when a toolkit requests an overlay widget to be added to the viewport. Not relevant in the absence of a viewport.

code: virtual void AddViewportOverlayWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InViewportOverlayWidget )


description: Override this to create the concrete CharacterFXEditorModeUILayer.

code: virtual void CreateEditorModeUILayer()


description: Called fromFBaseAssetToolkit::CreateWidgets.

code: virtual void CreateEditorModeManager()


description: Called fromFBaseAssetToolkit::CreateWidgetsto populate ViewportClient, but otherwise only used in our own viewport delegate

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEditorViewportClient](API\Editor\UnrealEd\FEditorViewportClient) > CreateEditorViewportClient() const


description: Override this to get the Mode ID of the concrete CharacterFXEditorMode.

code: virtual FEditorModeID GetEditorModeId() const


description: Override this to provide the EdMode with any custom data it needs.

code: virtual void InitializeEdMode ( [UBaseCharacterFXEditorMode](API\Plugins\BaseCharacterFXEditor\UBaseCharacterFXEditorMode) * EdMode )


description: Called when this toolkit is requested to close. Returns false if closing should be prevented.

code: virtual bool OnRequestClose ( EAssetEditorCloseReason InCloseReason )


description: Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.


description: Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.


description: Perform any initialization that should happen after the basic toolkit needs are created for the asset editor. For example, if you would like to activate a mode that is not the default from a mode manager, do that here.

code: virtual void PostInitAssetEditor()


description: IToolkitinterface

code: virtual void RegisterTabSpawners ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > & TabManager )


description: Called when a toolkit requests the overlay widget to be removed.

code: virtual void RemoveViewportOverlayWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InViewportOverlayWidget )


code: FBaseCharacterFXEditorToolkit ( [UAssetEditor](API\Editor\UnrealEd\Tools\UAssetEditor) * InOwningAssetEditor, const [FName](API\Runtime\Core\UObject\FName) & ModuleName )


description: These allow the toolkit to add an accept/cancel overlay when needed. PopulateViewportOverlays is not helpful here because that gets called just once.

code: virtual void AddOverlayWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > OverlaidWidget )


className: FBaseCharacterFXEditorToolkit

description: The toolkit is supposed to act as the UI manager for the asset editor. It's responsible for setting up viewports and most toolbars, except for the internals of the mode panel. However, because the toolkit also sets up the mode manager, and much of the important state is held in the mode managed by the mode manager, the toolkit also ends up initializing the mode. Thus, theFBaseCharacterFXEditorToolkitends up being the central place for the CharacterFX Asset Editor setup.

code: class FBaseCharacterFXEditorToolkit : public [FBaseAssetToolkit](API\Editor\UnrealEd\Tools\FBaseAssetToolkit)

EditorMenuCategory

description: A default "CharacterFXEditor" category is created in RegisterTabSpawners. Override that function to set this to a concrete class type.

ModeUILayer

type: TSharedPtr<FBa...

description: Handles the hosting of additional toolkits, such as the mode toolkit.

ObjectScene

type: TUniquePtr<FPr...

description: PreviewScene showing the objects being edited.


description: SEditorViewport.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeViewportToolbar()


code: virtual void RemoveOverlayWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > OverlaidWidget )


className: SBaseCharacterFXEditorViewport

code: class SBaseCharacterFXEditorViewport : public [SAssetEditorViewport](API\Editor\UnrealEd\SAssetEditorViewport)


description: If you override this function, call this base version to set up Accept/Cancel buttons.

code: virtual void RegisterCommands()