code: void OnSignallingRemoteIceCandidate ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const [FString](API\Runtime\Core\Containers\FString) & SdpMid, int SdpMLineIndex, const [FString](API\Runtime\Core\Containers\FString) & Sdp )


module: PixelStreaming

code: void OnSignallingSessionDescription ( webrtc::SdpType Type, const [FString](API\Runtime\Core\Containers\FString) & Sdp )


description: Streamer-only.

code: void OnSignallingSessionDescription ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, webrtc::SdpType Type, const [FString](API\Runtime\Core\Containers\FString) & Sdp )


code: void OnSignallingSFUPeerDataChannels ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) SFUId, [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, int32 SendStreamId, int32 RecvStreamId )


description: Player-only.

code: void OnSignallingStreamerList ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & StreamerList )


description:
Create an audio input that can be used to push audio into the Pixel Streaming mix. Note: Requires launching with -PixelStreamingExperimentalAudioInput.
The audio input to push to.


description: Callback interface for `FPixelStreamingSignallingConnection_


className: FOnInputReceived

description: Broadcast when data comes in from the data channel.

code: typedef TMulticastDelegate_ThreeParams< void, [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), uint8, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > > FOnInputReceived


description: Force a key frame to be sent.

code: void ForceKeyFrame()


description: Freeze Pixel Streaming.

code: void FreezeStream ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * Texture )


className: FStreamingStartedEvent

description: Event fired when the streamer has connected to a signalling server and is ready for peers.

code: class FStreamingStartedEvent : public TBaseMulticastDelegate_OneParam< void, IPixelStreamingStreamer * >


className: FStreamingStoppedEvent

description: Event fired when the streamer has disconnected from a signalling server and has stopped streaming.

code: class FStreamingStoppedEvent : public TBaseMulticastDelegate_OneParam< void, IPixelStreamingStreamer * >


code: bool GetConfigOption ( const [FName](API\Runtime\Core\UObject\FName) & OptionName, [FString](API\Runtime\Core\Containers\FString) & OutValue )


description:
Get the connected players.
TArrayThe connected players


description: Get this streamer's ID.


description:
Get the streamer's input handler.
The streamer's input handler


description: Get the audio sink associated with a specific peer/player.

code: [IPixelStreamingAudioSink](API\Plugins\PixelStreaming\IPixelStreamingAudioSink) * GetPeerAudioSink ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId )


description:
Get the Signalling Connection Observer object.
TWeakPtr


description:
Get the connection to the signalling server.
The connection to the signalling server.


description:
Get the Signalling Server URL.
The Signalling Server URL


description: Get the Stream FPS.

code: int32 GetStreamFPS()


description:
Get the target screen rectangle for this streamer.
The target screen rectangle

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntRect > GetTargetScreenRect()


description:
Get the Target Viewport for this streamer.
The target viewport

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SViewport](API\Runtime\Slate\Widgets\SViewport) > GetTargetViewport()


description:
Get the target screen size for this streamer.
The target screen size

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntPoint > GetTargetScreenSize()


description:
Get the target window for this streamer.
The target window

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > GetTargetWindow()


description: Get an audio sink that has no peers/players listening to it.


description:
Get the Video Input object.
TheFPixelStreamingVideoInputthat this streamer will stream


description: True if the streamer is connected to the signalling mechanism (e.g. websocket for signalling server).

code: bool IsSignallingConnected()


description:
Get the current state of this streamer.
false

code: bool IsStreaming() const


description: Kick a player by player id.

code: void KickPlayer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId )


description: A getter for the OnStreamingStarted event. Intent is for users to callIPixelStreamingModule::Get().FindStreamer(ID)->OnStreamingStarted().AddXXX.


description: A getter for the OnStreamingStopped event. Intent is for users to callIPixelStreamingModule::Get().FindStreamer(ID)->OnStreamingStopped().AddXXX.


description: Remove the audio input from the Pixel Streaming mix.

code: void RemoveAudioInput ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingAudioInput](API\Plugins\PixelStreaming\IPixelStreamingAudioInput) > AudioInput )


description: Send a file to the browser where we are sending video.

code: void SendFileData ( const TArray64< uint8 > & ByteData, [FString](API\Runtime\Core\Containers\FString) & MimeType, [FString](API\Runtime\Core\Containers\FString) & FileExtension )


description: Send all players connected to this streamer a message.

code: void SendPlayerMessage ( uint8 Type, const [FString](API\Runtime\Core\Containers\FString) & Descriptor )


description: Allows sending arbitrary configuration options during initial connection.

code: void SetConfigOption ( const [FName](API\Runtime\Core\UObject\FName) & OptionName, const [FString](API\Runtime\Core\Containers\FString) & Value )


description: Setting this to true will cause the streamer to ignore the FPS value and instead push out frames as they are submitted from the video input. If the encode process takes longer than the time between frames, frames will be dropped.

code: void SetCoupleFramerate ( bool bCouple )


description: Set the streamer's input handler.

code: void SetInputHandler ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingInputHandler](API\Plugins\PixelStreamingInput\IPixelStreamingInputHandler) > InInputHandler )


description: Set the type for this streamers input handler. This controls whether input is routed to widgets or windows.

code: void SetInputHandlerType ( [EPixelStreamingInputType](API\Plugins\PixelStreamingInput\EPixelStreamingInputType) InputType )


description: Set the Layer Preference for a specific player. Only useful if using the SFU.

code: void SetPlayerLayerPreference ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, int SpatialLayerId, int TemporalLayerId )


description: Set the connection to the signalling server.

code: void SetSignallingConnection ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingSignallingConnection](API\Plugins\PixelStreaming\IPixelStreamingSignallingConnect-) > InSignallingConnection )


description: Set the Signalling Server URL.

code: void SetSignallingServerURL ( const [FString](API\Runtime\Core\Containers\FString) & InSignallingServerURL )


description: Set the Stream FPS.

code: void SetStreamFPS ( int32 InFramesPerSecond )


description: Set the target screen rectangle for this streamer. This is used to when the streamer doesn't have a singular target window / viewport and as such we just use the manual scale.

code: void SetTargetScreenRect ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntRect > InTargetScreenRect )


description: Set the target screen size for this streamer. This is used to when the streamer doesn't have a singular target window / viewport and as such we just use the manual scale.

code: void SetTargetScreenSize ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntPoint > InTargetScreenSize )


description: Set the Target Viewport for this streamer. This is used to ensure input between the browser and application scales correctly.

code: void SetTargetViewport ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SViewport](API\Runtime\Slate\Widgets\SViewport) > InTargetViewport )


description: Set the target window for this streamer. This is used to ensure mouse events are directed to the correct window if multiple windows are tiled on top of one another as seen in the editor.

code: void SetTargetWindow ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InTargetWindow )


description: Set the Video Input object.

code: void SetVideoInput ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingVideoInput](API\Plugins\PixelStreaming\FPixelStreamingVideoInput) > Input )


description: Start streaming this streamer.

code: void StartStreaming()


description: Stop this streamer from streaming.

code: void StopStreaming()


description: Unfreeze Pixel Streaming.

code: void UnfreezeStream()


code: virtual ~IPixelStreamingStreamer()


className: IPixelStreamingStreamer

code: class IPixelStreamingStreamer

OnInputReceived

type: FOnInputReceive...


className: PlayerIdToInt

code: int32 PlayerIdToInt ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId )


code: static const [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) SFU_PLAYER_ID = FString(TEXT("1"));


className: ToPlayerId

code: [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) ToPlayerId ( int32 PlayerIdInteger )


code: [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) ToPlayerId ( [FString](API\Runtime\Core\Containers\FString) PlayerIdString )


code: namespace UE { namespace PixelStreaming { template<typename T> const void * UE::PixelStreaming::ValueLoc ( T && Value ) } }


code: namespace UE { namespace PixelStreaming { const void * UE::PixelStreaming::ValueLoc ( [FString](API\Runtime\Core\Containers\FString) && Value ) } }


code: namespace UE { namespace PixelStreaming { template<typename T> size_t UE::PixelStreaming::ValueSize ( T && Value ) } }


code: namespace UE { namespace PixelStreaming { size_t UE::PixelStreaming::ValueSize ( [FString](API\Runtime\Core\Containers\FString) && Value ) } }


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual void ConsumeRawPCM ( const int16_t * AudioData, int InSampleRate, size_t NChannels, size_t NFrames )


description: Implemented by the synth component to create a generator object instead of generating audio directly on the synth component. This method prevents UObjects from having to exist in the audio render thread.

code: virtual ISoundGeneratorPtr CreateSoundGenerator ( const [FSoundGeneratorInitParams](API\Runtime\Engine\Sound\FSoundGeneratorInitParams) & InParams )


description: True if listening to a connected WebRTC peer through Pixel Streaming.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Pixel Streaming Audio Component") bool IsListeningToPlayer()


description: Called when the synth component begins generating audio in render thread.

code: virtual void OnBeginGenerate()


description: Listen to a specific player on the default streamer. If the player is not found this component will be silent.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Pixel Streaming Audio Component") bool ListenTo ( [FString](API\Runtime\Core\Containers\FString) PlayerToListenTo )


description: Called when the synth has finished generating audio on the render thread.

code: virtual void OnEndGenerate()


code: virtual void OnConsumerAdded()


code: virtual void OnConsumerRemoved()


description: Stops listening to any connected player/peer and resets internal state so component is ready to listen again.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Pixel Streaming Audio Component") void Reset()


description: Listen to a specific player. If the player is not found this component will be silent.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Pixel Streaming Audio Component") bool StreamerListenTo ( [FString](API\Runtime\Core\Containers\FString) StreamerId, [FString](API\Runtime\Core\Containers\FString) PlayerToListenTo )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: bool WillListenToAnyPlayer()


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


className: UPixelStreamingAudioComponent

description: Allows in-engine playback of incoming WebRTC audio from a particular Pixel Streaming player/peer using their mic in the browser. Note: Each audio component associates itself with a particular Pixel Streaming player/peer (using the the Pixel Streaming player id).

bAutoFindPeer

type: bool

description: If not already listening to a player/peer will try to attach for listening to the "PlayerToHear" each tick.

PlayerToHear

type: FString

description: The Pixel Streaming player/peer whose audio we wish to listen to.

StreamerToHear

description: The Pixel Streaming streamer of the player that we wish to listen to.


className: bIsExiting

code: static bool bIsExiting = false;


description: Create the singleton.

code: static [UPixelStreamingDelegates](API\Plugins\PixelStreaming\UPixelStreamingDelegates) * CreateInstance()


className: FAllConnectionsClosed

description: All connections have closed and nobody is viewing or interacting with the app. This is an opportunity to reset the app.

code: class FAllConnectionsClosed


className: FAllConnectionsClosedNative

description: C++ Delegate.

code: typedef TMulticastDelegate_OneParam< void, [FString](API\Runtime\Core\Containers\FString) > FAllConnectionsClosedNative


className: FClosedConnection

description: A connection to a player was lost.

code: class FClosedConnection


className: FConnectedToSignallingServerNative

description: C++ Delegate.

code: typedef TMulticastDelegate_NoParams< void > FConnectedToSignallingServerNative


className: FClosedConnectionNative

description: C++ Delegate.

code: typedef TMulticastDelegate_ThreeParams< void, [FString](API\Runtime\Core\Containers\FString), [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), bool > FClosedConnectionNative


className: FDataChannelClosed

description: An existing data channel has been closed

code: typedef TMulticastDelegate_TwoParams< void, [FString](API\Runtime\Core\Containers\FString), [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) > FDataChannelClosed


className: FConnectedToSignallingServer

description: A connection to the signalling server was made.

code: class FConnectedToSignallingServer


className: FDataChannelOpen

description: A new data channel has been opened

code: typedef TMulticastDelegate_ThreeParams< void, [FString](API\Runtime\Core\Containers\FString), [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) * > FDataChannelOpen


className: FDisconnectedFromSignallingServerNative

description: C++ Delegate.

code: typedef TMulticastDelegate_NoParams< void > FDisconnectedFromSignallingServerNative


className: FDisconnectedFromSignallingServer

description: A connection to the signalling server was lost.

code: class FDisconnectedFromSignallingServer


className: FFallbackToSoftwareEncoderingNative

description: C++ Delegate.

code: typedef TMulticastDelegate_NoParams< void > FFallbackToSoftwareEncoderingNative


className: FNewConnection

description: A new connection has been made to the session.

code: class FNewConnection


className: FFallbackToSoftwareEncodering

description: The GPU ran out of available HW encoders and fell back to software encoders

code: class FFallbackToSoftwareEncodering


className: FNewConnectionNative

description: C++ Delegate.

code: typedef TMulticastDelegate_ThreeParams< void, [FString](API\Runtime\Core\Containers\FString), [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), bool > FNewConnectionNative


className: FQualityControllerChanged

description: The quality controlling peer has changed

code: typedef TMulticastDelegate_TwoParams< void, [FString](API\Runtime\Core\Containers\FString), [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) > FQualityControllerChanged


className: FStatChangedNative

description: C++ Delegate.

code: typedef TMulticastDelegate_ThreeParams< void, [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), [FName](API\Runtime\Core\UObject\FName), float > FStatChangedNative


className: FStatsChanged

description: A pixel streaming stat has changed

code: class FStatsChanged


className: Singleton

description: The singleton object.

code: static [UPixelStreamingDelegates](API\Plugins\PixelStreaming\UPixelStreamingDelegates) * Singleton = nullptr;


code: static [UPixelStreamingDelegates](API\Plugins\PixelStreaming\UPixelStreamingDelegates) * GetPixelStreamingDelegates()


className: UPixelStreamingDelegates

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

OnAllConnectionsClosed

type: FAllConnections...

OnClosedConnection

type: FClosedConnecti...

OnConnectedToSignallingServer

type: FConnectedToSig...

OnDataChannelClosedNative

type: FDataChannelClo...

OnDataChannelOpenNative

type: FDataChannelOpe...

OnDisconnectedFromSignallingServer

type: FDisconnectedFr...

OnFallbackToSoftwareEncodering

type: FFallbackToSoft...

OnNewConnection

type: FNewConnection

OnNewConnectionNative

type: FNewConnectionN...

OnQualityControllerChangedNative

type: FQualityControl...

OnStatChanged

type: FStatsChanged

OnStatChangedNative

type: FStatChangedNat...


code: virtual ~UPixelStreamingDelegates()


description: Helper function to add a string field to a JSON descriptor. This produces a new descriptor which may then be chained to add further string fields.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="PixelStreaming Input") void AddJsonStringValue ( const [FString](API\Runtime\Core\Containers\FString) & Descriptor, [FString](API\Runtime\Core\Containers\FString) FieldName, [FString](API\Runtime\Core\Containers\FString) StringValue, [FString](API\Runtime\Core\Containers\FString) & NewDescriptor, bool & Success )


description: Begins Play for the component. Called when the owning Actor begins play or when the component is created if the Actor has already begun play. Actor BeginPlay normally happens right after PostInitializeComponents but can be delayed for networked or child actors. Requires component to be registered and initialized.

code: virtual void BeginPlay()


description: Ends gameplay for this component. Called fromAActor::EndPlayonly if bHasBegunPlay is true

code: virtual void EndPlay ( const [EEndPlayReason::Type](API\Runtime\Engine\Engine\EEndPlayReason__Type) EndPlayReason )


className: FOnInput

description: The delegate which will be notified about a UI interaction.

code: class FOnInput


description: Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name. The field name may be hierarchical, delimited by a period. For example, to access the Width value of a Resolution command above you should use "Resolution.Width" to get the width value.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="PixelStreaming Input") void GetJsonStringValue ( [FString](API\Runtime\Core\Containers\FString) Descriptor, [FString](API\Runtime\Core\Containers\FString) FieldName, [FString](API\Runtime\Core\Containers\FString) & StringValue, bool & Success )


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


description: Send a response back to the source of the UI interactions.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming Input") void SendPixelStreamingResponse ( const [FString](API\Runtime\Core\Containers\FString) & Descriptor )


className: UPixelStreamingInput

description: This component may be attached to an actor to allow UI interactions to be handled as the delegate will be notified about the interaction and will be supplied with a generic descriptor string containing, for example, JSON data. Responses back to the source of the UI interactions may also be sent.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, ClassGroup=(PixelStreaming), Meta=(BlueprintSpawnableComponent)) class UPixelStreamingInput : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

OnInputEvent

type: FOnInput


className: FOnInputReceived

module: PixelStreamingBlueprint

code: typedef TMulticastDelegate_ThreeParams< void, [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId), uint8, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > > FOnInputReceived


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void FreezeStream ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * Texture )


className: FStreamingStartedEvent

code: class FStreamingStartedEvent : public TBaseMulticastDelegate_NoParams< void >


className: FStreamingStoppedEvent

code: class FStreamingStoppedEvent : public TBaseMulticastDelegate_NoParams< void >


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void SendPlayerMessage ( uint8 Type, const [FString](API\Runtime\Core\Containers\FString) & Descriptor )


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


className: UPixelStreamingStreamerComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Category="PixelStreaming", Meta=(DisplayName="Streamer Component", BlueprintSpawnableComponent)) class UPixelStreamingStreamerComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

OnStreamingStarted

type: FStreamingStart...

OnStreamingStopped

type: FStreamingStopp...

VideoInput

type: TObjectPtr<UPi...


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingVideoInput](API\Plugins\PixelStreaming\FPixelStreamingVideoInput) > GetVideoInput()


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


className: UPixelStreamingStreamerVideoInput

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintType, NotBlueprintable, Category="PixelStreaming", Meta=(DisplayName="Video Input")) class UPixelStreamingStreamerVideoInput : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

type: TSharedPtr<FPi...


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


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintType, NotBlueprintable, Category="PixelStreaming", Meta=(DisplayName="Back Buffer Streamer Video Input")) class UPixelStreamingStreamerVideoInputBackBuffer : public [UPixelStreamingStreamerVideoInput](API\Plugins\PixelStreamingBlueprint\UPixelStreamingStreamerVideoInpu-)


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


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintType, NotBlueprintable, Category="PixelStreaming", Meta=(DisplayName="Render Target Streamer Video Input")) class UPixelStreamingStreamerVideoInputRenderTarget : public [UPixelStreamingStreamerVideoInput](API\Plugins\PixelStreamingBlueprint\UPixelStreamingStreamerVideoInpu-)

Target

type: TObjectPtr<UTe...


description: The Slate style set for the Shooter game

module: PixelStreamingEditor

code: static [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) & Get()


code: static void Initialize()


code: static void Shutdown()


description: Reloads textures used by slate renderer

code: static void ReloadTextures()


className: StyleInstance

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleInstance = NULL;


className: FPixelStreamingStyle

code: class FPixelStreamingStyle


className: FOnFrameSizeChanged

code: typedef TMulticastDelegate_OneParam< void, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntRect > > FOnFrameSizeChanged


description: A human readable identifier used when displaying what the streamer is streaming in the toolbar


description: No constructors are accessible with public or protected access.

code: class FPixelStreamingVideoInputBackBufferComposited : public [FPixelStreamingVideoInputRHI](API\Plugins\PixelStreaming\FPixelStreamingVideoInputRHI)

OnFrameSizeChanged

type: FOnFrameSizeCha...


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingVideoInputViewport](API\Plugins\PixelStreamingEditor\FPixelStreamingVideoInputViewpor-) > Create ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > InAssociatedStreamer )


className: FPixelStreamingVideoInputViewport

code: class FPixelStreamingVideoInputViewport : public [FPixelStreamingVideoInputRHI](API\Plugins\PixelStreaming\FPixelStreamingVideoInputRHI)


description: Get the domain for the inbuilt c++ signalling serverFStringThe inbuilt c++ signalling server's domain


description:
Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPixelStreamingEditorModule](API\Plugins\PixelStreamingEditor\IPixelStreamingEditorModule) & Get()


description: Get the inbuilt C++ signalling serverTSharedPtrThe signalling server


description:
Get the port streamers connect to for the inbuilt c++ signalling server
int32 The inbuilt c++ signalling server's port for streamers connect to

code: int32 GetStreamerPort()


description: Get the stream typeUE::EditorPixelStreaming::EStreamTypesThe stream type currently streamed by the editor streamer


description:
Get the port viewers connect to for the inbuilt c++ signalling server
int32 The inbuilt c++ signalling server's port for viewers connect to

code: int32 GetViewerPort()


description:
Checks to see if this module is loaded.
True if the module is loaded.

code: static bool IsAvailable()


description: Set the domain for the inbuilt c++ signalling server

code: void SetSignallingDomain ( const [FString](API\Runtime\Core\Containers\FString) & InSignallingDomain )


description: Set the port streamers connect to for the inbuilt c++ signalling server

code: void SetStreamerPort ( int32 InStreamerPort )


description: Set the stream type object

code: void SetStreamType ( [UE::EditorPixelStreaming::EStreamTypes](API\Plugins\PixelStreamingEditor\UE__EditorPixelStreaming__EStrea-) InStreamType )


description: Set the port viewers connect to for the inbuilt c++ signalling server

code: void SetViewerPort ( int32 InViewerPort )


description: Start the inbuilt C++ signalling server

code: void StartSignalling()


description: Starts the editor specific streamer.

code: void StartStreaming ( [UE::EditorPixelStreaming::EStreamTypes](API\Plugins\PixelStreamingEditor\UE__EditorPixelStreaming__EStrea-) InStreamType )


description: Stop the inbuilt C++ signalling server

code: void StopSignalling()


description: Starts the editor specific streamer.

code: void StopStreaming()


description:
Get if streamers should use an external signalling server or the inbuilt c++ signalling server.
false Use the inbuilt c++ signalling server

code: bool UseExternalSignallingServer()


description: Set if streamers should use an external signalling server or the inbuilt c++ signalling server.

code: void UseExternalSignallingServer ( bool bUseExternalSignallingServer )


className: IPixelStreamingEditorModule

description: The public interface of the Pixel Streaming Editor module.

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


description: These are the commands used in the toolbar visible in the editor

code: namespace UE { namespace EditorPixelStreaming { enum EStreamTypes { LevelEditorViewport = 0, Editor = 1, } } }


className: EPixelStreamingXRSystem

module: PixelStreamingHMD

code: enum EPixelStreamingXRSystem { Unknown, HTCVive, Quest, }


description: Called on game thread when view family is about to be rendered.

code: virtual void BeginRenderViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )


description: Adjusts the viewport rectangle for stereo, based on which eye pass is being rendered.

code: virtual void AdjustViewRect ( int32 ViewIndex, int32 & X, int32 & Y, uint32 & SizeX, uint32 & SizeY ) const


description: Calculates the offset for the camera position, given the specified position, rotation, and world scale Specifying eSSE_MONOSCOPIC for the view index returns a center offset behind the stereo views

code: virtual void CalculateStereoViewOffset ( const int32 ViewIndex, FRotator & ViewRotation, const float WorldToMeters, FVector & ViewLocation )


code: virtual void DrawDistortionMesh_RenderThread ( struct [FHeadMountedDisplayPassContext](API\Runtime\HeadMountedDisplay\FHeadMountedDisplayPassContext) & Context, const FIntPoint & TextureSize )


description: Enables or disables switching to stereo.

code: virtual void EnableHMD ( bool bEnable )


description:
Switches stereo rendering on / off. Returns current state of stereo.
Returns current state of stereo (true / false).

code: virtual bool EnableStereo ( bool stereo )


description: Reports all devices currently available to the system, optionally limiting the result to a given class of devices.

code: virtual bool EnumerateTrackedDevices ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutDevices, EXRTrackedDeviceType Type )


description: Returns current base orientation of HMD as yaw-pitch-roll combination.

code: virtual FRotator GetBaseRotation() const


description: Returns current base orientation of HMD as a quaternion.

code: virtual FQuat GetBaseOrientation() const


description:
Get the current pose for a device. This method must be callable both on the render thread and the game thread. For devices that don't support positional tracking, OutPosition will be at the base position.
true if the pose is valid or not.

code: virtual bool GetCurrentPose ( int32 DeviceId, FQuat & OutOrientation, FVector & OutPosition )


description: Returns eye render params, used from PostProcessHMD, RenderThread.

code: virtual void GetEyeRenderParams_RenderThread ( const struct [FHeadMountedDisplayPassContext](API\Runtime\HeadMountedDisplay\FHeadMountedDisplayPassContext) & Context, FVector2D & EyeToSrcUVScaleValue, FVector2D & EyeToSrcUVOffsetValue ) const


description: Calculates the FOV, based on the screen dimensions of the device. Original FOV is passed as params.

code: virtual void GetFieldOfView ( float & InOutHFOVInDegrees, float & InOutVFOVInDegrees ) const


description:
Access HMD rendering-related features.
a IHeadmountedDisplay pointer or a nullptr if this tracking system does not support head mounted displays.

code: virtual [IHeadMountedDisplay](API\Runtime\HeadMountedDisplay\IHeadMountedDisplay) * GetHMDDevice()


description: Get the name or id of the display to output for this HMD.

code: virtual bool GetHMDMonitorInfo ( [MonitorInfo](API\Runtime\HeadMountedDisplay\IHeadMountedDisplay\MonitorInfo) & )


description: Gets a projection matrix for the device, given the specified view index Specifying eSSE_MONOSCOPIC for the view index returns a center projection matrix encompassing all views

code: virtual FMatrix GetStereoProjectionMatrix ( const int32 ViewIndex ) const


code: virtual float GetInterpupillaryDistance() const


description:
Access Stereo rendering device associated with this XR system. IfGetHMDDevice()returns non-null, this method should also return a vaild instance.
aIStereoRenderingpointer or a nullptr if this tracking system does not support stereo rendering.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IStereoRendering](API\Runtime\Engine\IStereoRendering), ESPMode::ThreadSafe > GetStereoRenderingDevice()


description: IXRTrackingSysteminterface

code: virtual [FName](API\Runtime\Core\UObject\FName) GetSystemName() const


description: FXRTrackingSystemBaseprotected interface

code: virtual float GetWorldToMetersScale() const


description: Returns device specific flags.

code: virtual int32 GetXRSystemFlags() const


description: Returns 'false' if chromatic aberration correction is off.

code: virtual bool IsChromaAbCorrectionEnabled() const


description: IHeadMountedDisplayinterface

code: virtual bool IsHMDConnected()


description: Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing.

code: virtual bool IsHMDEnabled() const


description: True if the HMD was initialized OK

code: bool IsInitialized() const


description: IStereoRenderinginterface

code: virtual bool IsStereoEnabled() const


description: Called on render thread at the start of rendering.

code: virtual void PreRenderViewFamily_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )


description: Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction. Position is not changed.

code: virtual void ResetOrientation ( float Yaw )


description: Called on render thread at the start of rendering, for each view, after PreRenderViewFamily_RenderThread call.

code: virtual void PreRenderView_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneView](API\Runtime\Engine\FSceneView) & InView )


description: Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction and assuming current position as a 'zero-point' (for positional tracking).

code: virtual void ResetOrientationAndPosition ( float Yaw )


description: Resets position, assuming current position as a 'zero-point'.

code: virtual void ResetPosition()


description: Sets base orientation, assuming that this is forward direction. Position is not changed.

code: virtual void SetBaseOrientation ( const FQuat & BaseOrient )


description: Sets base orientation by setting yaw, pitch, roll, assuming that this is forward direction. Position is not changed.

code: virtual void SetBaseRotation ( const FRotator & BaseRot )


description: Accessors to modify the interpupillary distance (meters)

code: virtual void SetInterpupillaryDistance ( float NewInterpupillaryDistance )


code: void SetTransform ( FTransform Transform )


description: Called on game thread when creating the view.

code: virtual void SetupView ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily, [FSceneView](API\Runtime\Engine\FSceneView) & InView )


description: ISceneViewExtensioninterface

code: virtual void SetupViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )


description: Constructor

code: FPixelStreamingHMD ( const [FAutoRegister](API\Runtime\Engine\FAutoRegister) & )


description: Destructor

code: virtual ~FPixelStreamingHMD()


className: FPixelStreamingHMD

description: Pixel Streamed Head Mounted Display

code: class FPixelStreamingHMD : public [FHeadMountedDisplayBase](API\Plugins\XRBase\FHeadMountedDisplayBase), public [FHMDSceneViewExtension](API\Runtime\Engine\FHMDSceneViewExtension)


description:
Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPixelStreamingHMDModule](API\Plugins\PixelStreamingHMD\IPixelStreamingHMDModule) & Get()


description:
Get the Active XR System.
EPixelStreamingXRSystem


description:
Get the Pixel Streaming HMD object.
FPixelStreamingHMD*

code: [FPixelStreamingHMD](API\Plugins\PixelStreamingHMD\FPixelStreamingHMD) * GetPixelStreamingHMD() const


description:
Checks to see if this module is loaded.
True if the module is loaded.

code: static bool IsAvailable()


code: void SetActiveXRSystem ( [EPixelStreamingXRSystem](API\Plugins\PixelStreamingHMD\EPixelStreamingXRSystem) System )


className: IPixelStreamingHMDModule

description: The public interface of the Pixel Streaming HMD module.

code: class IPixelStreamingHMDModule : public [IHeadMountedDisplayModule](API\Runtime\HeadMountedDisplay\IHeadMountedDisplayModule)


className: EPixelStreamingInputAction

description: The possible actions pixel streaming supports. These actions help differentiate input received from the browser.

module: PixelStreamingInput

code: enum EPixelStreamingInputAction { X = 0, Y = 1, Axis, Click, Touch, None, }


className: EPixelStreamingInputType

description: The possible control schemes pixel streaming supports. RouteToWindow routes input at an application level. RouteToWidget routes input to a specific widget, ignoring the rest of the application.

code: enum EPixelStreamingInputType { RouteToWindow, RouteToWidget, }


className: EPixelStreamingMessageDirection

description: The message directions.

code: enum EPixelStreamingMessageDirection { ToStreamer = 0, FromStreamer = 1, }


className: EPixelStreamingMessageTypes

description: The data types supported when sending messages across the data channel to/from peers.

code: enum EPixelStreamingMessageTypes { Uint8, Uint16, Int16, Float, Double, Variable, Undefined, }


code: [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) & Add ( [FString](API\Runtime\Core\Containers\FString) Key, const [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) & Value )


code: void Apply ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FString](API\Runtime\Core\Containers\FString), [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage))> & Visitor )


code: [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) * Find ( [FString](API\Runtime\Core\Containers\FString) Key )


code: const [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) * Find ( [FString](API\Runtime\Core\Containers\FString) Key ) const


code: [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) & GetOrAdd ( [FString](API\Runtime\Core\Containers\FString) Key )


code: int Remove ( [FString](API\Runtime\Core\Containers\FString) Key )


className: FInputProtocolMap

description: An map type that broadcasts the OnProtocolUpdated whenever it's inner map is updated.

code: class FInputProtocolMap


className: GamepadInputToFKey

code: static [TMap](API\Runtime\Core\Containers\TMap)< [TTuple](API\Runtime\Core\Misc\TTuple)< uint8, [EPixelStreamingInputAction](API\Plugins\PixelStreamingInput\EPixelStreamingInputAction) >, [FKey](API\Runtime\InputCore\FKey) > GamepadInputToFKey;


className: XRInputToFKey

code: static [TMap](API\Runtime\Core\Containers\TMap)< [TTuple](API\Runtime\Core\Misc\TTuple)< [EPixelStreamingXRSystem](API\Plugins\PixelStreamingHMD\EPixelStreamingXRSystem), EControllerHand, uint8, [EPixelStreamingInputAction](API\Plugins\PixelStreamingInput\EPixelStreamingInputAction) >, [FKey](API\Runtime\InputCore\FKey) > XRInputToFKey;


className: FPixelStreamingInputConverter

code: struct FPixelStreamingInputConverter


className: CurrentId

code: static uint8 CurrentId = 0;


code: uint8 GetByteLength() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [EPixelStreamingMessageTypes](API\Plugins\PixelStreamingInput\EPixelStreamingMessageTypes) > GetStructure() const


description: Emtpy constructor. Sets ID to next available ID, byteLength to 0, and an empty Structure.

code: FPixelStreamingInputMessage()


description: Constructor taking an ID. Sets byteLength to 0, and an empty Structure.

code: FPixelStreamingInputMessage ( uint8 InId )


description: Constructor taking a Structure. Sets ID to next available ID and calculates bytelength from the structure.

code: FPixelStreamingInputMessage ( [TArray](API\Runtime\Core\Containers\TArray)< [EPixelStreamingMessageTypes](API\Plugins\PixelStreamingInput\EPixelStreamingMessageTypes) > InStructure )


description: Constructor taking an ID and a Structure. Calculates bytelength from the structure.

code: FPixelStreamingInputMessage ( uint8 InId, [TArray](API\Runtime\Core\Containers\TArray)< [EPixelStreamingMessageTypes](API\Plugins\PixelStreamingInput\EPixelStreamingMessageTypes) > InStructure )


className: FPixelStreamingInputMessage

code: class FPixelStreamingInputMessage


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > ToJson ( [EPixelStreamingMessageDirection](API\Plugins\PixelStreamingInput\EPixelStreamingMessageDirection) Direction )


className: FPixelStreamingInputProtocol

code: struct FPixelStreamingInputProtocol


description: Find the function to be called whenever the specified message type is received.TFunctionThe function called when this message type is received.

code: [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FMemoryReader](API\Runtime\Core\Serialization\FMemoryReader))> FindMessageHandler ( const [FString](API\Runtime\Core\Containers\FString) & MessageType )


className: FOnSendMessage

code: typedef TMulticastDelegate_TwoParams< void, [FString](API\Runtime\Core\Containers\FString), [FMemoryReader](API\Runtime\Core\Serialization\FMemoryReader) > FOnSendMessage


description:
Get the target screen rectangle for this streamer.
The target screen rectangle

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntRect > GetTargetScreenRect()


description:
Get the target screen size for this streamer.
The target screen size

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntPoint > GetTargetScreenSize()


description:
Get the viewport this input device is associated with.
The viewport this input device is associated with

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SViewport](API\Runtime\Slate\Widgets\SViewport) > GetTargetViewport()


code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > GetTargetWindow()


description:
Set whether the input devices is faking touch events using keyboard and mouse this can be useful for debugging.
false

code: bool IsFakingTouchEvents() const


description: Handle the message from the WebRTC data channel.

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


description: Register a function to be called whenever the specified message type is received.

code: void RegisterMessageHandler ( const [FString](API\Runtime\Core\Containers\FString) & MessageType, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FMemoryReader](API\Runtime\Core\Serialization\FMemoryReader))> & Handler )


description: Set the input handlers type. This controls whether input is routed to widgets or windows.

code: void SetInputType ( [EPixelStreamingInputType](API\Plugins\PixelStreamingInput\EPixelStreamingInputType) InputType )


description: Register a custom function to execute when command JSON is received over the data channel: "{ type: "Command", YourCommand: YourCommandValue }". Note: You can also override the default Pixel Streaming command handlers by setting handlers with the same name as those already used, e.g. "Stat.FPS".

code: void SetCommandHandler ( const [FString](API\Runtime\Core\Containers\FString) & CommandName, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString))> & Handler )


description: Set the target screen size for this streamer. This is used to when the streamer doesn't have a singular target window / viewport and as such we just use the manual scale.

code: void SetTargetScreenSize ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntPoint > InTargetScreenSize )


description: Set the target screen rectangle for this streamer. This is used to when the streamer doesn't have a singular target window / viewport and as such we just use the manual scale.

code: void SetTargetScreenRect ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< FIntRect > InTargetScreenRect )


description: Set the viewport this input device is associated with.

code: void SetTargetViewport ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SViewport](API\Runtime\Slate\Widgets\SViewport) > InTargetViewport )


code: void SetTargetWindow ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InTargetWindow )


className: IPixelStreamingInputHandler

description: TheIPixelStreamingInputHandler, used to handle input from a remote peer and pass it to UE accordingly. Setting the target viewport allows for scaling of input from browser to application, and setting the target window ensure that if windows are tiled (eg editor) that the streamed input only affect the target window.

code: class IPixelStreamingInputHandler : public [IInputDevice](API\Runtime\InputDevice\IInputDevice)

OnSendMessage

type: FOnSendMessage


description:
Attempts to create a new input device interface
Interface to the new input device, if we were able to successfully create one

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IInputDevice](API\Runtime\InputDevice\IInputDevice) > CreateInputDevice ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) > & InMessageHandler )


description: Create a Input Handler object.TSharedPtrthe input handler for this streamer


className: FOnProtocolUpdated

code: typedef TMulticastDelegate_NoParams< void > FOnProtocolUpdated


description:
Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPixelStreamingInputModule](API\Plugins\PixelStreamingInput\IPixelStreamingInputModule) & Get()


description:
Checks to see if this module is loaded.
True if the module is loaded.

code: static bool IsAvailable()


className: IPixelStreamingInputModule

description: The public interface of the Pixel Streaming Input module.

code: class IPixelStreamingInputModule : public [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule)

OnProtocolUpdated

type: FOnProtocolUpda...


description: Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const


description: Gets the section text, uses the classes DisplayName by default.

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


description: UObjectinterface

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


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


className: UPixelStreamingSettings

description: Config loaded/saved to an .ini file. It is also exposed through the plugin settings page in editor.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=PixelStreaming, defaultconfig, Meta=(DisplayName="PixelStreaming")) class UPixelStreamingSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

bMouseAlwaysAttached

type: bool

description: Pixel Streaming may be running on a machine which has no physical mouse attached, and yet the browser is sending mouse positions.

DefaultCursorClassName

type: FSoftClassPath

description: Pixel streaming always requires various software cursors so they will be visible in the video stream sent to the browser to allow the user to click and interact with UI elements.

HiddenCursorClassName

description: Pixel Streaming can have a server-side cursor (where the cursor itself is shown as part of the video), or a client-side cursor (where the cursor is shown by the browser).


module: PixelStreamingPlayer

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< webrtc::IceCandidateInterface > ToWebRTC() const


code: FPixelStreamingIceCandidateWrapper()


code: FPixelStreamingIceCandidateWrapper ( const webrtc::IceCandidateInterface & Candidate )


code: FPixelStreamingIceCandidateWrapper ( const [FString](API\Runtime\Core\Containers\FString) & SdpMid, int SdpMLineIndex, const [FString](API\Runtime\Core\Containers\FString) & Sdp )


className: FPixelStreamingIceCandidateWrapper

description: A blueprint wrapper for an IceCandidateInterface from webrtc so it can be passed around in blueprints.

Mid

type: FString

MLineIndex

type: int


className: FPixelStreamingOnIceCandidate

code: struct FPixelStreamingOnIceCandidate : public [TSparseDynamicDelegate< FPixelStreamingOnIceCandidate_MCSignature, UPixelStreamingPeerComponent, FPixelStreamingOnIceCandidateInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


className: FPixelStreamingOnIceConnection

code: struct FPixelStreamingOnIceConnection : public [TSparseDynamicDelegate< FPixelStreamingOnIceConnection_MCSignature, UPixelStreamingPeerComponent, FPixelStreamingOnIceConnectionInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


className: FPixelStreamingOnIceDisconnection

code: struct FPixelStreamingOnIceDisconnection : public [TSparseDynamicDelegate< FPixelStreamingOnIceDisconnection_MCSignature, UPixelStreamingPeerComponent, FPixelStreamingOnIceDisconnectionInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


className: FPixelStreamingRTCConfigWrapper

description: A blueprint wrapper for an RTCConfiguration from webrtc so it can be passed around in blueprints.


code: struct FPixelStreamingSignallingComponentConnectionError : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentConnectionError_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentConnectionErrorInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


description: A blueprint wrapper for an SessionDescriptionInterface from webrtc so it can be passed around in blueprints.

SDP

type: const webrtc::S...


code: struct FPixelStreamingSignallingComponentAnswer : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentAnswer_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentAnswerInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: struct FPixelStreamingSignallingComponentConfig : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentConfig_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentConfigInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: struct FPixelStreamingSignallingComponentConnected : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentConnected_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentConnectedInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: struct FPixelStreamingSignallingComponentDataChannels : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentDataChannels_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentDataChannelsInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: struct FPixelStreamingSignallingComponentDisconnected : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentDisconnected_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentDisconnectedInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: struct FPixelStreamingSignallingComponentIceCandidate : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentIceCandidate_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentIceCandidateInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingOnIceDisconnection_MCSignature, FPixelStreamingOnIceDisconnection_DelegateWrapper, FUNC_CONCAT(), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this))), void )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentDataChannels_MCSignature, FPixelStreamingSignallingComponentDataChannels_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(int32 InParam1, int32 InParam2)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1, InParam2)), void, int32, int32 )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentDisconnected_MCSignature, FPixelStreamingSignallingComponentDisconnected_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(int32 InParam1, const [FString](API\Runtime\Core\Containers\FString) &InParam2, bool InParam3)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1, InParam2, InParam3)), void, int32, const [FString](API\Runtime\Core\Containers\FString) &, bool )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentConnected_MCSignature, FPixelStreamingSignallingComponentConnected_DelegateWrapper, FUNC_CONCAT(), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this))), void )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingOnIceConnection_MCSignature, FPixelStreamingOnIceConnection_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(int InParam1)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1)), void, int )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentConnectionError_MCSignature, FPixelStreamingSignallingComponentConnectionError_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(const [FString](API\Runtime\Core\Containers\FString) &InParam1)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1)), void, const [FString](API\Runtime\Core\Containers\FString) & )


className: FPixelStreamingSignallingComponentOffer

code: struct FPixelStreamingSignallingComponentOffer : public [TSparseDynamicDelegate< FPixelStreamingSignallingComponentOffer_MCSignature, UPixelStreamingSignallingComponent, FPixelStreamingSignallingComponentOfferInfoGetter >](API\Runtime\CoreUObject\UObject\TSparseDynamicDelegate)


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentOffer_MCSignature, FPixelStreamingSignallingComponentOffer_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(const [FString](API\Runtime\Core\Containers\FString) &InParam1)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1)), void, const [FString](API\Runtime\Core\Containers\FString) & )


code: CURRENT_FILE_ID___LINE___DELEGATE FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FPixelStreamingSignallingComponentAnswer_MCSignature, FPixelStreamingSignallingComponentAnswer_DelegateWrapper, FUNC_CONCAT(FUNC_CONCAT(const [FString](API\Runtime\Core\Containers\FString) &InParam1)), FUNC_CONCAT(FUNC_CONCAT(*[this](API\Plugins\WorldConditions\this), InParam1)), void, const [FString](API\Runtime\Core\Containers\FString) & )


description:
Creates an answer to the given offer objet that was provided.
The answer object generated. Send this to the signalling server to complete negotiation.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") [FPixelStreamingSessionDescriptionWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingSessionDescriptio-) CreateAnswer ( const [FString](API\Runtime\Core\Containers\FString) & Offer )


description:
Creates an offer.
The offer object generated. Send this to the signalling server to initiate negotiation.


code: virtual void OnFrame ( const webrtc::VideoFrame & frame )


description: Notify the peer connection of an ICE candidate sent by the singalling connection.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void ReceiveIceCandidate ( const [FPixelStreamingIceCandidateWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingIceCandidateWrapp-) & Candidate )


description: Receives an answer from a streamer after we've sent an offer to receive.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void ReceiveAnswer ( const [FString](API\Runtime\Core\Containers\FString) & Offer )


description: Sets the RTC Configuration for this Peer Connection.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void SetConfig ( const [FPixelStreamingRTCConfigWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingRTCConfigWrapper) & Config )


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


className: UPixelStreamingPeerComponent

description: A blueprint representation of a Pixel Streaming Peer Connection. Should communicate with a Pixel Streaming Signalling Connection and will accept video sinks to receive video data.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Category="PixelStreaming", Meta=(DisplayName="PixelStreaming Peer Component", BlueprintSpawnableComponent)) class UPixelStreamingPeerComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent), public rtc::VideoSinkInterface< webrtc::VideoFrame >

OnIceCandidate

type: FPixelStreaming...

description: Once negotiation is completed the Peer Connection can generate Ice Candidate objects.

OnIceConnection

description: Once a connection has been connected and streaming should be available.

OnIceDisconnection

description: When an ice connection is lost.

VideoSinkPlayer

type: TObjectPtr<UMe...

description: A sink for the video data received once this connection has finished negotiating.


description: Used by the async bp node.

code: void AsyncRequestStreamerList ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &)> & Callback )


code: virtual void OnSignallingConfig &40; const webrtc::PeerConnectionInterface::RTCConfiguration & Config &41;


description: Attempt to connect to a specified signalling server.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void Connect ( const [FString](API\Runtime\Core\Containers\FString) & Url )


description: Disconnect from the signalling server. No action if no connection exists.


description: ISignallingServerConnectionObserver implementation.


code: virtual void OnSignallingDisconnected &40; int32 StatusCode, const FString & Reason, bool bWasClean &41;


code: virtual void OnSignallingError &40; const FString & ErrorMsg &41;


code: virtual void OnSignallingPeerDataChannels &40; int32 SendStreamId, int32 RecvStreamId &41;


code: virtual void OnSignallingPlayerCount &40; uint32 Count &41;


code: virtual void OnSignallingPlayerConnected &40; FPixelStreamingPlayerId PlayerId, const FPixelStreamingPlayerConfig & PlayerConfig, bool bSendOffer &41;


code: virtual void OnSignallingPlayerDisconnected &40; FPixelStreamingPlayerId PlayerId &41;


code: virtual void OnSignallingRemoteIceCandidate &40; const FString & SdpMid, int SdpMLineIndex, const FString & Sdp &41;


code: virtual void OnSignallingRemoteIceCandidate &40; FPixelStreamingPlayerId PlayerId, const FString & SdpMid, int SdpMLineIndex, const FString & Sdp &41;


code: virtual void OnSignallingSessionDescription &40; webrtc::SdpType Type, const FString & Sdp &41;


description: Streamer-only.

code: virtual void OnSignallingSessionDescription &40; FPixelStreamingPlayerId PlayerId, webrtc::SdpType Type, const FString & Sdp &41;


code: virtual void OnSignallingSFUPeerDataChannels &40; FPixelStreamingPlayerId SFUId, FPixelStreamingPlayerId PlayerId, int32 SendStreamId, int32 RecvStreamId &41;


description: Player-only.

code: virtual void OnSignallingStreamerList &40; const TArray< FString > & StreamerList &41;


code: FSignallingObserver &40; UPixelStreamingSignallingComponent &42; InParent &41;


className: FSignallingObserver

code: class FSignallingObserver : public [IPixelStreamingSignallingConnectionObserver](API\Plugins\PixelStreaming\IPixelStreamingSignallingConnect-_1)


description: Send an answer created from a Peer Connection to the signalling server.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void SendAnswer ( const [FPixelStreamingSessionDescriptionWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingSessionDescriptio-) & Answer )


description: Send an Ice Candidate to the signalling server that is generated from a Peer Connection.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void SendIceCandidate ( const [FPixelStreamingIceCandidateWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingIceCandidateWrapp-) & CandidateWrapper )


description: Send an offer created from a Peer Connection to the signalling server.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void SendOffer ( const [FPixelStreamingSessionDescriptionWrapper](API\Plugins\PixelStreamingPlayer\FPixelStreamingSessionDescriptio-) & Offer )


description: Send a subscribe message to the signalling server to subscribe to a specific streamer.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PixelStreaming") void Subscribe ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description: Send an unsubscribe message to the signalling server to unsubscribe from a streamer.


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


className: UPixelStreamingSignallingComponent

description: A blueprint class representing a Pixel Streaming Signalling connection. Used to communicate with the signalling server and should route information to the peer connection.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Category="PixelStreaming", Meta=(DisplayName="PixelStreaming Signalling Component", BlueprintSpawnableComponent)) class UPixelStreamingSignallingComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

MediaSource

type: TObjectPtr<USt...

description: If this media source is set we will use its supplied URL instead of the Url parameter on the connect call.

OnAnswer

description: Fired when the connection receives an answer from the server.

OnConfig

description: Fired when the connection receives a config message from the server.

OnConnected

description: Fired when the signalling connection is successfully established.

OnConnectionError

description: Fired if the connection failed or an error occurs during the connection.

OnDisconnected

description: Fired when the connection successfully closes.

OnIceCandidate

description: Fired when the server sends through an ice candidate.

OnOffer

description: Fired when the connection receives an offer from the server.

OnStreamerListCallback

type: TFunction< void...


className: FEndpoints

module: PixelStreamingServers

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [EEndpoint](API\Plugins\PixelStreamingServers\UE__PixelStreamingServers__EEndp-), [FURL](API\Runtime\Engine\Engine\FURL) > FEndpoints


className: FLaunchArgs

description: Configuration to control behaviour when launching any of the Pixel Streaming servers.

code: struct FLaunchArgs

bPollUntilReady

description: If true poll until ready.

ProcessArgs

description: Arguments passed to the actual server when its process is started.

ReconnectionIntervalSeconds

type: float

description: Reconnect interval in seconds.

ReconnectionTimeoutSeconds

description: Reconnection timeout in seconds.

ServerBinaryOverridePath

type: TOptional<FStr...

description: Path the server binary to run instead of launching server by running scripts.


className: FOnReady

code: typedef TMulticastDelegate_OneParam< void, const [FEndpoints](API\Plugins\PixelStreamingServers\FEndpoints) & > FOnReady


className: FOnFailedToReady

code: typedef TMulticastDelegate_NoParams< void > FOnFailedToReady


description: The absolute path to the root directory that the server was launched from.


description: True if the server has been launched. Note: Launched does not necessarily mean it is connectible yet. Bind to OnReady for that.

code: bool HasLaunched()


description: True if the server has timed out while trying to establish a connection.

code: bool IsTimedOut()


description: True if the server has been connected to and is ready for new connections.

code: bool IsReady()


description: Immediately stops the server.

code: void Stop()


description:
Launch the server in a child process using the supplied launch arguments.
True if the server was able to start launching, this can fail when launching child process servers where files must exist on disk.

code: bool Launch ( [FLaunchArgs](API\Plugins\PixelStreamingServers\FLaunchArgs) & InLaunchArgs )


className: IServer

description: Interface for all Pixel Streaming servers.

code: class IServer

OnFailedToReady

type: FOnFailedToRead...

description: Can fire when the server is unable to be contacted or connecting to it timed out.

OnReady

type: FOnReady

description: Delegate fired when the server is ready for connections, first parameter is a map of all supported endpoints and their urls.


description: Endpoints for the various Pixel Streaming servers.

code: namespace UE { namespace PixelStreamingServers { enum EEndpoint { Signalling_Streamer, Signalling_Players, Signalling_Matchmaker, Signalling_SFU, Signalling_Webserver, } } }


description:
Implement this to create an capture process that captures to the FinalFormat at the given scale. The source format should be known by whatever is fed into the capture system.
TheFPixelCaptureCapturerthat will do the work.

module: PixelStreamingVCam

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer) > CreateCapturer ( int32 FinalFormat, float FinalScale )


description: A human readable identifier used when displaying what the streamer is streaming in the toolbar


className: FPixelStreamingVideoInputVCam

description: No constructors are accessible with public or protected access.

code: class FPixelStreamingVideoInputVCam : public [FPixelStreamingVideoInputRHI](API\Plugins\PixelStreaming\FPixelStreamingVideoInputRHI)


description: Convenience function for accessing the subsystem.

code: static [UVCamPixelStreamingSubsystem](API\Plugins\PixelStreamingVCam\UVCamPixelStreamingSubsystem) * Get()


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


description: Implement this for initialization of instances of the system

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


code: void RegisterActiveOutputProvider ( [UVCamPixelStreamingSession](API\Plugins\DecoupledOutputProvider\BuiltinProviders\UVCamPixelStreamingSession) * OutputProvider )


code: void LaunchSignallingServer()


code: void StopSignallingServer()


description: Get the LiveLinkSource if it already exists or attempt to create one Additionally registers the OutputProvider to the Source if a new source was created

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FPixelStreamingLiveLinkSource > TryGetLiveLinkSource ( [UVCamPixelStreamingSession](API\Plugins\DecoupledOutputProvider\BuiltinProviders\UVCamPixelStreamingSession) * OutputProvider )


code: void UnregisterActiveOutputProvider ( [UVCamPixelStreamingSession](API\Plugins\DecoupledOutputProvider\BuiltinProviders\UVCamPixelStreamingSession) * OutputProvider )


className: UVCamPixelStreamingSubsystem

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UVCamPixelStreamingSubsystem : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem)


module: PixWinPlugin

code: static [IPixWinPlugin](API\Plugins\PixWinPlugin\IPixWinPlugin) & Get()


className: IPixWinPlugin

description: PIX capture plugin interface.

code: class IPixWinPlugin : public [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule), public [IRenderCaptureProvider](API\Runtime\RenderCore\IRenderCaptureProvider)


className: AddCollisionSampleVertices

description: Scatter additional vertices (w/ no associated triangle) as needed to satisfy minimum point spacingIndexof first transform group w/ updated geometry. (To update geometry we delete and re-add, because geometry collection isn't designed for in-place updates)

module: PlanarCut

code: int32 AddCollisionSampleVertices ( double TargetSpacing, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices )


className: ConvertToMeshDescription

description: Convert chosen Geometry groups inside a GeometryCollection to a single Mesh Description.

code: void ConvertToMeshDescription ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & OutputMesh, FTransform & TransformOut, bool bCenterPivot, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TManagedArray](API\Runtime\Chaos\GeometryCollection\TManagedArray)< FTransform > & BoneTransforms, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< int32(int32, bool)> RemapMaterialIDs )


description: Convert a mesh description to a dynamic meshspecificallyaugmented / designed for cutting geometry collections, to be passed to CutWithMesh.

code: [UE::Geometry::FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) ConvertMeshDescriptionToCuttingDynamicMesh ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * CuttingMesh, int32 NumUVLayers, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress )


className: CreateCuttingSurfacePreview

description: Generate cutting mesh surfaces as a single mesh Useful for creating a preview of the cut surface.

code: void CreateCuttingSurfacePreview ( const [FPlanarCells](API\Plugins\PlanarCut\FPlanarCells) & Cells, const FBox & Bounds, double Grout, int32 RandomSeed, [UE::Geometry::FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) & OutCuttingMeshes, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int)> FilterCellsFunc, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress, FVector CellsOrigin )


className: CutMultipleWithMultiplePlanes

description:
Cut multiple Geometry groups inside a GeometryCollection with Planes, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. For geometries that would not be cut, nothing is added.
index of first new geometry in the Output GeometryCollection, or -1 if no geometry was added

code: int32 CutMultipleWithMultiplePlanes ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FPlane > & Planes, [FInternalSurfaceMaterials](API\Plugins\PlanarCut\FInternalSurfaceMaterials) & InternalSurfaceMaterials, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, double Grout, double CollisionSampleSpacing, int32 RandomSeed, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, bool bSetDefaultInternalMaterialsFromCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress )


className: CutWithMesh

description:
Cut multiple Geometry groups inside a GeometryCollection with a mesh, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. For geometries that would not be cut, nothing is added.
index of first new geometry in the Output GeometryCollection, or -1 if no geometry was added

code: int32 CutWithMesh ( const [UE::Geometry::FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) & CuttingMesh, FTransform CuttingMeshTransform, [FInternalSurfaceMaterials](API\Plugins\PlanarCut\FInternalSurfaceMaterials) & InternalSurfaceMaterials, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, double CollisionSampleSpacing, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, bool bSetDefaultInternalMaterialsFromCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress )


className: CutMultipleWithPlanarCells

description:
Cut multiple Geometry groups inside a GeometryCollection with PlanarCells, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. For geometries that would not be cut, nothing is added.
index of first new geometry in the Output GeometryCollection, or -1 if no geometry was added

code: int32 CutMultipleWithPlanarCells ( [FPlanarCells](API\Plugins\PlanarCut\FPlanarCells) & Cells, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, double Grout, double CollisionSampleSpacing, int32 RandomSeed, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, bool bIncludeOutsideCellInOutput, bool bSetDefaultInternalMaterialsFromCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress, FVector CellsOrigin )


code: int32 CutWithMesh ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * CuttingMesh, FTransform CuttingMeshTransform, [FInternalSurfaceMaterials](API\Plugins\PlanarCut\FInternalSurfaceMaterials) & InternalSurfaceMaterials, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, double CollisionSampleSpacing, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, bool bSetDefaultInternalMaterialsFromCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress )


className: CutWithPlanarCells

description:
Cut a Geometry inside a GeometryCollection with PlanarCells, and add each cut cell back to the GeometryCollection as a new child of the input Geometry. For geometries that would not be cut, nothing is added.
index of first new geometry in the Output GeometryCollection, or -1 if no geometry was added

code: int32 CutWithPlanarCells ( [FPlanarCells](API\Plugins\PlanarCut\FPlanarCells) & Cells, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, int32 TransformIdx, double Grout, double CollisionSampleSpacing, int32 RandomSeed, const [TOptional](API\Runtime\Core\IO\TOptional)< FTransform > & TransformCollection, bool bIncludeOutsideCellInOutput, bool bSetDefaultInternalMaterialsFromCollection, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress, FVector CellsOrigin )


className: FilterBonesByVolume

description: Populate an array of transform indices w/ those that match a custom volume-based filter

code: void FilterBonesByVolume ( const [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const double > & Volumes, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(double Volume, int32 BoneIdx)> Filter, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutSmallBones, bool bIncludeClusters )


className: FindBoneVolumes

description: Populate an array of transform indices w/ those that are smaller than a threshold volume

code: void FindBoneVolumes ( [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, [TArray](API\Runtime\Core\Containers\TArray)< double > & OutVolumes, double ScalePerDimension, bool bIncludeClusters )


className: FindSmallBones

code: void FindSmallBones ( const [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const double > & Volumes, double MinVolume, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutSmallBones, bool bIncludeClusters )


code: int32 GetDefaultMaterialIDForGeometry ( const [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, int32 GeometryIdx ) const


code: void SetUVScaleFromCollection ( const [GeometryCollection::Facades::FCollectionMeshFacade](API\Runtime\Chaos\GeometryCollection\Facades\FCollectionMeshFacade) & CollectionMesh, int32 GeometryIdx )


className: FInternalSurfaceMaterials

description: Auxiliary structure forFPlanarCellsto carry material info

code: struct FInternalSurfaceMaterials

NoiseSettings

type: TOptional<FNoi...


className: RandomOffsetScale

description: Offset scale chosen to keep reasonably small offsets while still de-correlating the noise in each dimension.

code: static constexpr double RandomOffsetScale = 100.0;


code: void SetOffsets ( [FRandomStream](API\Runtime\Core\Math\FRandomStream) & RandomStream )


code: FNoiseOffsets ( [FRandomStream](API\Runtime\Core\Math\FRandomStream) & RandomStream )


className: FNoiseOffsets

description: Offsets to randomize where Perlin noise is sampled for each dimension of a noise vector.

code: struct FNoiseOffsets

X

type: FVector


code: FVector NoiseVector ( const FVector & Pos, const [FNoiseOffsets](API\Plugins\PlanarCut\FNoiseOffsets) & Offsets ) const


code: float OctaveNoise ( const FVector & V ) const


className: FNoiseSettings

code: struct FNoiseSettings


code: int32 AddPlane ( const FPlane & P, int32 CellIdxBehind, int32 CellIdxInFront, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & PlaneBoundary )


code: void AddPlane ( const FPlane & P, int32 CellIdxBehind, int32 CellIdxInFront )


description: Discards cells from the diagram, used to support visualization of a subset of cells.

code: void DiscardCells ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(int32)> KeepFunc, bool bKeepNeighbors )


description:
Debugging function to check that the plane boundary vertices are wound to match the orientation of the plane normal vectors
false if any plane boundary vertices are found in the 'wrong' orientation relative to the plane normal


description: true if this is a single, unbounded cutting plane

code: bool IsInfinitePlane() const


code: void SetNoise ( [FNoiseSettings](API\Plugins\PlanarCut\FNoiseSettings) Noise )


code: FPlanarCells ( const FPlane & Plane )


code: FPlanarCells ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > Sites, [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) & Voronoi )


code: FPlanarCells ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FBox > Boxes, bool bResolveAdjacencies )


code: FPlanarCells ( const FBox & Region, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FColor](API\Runtime\Core\Math\FColor) > Image, int32 Width, int32 Height )


code: FPlanarCells ( const FBox & Region, const FIntVector & CubesPerAxis )


className: FPlanarCells

description: Stores planar facets that divide space into cells.

code: struct FPlanarCells

InternalSurfaceMaterials

type: FInternalSurfac...

PlaneBoundaries

type: TArray<TArray<...

PlaneBoundaryVertices

type: TArray< FVector...

PlaneCells

type: TArray< TPair< ...

Planes

type: TArray< FPlane ...


className: FTextureAttributeSettings

code: struct FTextureAttributeSettings

type: double

type: int

type: bool


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPlanarCutPlugin](API\Plugins\PlanarCut\IPlanarCutPlugin) & Get()


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: IPlanarCutPlugin

description: The public interface to this module

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


className: MergeAllSelectedBones

description: Merge all chosen nodes into a single node. UnlikeMergeBones(), does not account for proximity and will always only merge the selected bones.

code: void MergeAllSelectedBones ( [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, bool bUnionJoinedPieces )


className: MergeBones

description: Merge chosen geometry into neighboring geometry.

code: int32 MergeBones ( [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const double > & Volumes, double MinVolume, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & SmallTransformIndices, bool bUnionJoinedPieces, [UE::PlanarCut::ENeighborSelectionMethod](API\Plugins\PlanarCut\UE__PlanarCut__ENeighborSelectio-) NeighborSelectionMethod )


className: MergeClusters

description: Merge chosen bones into neighboring clusters.

code: void MergeClusters ( [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const double > & Volumes, double MinVolume, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & SmallTransformIndices, [UE::PlanarCut::ENeighborSelectionMethod](API\Plugins\PlanarCut\UE__PlanarCut__ENeighborSelectio-) NeighborSelectionMethod, bool bOnlyMergeInProximity, bool bOnlySameParent )


className: RecomputeNormalsAndTangents

description: Recompute normals and tangents of selected geometry, optionally restricted to faces with odd or given material IDs (i.e. to target internal faces)

code: void RecomputeNormalsAndTangents ( bool bOnlyTangents, bool bMakeSharpEdges, float SharpAngleDegrees, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, bool bOnlyInternalSurfaces )


className: SplitIslands

description:
Split the geometry at the given transforms into their connected components
index of first new geometry in the Output GeometryCollection, or -1 if no geometry was added

code: int32 SplitIslands ( [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const int32 > & TransformIndices, double CollisionSampleSpacing, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress )


description: Different attributes we can bake.

code: namespace UE { namespace PlanarCut { enum EBakeAttributes { None, DistanceToExternal, AmbientOcclusion, Curvature, NormalX, NormalY, NormalZ, PositionX, PositionY, PositionZ, } } }


description: Box project UVs

code: namespace UE { namespace PlanarCut { bool UE::PlanarCut::BoxProjectUVs ( int32 TargetUVLayer, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, const FVector3d & BoxDimensions, [EUseMaterials](API\Plugins\PlanarCut\UE__PlanarCut__EUseMaterials) MaterialsPattern, [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > WhichMaterials, FVector2f OffsetUVs, bool bOverrideBoxDimensionsWithBounds, bool bCenterBoxAtPivot, bool bUniformProjectionScale ) } }


code: namespace UE { namespace PlanarCut { enum ENeighborSelectionMethod { LargestNeighbor, NearestCenter, } } }


code: namespace UE { namespace PlanarCut { enum ETargetFaces { AllFaces, InternalFaces, ExternalFaces, CustomFaces, } } }


description: Note: prefer ETargetFaces below.

code: namespace UE { namespace PlanarCut { enum EUseMaterials { AllMaterials, OddMaterials, NoDefaultMaterials, } } }


description: Make a UV atlas of non-overlapping UV charts for a geometry collection

code: namespace UE { namespace PlanarCut { bool UE::PlanarCut::UVLayout ( int32 TargetUVLayer, [FGeometryCollection](API\Runtime\Chaos\GeometryCollection\FGeometryCollection) & Collection, int32 UVRes, float GutterSize, [EUseMaterials](API\Plugins\PlanarCut\UE__PlanarCut__EUseMaterials) MaterialsPattern, [TArrayView](API\Runtime\Core\Containers\TArrayView)< int32 > WhichMaterials, bool bRecreateUVsForDegenerateIslands, [FProgressCancel](API\Runtime\GeometryCore\Util\FProgressCancel) * Progress ) } }


module: PlatformCrypto

code: static [IPlatformCrypto](API\Plugins\PlatformCrypto\IPlatformCrypto) & Get()


description: Creates and returns an encryption context object appropriate for the platform.


description: Called when crytpo module is unloaded

code: virtual void ShutdownModule()


description: Called when crytpo module is loaded

code: virtual void StartupModule()


className: IPlatformCrypto

description: Entry point for cryptographic functionality.

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


description:
Calculate the SHA256 hash of a message.
Whether the hash operation was successful

module: PlatformCryptoOpenSSL

code: bool CalcSHA256 ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutHash )


description:
Create an RSA key from a binary public/private exponent and modulus.
The created RSA key

code: FRSAKeyHandle CreateKey_RSA ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > PublicExponent, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > PrivateExponent, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Modulus )


description:
Create pseudo random bytes.
The platform crypto result enum

code: [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) CreatePseudoRandomBytes ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > OutData )


description:
Create random bytes.
The platform crypto result enum

code: [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) CreateRandomBytes ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > OutData )


description:
Create a new SHA256 hasher.
Reference to the hasher


description:
Decrypt a source with a private RSA key.
Number of decrypted bytes

code: int32 DecryptPrivate_RSA ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Dest, FRSAKeyHandle Key )


description:
Decrypt a source with a public RSA key.
Number of decrypted bytes

code: int32 DecryptPublic_RSA ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Dest, FRSAKeyHandle Key )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Decrypt_AES_256_CBC ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Ciphertext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InitializationVector, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Decrypt_AES_256_ECB ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Ciphertext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Decrypt_AES_256_GCM ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Ciphertext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Nonce, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > AuthTag, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


description: Destroy and free the RSA key.

code: void DestroyKey_RSA ( FRSAKeyHandle Key )


description:
Sign a message with RS256.
Whether the sign operation was successful

code: bool DigestSign_RS256 ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Message, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Signature, FRSAKeyHandle Key )


description:
Verify a hashed PS256 message with a signature.
Whether the verify operation was successful

code: bool DigestVerify_PS256 ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const char > Message, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Signature, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > PKCS1Key )


description:
Verify a hashed RS256 message with a signature.
Whether the verify operation was successful

code: bool DigestVerify_RS256 ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Message, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Signature, FRSAKeyHandle Key )


description:
Encrypt a source with a private RSA key.
Number of encrypted bytes

code: int32 EncryptPrivate_RSA ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Dest, FRSAKeyHandle Key )


description:
Encrypt a source with a public RSA key.
Number of encrypted bytes

code: int32 EncryptPublic_RSA ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Dest, FRSAKeyHandle Key )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Encrypt_AES_256_CBC ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Plaintext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InitializationVector, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Encrypt_AES_256_GCM ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Plaintext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Nonce, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutAuthTag, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > Encrypt_AES_256_ECB ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Plaintext, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Key, [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) & OutResult )


description:
Generate an RSA key with the number of key bits.
Whether the generate operation was successful

code: bool GenerateKey_RSA ( const int32 InNumKeyBits, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutPublicExponent, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutPrivateExponent, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutModulus )


description:
Get the RSA key modulus size in bytes.
The modulus size in bytes

code: int32 GetKeySize_RSA ( FRSAKeyHandle Key )


description:
Get the maximum data size.
The maximum data size in bytes

code: int32 GetMaxDataSize_RSA ( FRSAKeyHandle Key )


description:
Get the RSA public key from a PEM format string.
The RSA public key

code: FRSAKeyHandle GetPublicKey_RSA ( const FStringView PemSource )


className: FEncryptionContextOpenSSL

description: Interface to certain cryptographic algorithms, using OpenSSL to implement them.

code: class FEncryptionContextOpenSSL


className: EState

code: enum EState { NeedsInit, Ready, ReadyNeedsFinalize, }


className: FImplDetails

code: struct FImplDetails


description: Finalize the computation of the message digest. After calling this method, Init must be called again if this object is meant to be reused for hashing a new input.

code: [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) Finalize ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > OutDataBuffer )


description: Initialize the necessary state to begin computing a message digest. It is only necessary to call this function if the object is being used to compute multiple hashes, as the constructor will automatically call it the first time.


code: [FSHA256HasherOpenSSL](API\Plugins\PlatformCryptoOpenSSL\FSHA256HasherOpenSSL) & operator= ( [FSHA256HasherOpenSSL](API\Plugins\PlatformCryptoOpenSSL\FSHA256HasherOpenSSL) && )


code: FSHA256HasherOpenSSL & operator&61; &40; const FSHA256HasherOpenSSL & &41;


className: OutputByteLength

description: The final message digest length in bytes.

code: static constexpr const uint32 OutputByteLength = 32;


description: Update the message digest computation with additional bytes

code: [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult) Update ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InDataBuffer )


code: FSHA256HasherOpenSSL ( [FSHA256HasherOpenSSL](API\Plugins\PlatformCryptoOpenSSL\FSHA256HasherOpenSSL) && )


code: FSHA256HasherOpenSSL &40; const FSHA256HasherOpenSSL & &41;


description: Implementation details for SHA256 computation using OpenSSL

code: struct FSHA256HasherOpenSSL


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPlatformCryptoOpenSSL](API\Plugins\PlatformCryptoOpenSSL\IPlatformCryptoOpenSSL) & Get()


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: IPlatformCryptoOpenSSL

description: Module interface for OpenSSL cryptographic functionality. Users should generally go through the FEncryptionContext API.

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


className: EPlatformCryptoResult

description: Generic result type for cryptographic functions.

module: PlatformCryptoTypes

code: enum EPlatformCryptoResult { Success, Failure, }


className: FBlockHandlerFunctionSignature

code: typedef [EPlatformCryptoResult](API\Plugins\PlatformCryptoTypes\EPlatformCryptoResult)(const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 >, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 >, int32 &) FBlockHandlerFunctionSignature