description: Sets the movement type for body modifiers

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetMovementType ( const [FName](API\Runtime\Core\UObject\FName) Set, const [EPhysicsMovementType](API\Plugins\PhysicsControl\EPhysicsMovementType) MovementType )


description: Sets the gravity multiplier for body modifiers

module: PhysicsControl

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersGravityMultiplier ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const float GravityMultiplier )


description: Sets the collision type for body modifiers

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetCollisionType ( const [FName](API\Runtime\Core\UObject\FName) Set, const [ECollisionEnabled::Type](API\Runtime\Engine\Engine\ECollisionEnabled__Type) CollisionType )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetGravityMultiplier ( const [FName](API\Runtime\Core\UObject\FName) Set, const float GravityMultiplier )


description: Sets the physics blend weight for body modifiers

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersPhysicsBlendWeight ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const float PhysicsBlendWeight )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetPhysicsBlendWeight ( const [FName](API\Runtime\Core\UObject\FName) Set, const float PhysicsBlendWeight )


description: Sets whether body modifiers should use skeletal animation for their kinematic targets

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersUseSkeletalAnimation ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bUseSkeletalAnimation )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetUseSkeletalAnimation ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bUseSkeletalAnimation )


description: Sets whether body modifiers should update kinematics from the simulation results

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersUpdateKinematicFromSimulation ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bUpdateKinematicFromSimulation )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersInSetUpdateKinematicFromSimulation ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bUpdateKinematicFromSimulation )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersCollisionType ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [ECollisionEnabled::Type](API\Runtime\Engine\Engine\ECollisionEnabled__Type) CollisionType )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetBodyModifiersMovementType ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [EPhysicsMovementType](API\Plugins\PhysicsControl\EPhysicsMovementType) MovementType )


description:
Sets whether a body modifier should use skeletal animation for its kinematic targets
true if the body modifier was found, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetBodyModifierUseSkeletalAnimation ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bUseSkeletalAnimation )


description:
Sets whether a body modifier should update kinematics from the simulation results
true if the body modifier was found, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetBodyModifierUpdateKinematicFromSimulation ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bUpdateKinematicFromSimulation )


description: true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlAutoDisable ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bAutoDisable )


description:
This allows the caller to override the target that will have been calculated and cached at the start of the Physics Control Component update. This is unlikely to be useful when using the built in tick, but if you are manually updating the component then you may wish to call this after UpdateTargetCaches but before UpdateControls.
true if successful, and false if no cached target can be found for the bone.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetCachedBoneData ( const [USkeletalMeshComponent](API\Runtime\Engine\Components\USkeletalMeshComponent) * SkeletalMeshComponent, const [FName](API\Runtime\Core\UObject\FName) BoneName, const FTransform & TM, const FVector Velocity, const FVector AngularVelocity )


description:
Modifies an existing control data - i.e. the strengths etc of the control driving towards the target
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlData ( const [FName](API\Runtime\Core\UObject\FName) Name, const [FPhysicsControlData](API\Plugins\PhysicsControl\FPhysicsControlData) ControlData, const bool bEnableControl )


description:
Modifies an existing control's angular data - i.e. the strengths etc of the control driving towards the target
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlAngularData ( const [FName](API\Runtime\Core\UObject\FName) Name, const float Strength, const float DampingRatio, const float ExtraDamping, const float MaxTorque, const bool bEnableControl )


description: Modifies existing control data - i.e. the strengths etc of the controls driving towards the targets

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlDatas ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [FPhysicsControlData](API\Plugins\PhysicsControl\FPhysicsControlData) ControlData, const bool bEnableControl )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlDisableCollision ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bDisableCollision )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlDatasInSet ( const [FName](API\Runtime\Core\UObject\FName) Set, const [FPhysicsControlData](API\Plugins\PhysicsControl\FPhysicsControlData) ControlData, const bool bEnableControl )


description:
Activates or deactivates a control
Returns true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlEnabled ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bEnable )


description:
Modifies an existing control's linear data - i.e. the strengths etc of the control driving towards the target
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlLinearData ( const [FName](API\Runtime\Core\UObject\FName) Name, const float Strength, const float DampingRatio, const float ExtraDamping, const float MaxForce, const bool bEnableControl )


description:
Modifies an existing control data using the multipliers
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlMultiplier ( const [FName](API\Runtime\Core\UObject\FName) Name, const [FPhysicsControlMultiplier](API\Plugins\PhysicsControl\FPhysicsControlMultiplier) ControlMultiplier, const bool bEnableControl )


description: Modifies existing control data using the multipliers

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlMultipliers ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [FPhysicsControlMultiplier](API\Plugins\PhysicsControl\FPhysicsControlMultiplier) ControlMultiplier, const bool bEnableControl )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlMultipliersInSet ( const [FName](API\Runtime\Core\UObject\FName) Set, const [FPhysicsControlMultiplier](API\Plugins\PhysicsControl\FPhysicsControlMultiplier) ControlMultiplier, const bool bEnableControl )


description: Sets the point at which controls will "push" the child object.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlPoint ( const [FName](API\Runtime\Core\UObject\FName) Name, const FVector Position )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsDisableCollision ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bDisableCollision )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsAutoDisable ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bAutoDisable )


description: Activates or deactivates controls

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsEnabled ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bEnable )


description: Sets whether or not the controls should use skeletal animation for the targets

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsInSetUseSkeletalAnimation ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bUseSkeletalAnimation, const float SkeletalAnimationVelocityMultiplier )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsInSetDisableCollision ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bDisableCollision )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsInSetAutoDisable ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bAutoDisable )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsUseSkeletalAnimation ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const bool bUseSkeletalAnimation, const float SkeletalAnimationVelocityMultiplier )


description:
Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
Returns true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetPositionAndOrientation ( const [FName](API\Runtime\Core\UObject\FName) Name, const FVector Position, const FRotator Orientation, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Calls SetControlTargetPositionAndOrientation for each of the control names

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetPositionsAndOrientations ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const FVector Position, const FRotator Orientation, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Calls SetControlTargetPosition for each of the controls in the set

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetPositionsInSet ( const [FName](API\Runtime\Core\UObject\FName) SetName, const FVector Position, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Calls SetControlTargetOrientation for each of the controls in the set

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetOrientationsInSet ( const [FName](API\Runtime\Core\UObject\FName) SetName, const FRotator Orientation, const float AngularVelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description:
Calls SetControlTargetPosition for each element of the control names and positions. These array should match in size.
true if the control/position arrays match, false if they don't.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetPositionsFromArray ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & Positions, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Activates or deactivates controls

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlsInSetEnabled ( const [FName](API\Runtime\Core\UObject\FName) Set, const bool bEnable )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetOrientationsFromArray ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [TArray](API\Runtime\Core\Containers\TArray)< FRotator > & Orientations, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description:
Calls SetControlTargetPositionAndOrientation for each element of the control names, positions and orientations. These array should match in size.
true if the control/position/orientation arrays match, false if they don't.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetPositionsAndOrientationsFromArray ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & Positions, const [TArray](API\Runtime\Core\Containers\TArray)< FRotator > & Orientations, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description:
Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTarget ( const [FName](API\Runtime\Core\UObject\FName) Name, const [FPhysicsControlTarget](API\Plugins\PhysicsControl\FPhysicsControlTarget) ControlTarget, const bool bEnableControl )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetOrientation ( const [FName](API\Runtime\Core\UObject\FName) Name, const FRotator Orientation, const float AngularVelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Calls SetControlTargetOrientation for each of the control names

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetOrientations ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const FRotator Orientation, const float AngularVelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description:
Calculates and sets an existing control target. This takes the "virtual" position/orientation of the parent and child and calculates the relative control. Note that this will set bApplyControlPointToTarget to true.
Returns true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetPoses ( const [FName](API\Runtime\Core\UObject\FName) Name, const FVector ParentPosition, const FRotator ParentOrientation, const FVector ChildPosition, const FRotator ChildOrientation, const float VelocityDeltaTime, const bool bEnableControl )


description: Calls SetControlTargetPositionAndOrientation for each control in the set

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetPositionsAndOrientationsInSet ( const [FName](API\Runtime\Core\UObject\FName) SetName, const FVector Position, const FRotator Orientation, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlTargetPosition ( const [FName](API\Runtime\Core\UObject\FName) Name, const FVector Position, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Calls SetControlTargetPosition for each of the control names

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetPositions ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const FVector Position, const float VelocityDeltaTime, const bool bEnableControl, const bool bApplyControlPointToTarget )


description: Modifies existing control targets - i.e. what they are driving towards, relative to the parent objects

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargets ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & Names, const [FPhysicsControlTarget](API\Plugins\PhysicsControl\FPhysicsControlTarget) ControlTarget, const bool bEnableControl )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void SetControlTargetsInSet ( const [FName](API\Runtime\Core\UObject\FName) Set, const [FPhysicsControlTarget](API\Plugins\PhysicsControl\FPhysicsControlTarget) ControlTarget, const bool bEnableControl )


description:
Sets whether or not the control should use skeletal animation for the targets
true if the control was found and modified, false if not

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) bool SetControlUseSkeletalAnimation ( const [FName](API\Runtime\Core\UObject\FName) Name, const bool bUseSkeletalAnimation, const float SkeletalAnimationVelocityMultiplier )


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, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


description: To use this function, you should disable ticking of the Physics Control Component, and ensure that the relevant Skeletal Mesh Component (if being used) has ticked, using a tick prerequisite. Then explicitly call (in order) UpdateTargetCaches and UpdateControls as you process your tick.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void UpdateControls ( float DeltaTime )


code: void UpdateSpriteTexture()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void UpdateTargetCaches ( float DeltaTime )


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


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()


className: UPhysicsControlComponent

description: Note that Controls and Body Modifiers are given names (which are predictable). These names can then be stored (perhaps in arrays) to make it easy to quickly change multiple Controls/Body Modifiers.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(BlueprintSpawnableComponent), ClassGroup=Physics, Experimental) class UPhysicsControlComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

bShowDebugBodyModifierList

type: bool

description: Display all the body modifiers and their basic properties when this component is selected

bShowDebugControlList

description: Display all the controls and their basic properties when this component is selected

bShowDebugVisualization

description: Visualize the controls when this component is selected

DebugBodyModifierDetailFilter

type: FString

description: Display detailed info for body modifiers containing this string (if non-empty) when this component is selected

DebugControlDetailFilter

description: Display detailed info for controls containing this string (if non-empty) when this component is selected

Implementation

type: TPimplPtr< FPhy...

MaxNumControlsOrModifiersPerName

description: Upper limit on the number of controls or modifiers that will be created using the same name (which will get a numerical postfix).

TeleportDistanceThreshold

type: float

description: If the component moves by more than this distance then it is treated as a teleport, which prevents velocities being used for a frame.

TeleportRotationThreshold

description: If the component rotates by more than this angle (in degrees) then it is treated as a teleport, which prevents velocities being used for a frame.

VelocityPredictionTime

description: The time used when "predicting" the target position/orientation.

VisualizationSizeScale

description: Size of the gizmos etc used during visualization


description: This creates all the controls specified in the Initial properties. You can call it explicitly, or you can opt to have it called at BeginPlay using CreateControlsAtBeginPlay.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=PhysicsControl) void CreateControls ( [UPhysicsControlComponent](API\Plugins\PhysicsControl\UPhysicsControlComponent) * PhysicsControlComponent )


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


className: UPhysicsControlInitializerComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(BlueprintSpawnableComponent), ClassGroup=Physics, Experimental) class UPhysicsControlInitializerComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

bCreateControlsAtBeginPlay

description: If set, then CreateControls will be called in our BeginPlay event, attempting to find a PhysicsControlComponent in our parent actor.

InitialBodyModifiers

type: TMap<FName,FI...

description: This can be filled in to automatically create body modifiers during the BeginPlay event.

InitialCharacterControls

type: FInitialCharact...

description: This can be filled in to automatically create whole-character controls (by specifying limbs etc) for a skeletal mesh during the BeginPlay event.

InitialControls

description: This can be filled in to automatically create controls during the BeginPlay event.


description: Get the preview mesh for this asset

code: virtual [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * GetPreviewMesh() const


description: ENDIInterface_PreviewMeshProviderinterface Get name of Preview Mesh property

code: static const [FName](API\Runtime\Core\UObject\FName) GetPreviewMeshPropertyName()


description: Placeholder for testing/developing


code: virtual void SetPreviewMesh ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * PreviewMesh, bool bMarkAsDirty )


code: UPhysicsControlProfileAsset()


className: UPhysicsControlProfileAsset

description: It will also be desirable to support "inheritance" - so a generic profile can be made, and then customized for certain characters or scenarios.

PreviewSkeletalMesh

type: TSoftObjectPtr<...

description: The skeletal mesh to use for generating controls and previewing.

TestValue

description: Placeholder for testing/developing


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

module: PhysicsControlEditor

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FPhysicsControlEditorModule

description: Module handles the Physics Control Profile editor, and also the Physics Control Visualizer

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


className: ModeName

description: The name of this mode.


code: virtual void RegisterTabFactories ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > InTabManager )


code: FPhysicsControlProfileApplicationMode ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkflowCentricApplication](API\Editor\UnrealEd\WorkflowOrientedApp\FWorkflowCentricApplication) > InHostingApp, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPersonaPreviewScene](API\Editor\Persona\IPersonaPreviewScene) > InPreviewScene )


className: FPhysicsControlProfileApplicationMode

description: The application mode for the Physics Control Profile Editor This defines the layout of the UI. It basically spawns all the tabs, such as the viewport, details panels, etc.

code: class FPhysicsControlProfileApplicationMode : public [FApplicationMode](API\Editor\UnrealEd\WorkflowOrientedApp\FApplicationMode)

EditorToolkit

type: TWeakPtr<FPhys...

description: The hosting app.

TabFactories

type: FWorkflowAllowe...

description: The tab factories we support.


code: virtual bool AllowWidgetMove()


description: Overlays the editor hud (brushes, drag tools, static mesh vertices, etc*.

code: virtual void DrawHUD ( [FEditorViewportClient](API\Editor\UnrealEd\FEditorViewportClient) * ViewportClient, [FViewport](API\Runtime\Engine\FViewport) * Viewport, const [FSceneView](API\Runtime\Engine\FSceneView) * View, [FCanvas](API\Runtime\Engine\FCanvas) * Canvas )


description: the anim preview scene

code: virtual [IPersonaPreviewScene](API\Editor\Persona\IPersonaPreviewScene) & GetAnimPreviewScene() const


description:
Get a camera target used to focus the viewport on an object when a user presses 'F' (default).
true if the target sphere was filled-in

code: virtual bool GetCameraTarget ( FSphere & OutTarget ) const


description: Function to collect strings from nodes to display in the viewport. Use this rather than DrawHUD when adding general text to the viewport. Display of this assumes that this will be mostly used by skeletal controls.

code: virtual void GetOnScreenDebugInfo ( [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutDebugInfo ) const


description: The name of the mode.


code: virtual bool IsCompatibleWith ( FEditorModeID OtherModeID ) const


description: Draws translucent polygons on brushes and volumes.

code: virtual void Render ( const [FSceneView](API\Runtime\Engine\FSceneView) * View, [FViewport](API\Runtime\Engine\FViewport) * Viewport, [FPrimitiveDrawInterface](API\Runtime\Engine\FPrimitiveDrawInterface) * PDI )


code: void SetEditorToolkit ( [FPhysicsControlProfileEditorToolkit](API\Plugins\PhysicsControlEditor\FPhysicsControlProfileEditorTool-) * InToolkit )


code: virtual void Tick ( [FEditorViewportClient](API\Editor\UnrealEd\FEditorViewportClient) * ViewportClient, float DeltaTime )


code: virtual bool ShouldDrawWidget() const


description: Lets each tool determine if it wants to use the editor widget or not. If the tool doesn't want to use it, it will be fed raw mouse delta information (not snapped or altered in any way).

code: virtual bool UsesTransformWidget() const


code: virtual bool UsesTransformWidget ( [UE::Widget::EWidgetMode](API\Editor\EditorFramework\UE__Widget__EWidgetMode) CheckMode ) const


className: FPhysicsControlProfileEditorMode

description: The Physics Control Profile Persona editor mode.

code: class FPhysicsControlProfileEditorMode : public [IPersonaEditMode](API\Editor\Persona\IPersonaEditMode)

PhysicsControlProfileEditorToolkit

type: FPhysicsControl...


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

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


description: Returns the localized name of this toolkit type (typically just "editor")

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


description: Get the toolkit held by this object

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPersonaToolkit](API\Editor\Persona\IPersonaToolkit) > GetPersonaToolkit() const


code: [IPersonaToolkit](API\Editor\Persona\IPersonaToolkit) * GetPersonaToolkitPointer() const


description: Return the stat id to use for this tickable

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


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


description: Returns the invariant name of this toolkit type

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


description: Returns the localized name of this toolkit

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


description: Returns the color and opacity to use for the color that appears behind the tab text for this toolkit's tab in world-centric mode.

code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetWorldCentricTabColorScale() const


description: Returns the localize prefix string to use for tab labels in world-centric mode.

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


description: Initialize the asset editor. This will register the application mode, init the preview scene, etc.

code: void InitAssetEditor ( const [EToolkitMode::Type](API\Editor\EditorFramework\Toolkits\EToolkitMode__Type) Mode, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IToolkitHost](API\Editor\EditorFramework\Toolkits\IToolkitHost) > & InitToolkitHost, [UPhysicsControlProfileAsset](API\Plugins\PhysicsControl\UPhysicsControlProfileAsset) * InPhysicsControlProfileAsset )


description: IToolkitinterface

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


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

code: virtual void Tick ( float DeltaTime )


description: Unregister tabs that this toolkit can spawn

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


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

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


className: FPhysicsControlProfileEditorToolkit

description: The main toolkit/editor for working with Physics Control Profile assets

code: class FPhysicsControlProfileEditorToolkit : public [FPersonaAssetEditorToolkit](API\Editor\Persona\FPersonaAssetEditorToolkit), public [IHasPersonaToolkit](API\Editor\Persona\IHasPersonaToolkit), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject), public [FEditorUndoClient](API\Editor\UnrealEd\FEditorUndoClient), public [FTickableEditorObject](API\Editor\UnrealEd\FTickableEditorObject)


description: Copies the given buffer into this buffer. Supplied so copies can be explicit in code where we want to be verbose.

module: PixelCapture

code: void Copy ( const [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) & Other )


description: Gets a const pointer to the beginning of entire buffer for reading.

code: virtual const uint8_t * GetData() const


description: Gets the size of both the U and V planes in bytes.

code: int32 GetDataSizeUV() const


description: Gets the size of the Y plane in bytes.

code: int32 GetDataSizeY() const


description: Gets a const pointer to the beginning of the U plane for reading.

code: const uint8_t * GetDataU() const


description: Gets a const pointer to the beginning of the Y plane for reading.

code: const uint8_t * GetDataY() const


description: Gets a const pointer to the beginning of the V plane for reading.

code: const uint8_t * GetDataV() const


description: Get the Buffer format

code: virtual int32 GetFormat() const


description: Get the height of the frame

code: virtual int32 GetHeight() const


description: Gets a pointer to the beginning of the entire buffer for editing.

code: virtual uint8_t * GetMutableData()


description: Gets a pointer to the beginning of the U plane for editing.

code: uint8_t * GetMutableDataU()


description: Gets a pointer to the beginning of the V plane for editing.

code: uint8_t * GetMutableDataV()


description: Gets a pointer to the beginning of the Y plane for editing.

code: uint8_t * GetMutableDataY()


description: Get the stride of the U and V planes

code: int32 GetStrideUV() const


description: Gets the total size of this buffer.

code: virtual int64 GetSize() const


description: Get the stride of the Y plane

code: int32 GetStrideY() const


description: Get the width of the frame

code: virtual int32 GetWidth() const


code: FPixelCaptureBufferI420 ( const [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) & Other )


description: Create an empty buffer of the specified size.

code: FPixelCaptureBufferI420 ( int InWidth, int InHeight )


code: virtual ~FPixelCaptureBufferI420()


description: Buffer class for holding I420 frame data.

code: class FPixelCaptureBufferI420 : public [IPixelCaptureBuffer](API\Plugins\PixelCapture\IPixelCaptureBuffer)


code: void Copy ( const [FPixelCaptureBufferNV12](API\Plugins\PixelCapture\FPixelCaptureBufferNV12) & Other )


code: virtual const uint8_t * GetData() const


description: Gets the size of both the UV plane in bytes.

code: int GetDataSizeUV() const


description: Gets the size of the Y plane in bytes.

code: int GetDataSizeY() const


code: const uint8_t * GetDataUV() const


code: const uint8_t * GetDataY() const


description: Get the Buffer format

code: virtual int32 GetFormat() const


description: Get the height of the frame

code: virtual int GetHeight() const


code: virtual uint8_t * GetMutableData()


code: uint8_t * GetMutableDataUV()


description: Gets the total size of this buffer.

code: virtual int64 GetSize() const


code: uint8_t * GetMutableDataY()


description: Get the stride of the U and V planes

code: int GetStrideUV() const


description: Get the stride of the Y plane

code: int GetStrideY() const


description: Get the width of the frame

code: virtual int GetWidth() const


code: FPixelCaptureBufferNV12 ( const [FPixelCaptureBufferNV12](API\Plugins\PixelCapture\FPixelCaptureBufferNV12) & Other )


code: FPixelCaptureBufferNV12 ( int InWidth, int InHeight )


code: class FPixelCaptureBufferNV12 : public [IPixelCaptureBuffer](API\Plugins\PixelCapture\IPixelCaptureBuffer)


code: virtual ~FPixelCaptureBufferNV12()


description: Implement this with your specific process to capture the incoming frame.

code: void BeginProcess ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & InputFrame, [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * OutputBuffer )


description: Called when an input frame needs capturing.

code: void Capture ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & InputFrame )


description:
Implement this to create a buffer for the output.
An empty output structure that the process can store the output of its process on.

code: [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * CreateOutputBuffer ( int32 InputWidth, int32 InputHeight )


description: Call this to mark the end of processing. Will commit the current write buffer into the read buffer.

code: void EndProcess()


className: FOnComplete

description: Listen on this to be notified when the capture process completes for each input.

code: typedef TMulticastDelegate_NoParams< void > FOnComplete


description:
Gets the human readable name for this capture process. This name will be used in stats readouts so the shorter the better.
A human readable name for this capture process.


description:
Returns true if this process has a frame in the output buffer ready to be read.
True when this process has output data.

code: bool HasOutput() const


description: Initializes the process to be ready for work. Called once at startup.

code: virtual void Initialize ( int32 InputWidth, int32 InputHeight )


description:
Returns true when this process is actively working on capturing frame data.
True when this process is busy.

code: bool IsBusy() const


description:
Returns true ifInitialize()has been called. Output data can depend on the incoming frames so we do lazy initialization when we first consume.
True if this process has been initialized correctly.

code: bool IsInitialized() const


description: Metadata info (optional). Marks the end of some CPU work.

code: void MarkCPUWorkEnd()


description: Metadata info (optional). Marks the start of some CPU work. Multiple work sections are valid.

code: void MarkCPUWorkStart()


description: Metadata info (optional). Marks the start of some GPU work. Multiple work sections are valid.

code: void MarkGPUWorkStart()


description:
Gets the output frame from the output buffer.
The output data of this process.


code: virtual ~FPixelCaptureCapturer()


className: FPixelCaptureCapturer

description: The base class for all Capturers in the system. Incoming frames will be user types implementingIPixelCaptureInputFrame. Outgoing frames should be user types implementingIPixelCaptureOutputFrame. Each capturer system should expect one known input user type. Implement CreateOutputBuffer to create your customIPixelCaptureOutputFrameimplementation to hold the result of the capture process. Implement BeginProcess to start the capture work which ideally should be an async task of some sort. The capture work should fill the givenIPixelCaptureOutputFrameand then call EndProcess to indicate the work is done. While the capture should be async it should only expect to work on one frame at a time.

code: class FPixelCaptureCapturer

OnComplete

type: FOnComplete


code: virtual void BeginProcess ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & InputFrame, [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * OutputBuffer )


code: virtual [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * CreateOutputBuffer ( int32 InputWidth, int32 InputHeight )


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


description: Metadata info (optional). Marks the end of some GPU work.

code: void MarkGPUWorkEnd()


code: virtual ~FPixelCaptureCapturerI420()


description: A basic capturer that will copy I420 frames. Input:FPixelCaptureInputFrameI420Output:FPixelCaptureOutputFrameI420

code: class FPixelCaptureCapturerI420 : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerI420ToRHI](API\Plugins\PixelCapture\FPixelCaptureCapturerI420ToRHI) > Create()


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

code: class FPixelCaptureCapturerI420ToRHI : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerI420ToRHI >](API\Runtime\Core\Templates\TSharedFromThis)


code: void AddLayer ( float Scale )


description: Begins the capture process of a given frame.

code: void Capture ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & SourceFrame )


description: Create a new Layered Capturer.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerLayered](API\Plugins\PixelCapture\FPixelCaptureCapturerLayered) > Create ( [IPixelCaptureCapturerSource](API\Plugins\PixelCapture\IPixelCaptureCapturerSource) * InCapturerSource, int32 InDestinationFormat, [TArray](API\Runtime\Core\Containers\TArray)< float > LayerScales )


description: A callback to broadcast on when the frame has completed the capture process. Called once when all layers of a given input frame have completed.

code: typedef TMulticastDelegate_NoParams< void > FOnComplete


description:
Try to read the result of the capture process. May return null if no output has been captured yet.
The captured frame layer if one exists. Null otherwise.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) > ReadOutput ( int32 LayerIndex )


code: FPixelCaptureCapturerLayered ( [IPixelCaptureCapturerSource](API\Plugins\PixelCapture\IPixelCaptureCapturerSource) * InCapturerSource, int32 InDestinationFormat, [TArray](API\Runtime\Core\Containers\TArray)< float > LayerScales )


code: virtual ~FPixelCaptureCapturerLayered()


className: FPixelCaptureCapturerLayered

description: A capturer that contains multiple layers of differently scaled capture processes. Feed it aIPixelCaptureCapturerSourcethat will create the appropriate base capturers. Input: User defined Output: Capturer defined

code: class FPixelCaptureCapturerLayered : public [TSharedFromThis< FPixelCaptureCapturerLayered >](API\Runtime\Core\Templates\TSharedFromThis)

CapturerSource

type: IPixelCaptureCa...

LayerCapturers

type: TArray<TShared...

LayerScales

type: TArray< float >

LayersGuard

type: FCriticalSectio...

PendingLayers

type: TAtomic< int >


description: Sets up a capture pipeline for the given destination format. No effect if the pipeline already exists.

code: void AddOutputFormat ( int32 Format )


code: void CheckFormatEvent ( int32 Format )


description: Create a new multi-format multi-Layered Capturer.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerMultiFormat](API\Plugins\PixelCapture\FPixelCaptureCapturerMultiFormat) > Create ( [IPixelCaptureCapturerSource](API\Plugins\PixelCapture\IPixelCaptureCapturerSource) * InCapturerSource, [TArray](API\Runtime\Core\Containers\TArray)< float > LayerScales )


description: Listen on this to be notified when a frame completes all capture formats/layers.


code: void FreeEvent ( int32 Format, [FEvent](API\Runtime\Core\HAL\FEvent) * Event )


description:
Gets the frame height of a given output layer.
The pixel count of the height of a output layer.

code: int32 GetHeight ( int LayerIndex ) const


code: [FEvent](API\Runtime\Core\HAL\FEvent) * GetEventForFormat ( int32 Format )


description:
Gets the number of layers in the multi-layered capturers.
The number of layers in each multi-layered capturer.

code: int32 GetNumLayers() const


description:
Gets the frame width of a given output layer.
The pixel count of the width of a output layer.

code: int32 GetWidth ( int LayerIndex ) const


code: void OnCaptureFormatComplete ( int32 Format )


description: Call to notify this capturer that it has been disconnected and no more frames will be captured and any waiting for format calls should stop waiting.

code: void OnDisconnected()


description:
Requests the output in a specific format. If this is the first request for the format and AddOutputFormat has not been called for the format then this call will return nullptr. Otherwise will return the buffer for the format provided the capture has completed.
The final buffer of a given format if it exists or null.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) > RequestFormat ( int32 Format, int32 LayerIndex )


description:
Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. NOTE: This will block the calling thread so it is important that the capture process is not dependent on this calling thread or we will deadlock.
The final buffer of a given format or null in case of timeout or the capturer has been disconnected.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) > WaitForFormat ( int32 Format, int32 LayerIndex, uint32 MaxWaitTime )


code: FPixelCaptureCapturerMultiFormat ( [IPixelCaptureCapturerSource](API\Plugins\PixelCapture\IPixelCaptureCapturerSource) * InCapturerSource, [TArray](API\Runtime\Core\Containers\TArray)< float > InLayerScales )


className: FPixelCaptureCapturerMultiFormat

description: A capturer that contains multiple formats of multi layer capture processes. Feed it aIPixelCaptureCapturerSourcethat will create the appropriate base capturers. Input: User defined Output: Capturer defined

code: class FPixelCaptureCapturerMultiFormat : public [TSharedFromThis< FPixelCaptureCapturerMultiFormat >](API\Runtime\Core\Templates\TSharedFromThis)

FormatCapturers

type: TMap< int32,TS...

FormatEvents

type: TMap< int32,FE...

LayerSizes

type: TArray< FIntPoi...


description: Implement this with your specific process to capture the incoming frame.

code: virtual void BeginProcess ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & InputFrame, [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * OutputBuffer )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerNV12ToRHI](API\Plugins\PixelCapture\FPixelCaptureCapturerNV12ToRHI) > Create()


description:
Implement this to create a buffer for the output.
An empty output structure that the process can store the output of its process on.

code: virtual [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) * CreateOutputBuffer ( int32 InputWidth, int32 InputHeight )


description:
Gets the human readable name for this capture process. This name will be used in stats readouts so the shorter the better.
A human readable name for this capture process.

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


description: Initializes the process to be ready for work. Called once at startup.

code: virtual void Initialize ( int32 InputWidth, int32 InputHeight )


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

code: class FPixelCaptureCapturerNV12ToRHI : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerNV12ToRHI >](API\Runtime\Core\Templates\TSharedFromThis)


description: Creates a new Capturer capturing the input frame at the given scale.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerRHI](API\Plugins\PixelCapture\FPixelCaptureCapturerRHI) > Create ( float InScale )


code: virtual ~FPixelCaptureCapturerRHI()


className: FPixelCaptureCapturerRHI

code: class FPixelCaptureCapturerRHI : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerRHI >](API\Runtime\Core\Templates\TSharedFromThis)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerRHINoCopy](API\Plugins\PixelCapture\FPixelCaptureCapturerRHINoCopy) > Create ( float InScale )


className: FPixelCaptureCapturerRHINoCopy

code: class FPixelCaptureCapturerRHINoCopy : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerRHINoCopy >](API\Runtime\Core\Templates\TSharedFromThis)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerRHIRDG](API\Plugins\PixelCapture\FPixelCaptureCapturerRHIRDG) > Create ( float InScale )


code: virtual ~FPixelCaptureCapturerRHIRDG()


className: FPixelCaptureCapturerRHIRDG

code: class FPixelCaptureCapturerRHIRDG : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerRHIRDG >](API\Runtime\Core\Templates\TSharedFromThis)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerRHIToI420Compute](API\Plugins\PixelCapture\FPixelCaptureCapturerRHIToI420Co-) > Create ( float InScale )


code: class FPixelCaptureCapturerRHIToI420Compute : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerRHIToI420Compute >](API\Runtime\Core\Templates\TSharedFromThis)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureCapturerRHIToI420CPU](API\Plugins\PixelCapture\FPixelCaptureCapturerRHIToI420CP-) > Create ( float InScale )


className: FPixelCaptureFrameMetadata

code: struct FPixelCaptureFrameMetadata

CaptureTime

description: Capture process timings. Duration not timestamp.

DisplayTime

description: Display process timings. Duration not timestamp.

FirstDecodeStartTime

description: Decode Timings.

FirstEncodeStartTime

description: Encode Timings.

FirstPacketizationStartTime

description: Packet Timings.

Layer

description: Which layer this specific frame is associated with.

ProcessName

type: FString

description: Identifier for the capture pipeline/process this frame took.

SourceTime

description: The time this frame was sourced/created.

UseCount

description: Frame use timings (can happen multiple times. ie. we are consuming frames faster than producing them)


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) > GetBuffer() const


code: class FPixelCaptureCapturerRHIToI420CPU : public [FPixelCaptureCapturer](API\Plugins\PixelCapture\FPixelCaptureCapturer), public [TSharedFromThis< FPixelCaptureCapturerRHIToI420CPU >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Should return a unique type id from either EPixelCaptureBufferFormat or an extended user implemented enum. Value crashes could result in incorrect/unsafe casting.
A unique id value for the implementation of this interface.

code: virtual int32 GetType() const


description:
Gets the width of the input frame.
The pixel width of the input frame.

code: virtual int32 GetWidth() const


code: FPixelCaptureInputFrameI420 ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) > Buffer )


code: virtual ~FPixelCaptureInputFrameI420()


description: Wanted this to be explicit with a name


description: A basic input frame for the Capture system that wraps a I420 buffer.

code: class FPixelCaptureInputFrameI420 : public [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame)


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferNV12](API\Plugins\PixelCapture\FPixelCaptureBufferNV12) > GetBuffer() const


description:
Gets the height of the input frame.
The pixel height of the input frame.

code: virtual int32 GetHeight() const


code: FPixelCaptureInputFrameNV12 ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferNV12](API\Plugins\PixelCapture\FPixelCaptureBufferNV12) > Buffer )


code: virtual ~FPixelCaptureInputFrameNV12()


code: class FPixelCaptureInputFrameNV12 : public [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame)


code: FPixelCaptureInputFrameRHI ( FTexture2DRHIRef InFrameTexture )


code: virtual ~FPixelCaptureInputFrameRHI()


className: FPixelCaptureInputFrameRHI

description: A basic input frame for the Capture system that wraps a RHI texture buffer.

code: class FPixelCaptureInputFrameRHI : public [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame)


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) > GetI420Buffer() const


code: FPixelCaptureOutputFrameI420 ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelCaptureBufferI420](API\Plugins\PixelCapture\FPixelCaptureBufferI420) > InI420Buffer )


code: virtual ~FPixelCaptureOutputFrameI420()


description: A basic output frame from the Capture system that wraps a I420 buffer.

code: class FPixelCaptureOutputFrameI420 : public [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame)


code: virtual bool GetWrapperFormatData ( [WrapperFormatData](API\Plugins\PixelCapture\FPixelCaptureOutputFrameRHI\WrapperFormatData) & OutData ) const


className: WrapperFormatData

description: Sometimes we need to pack data in a pixel format not fully supported by the RHI, so we may instead store it as a different format for transport and read it as the original format sometime later, this struct is meant to hold information about the wrapper format if it exists

code: struct WrapperFormatData

Format

type: EPixelFormat


code: void SetFrameTexture ( FTexture2DRHIRef InFrameTexture )


code: FPixelCaptureOutputFrameRHI ( FTexture2DRHIRef InFrameTexture )


code: FPixelCaptureOutputFrameRHI ( FTexture2DRHIRef InFrameTexture, [WrapperFormatData](API\Plugins\PixelCapture\FPixelCaptureOutputFrameRHI\WrapperFormatData) InWrapperData )


code: virtual ~FPixelCaptureOutputFrameRHI()


className: FPixelCaptureOutputFrameRHI

description: A basic output frame from the Capture system that wraps a RHI texture buffer.

code: class FPixelCaptureOutputFrameRHI : public [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame)


description: Gets a const pointer to the beginning of entire buffer for reading.

code: const uint8_t * GetData() const


description: Gets the Format of the buffer can be used to cast to the Specific type.

code: int32 GetFormat() const


description: Gets a pointer to the beginning of the entire buffer for editing.

code: uint8_t * GetMutableData()


description: Gets the total size of this buffer.

code: int64 GetSize() const


description: Get the height of the frame

code: int32 GetHeight() const


description: Get the width of the frame

code: int32 GetWidth() const


className: IPixelCaptureBuffer

description: Buffer Template for defining frame data.

code: class IPixelCaptureBuffer


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.

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


className: IPixelCaptureCapturerSource

description: The interface that is queried when the Layered or Multi capturers wish to create specific Capturers for a given format.

code: class IPixelCaptureCapturerSource


code: int32 GetType() const


className: IPixelCaptureInputFrame

description: The base interface that is fed into the capture system. This wrapper is fed into theFPixelCaptureCapturerobjects for each format/scale. The capturer should then cast to the known type fed into the system to unwrap the data.

code: class IPixelCaptureInputFrame

Metadata

type: FPixelCaptureFr...

description: Internal structure that contains various bits of information about the capture process


code: virtual ~IPixelCaptureInputFrame()


code: virtual ~IPixelCaptureOutputFrame()


className: IPixelCaptureOutputFrame

description: Wraps the output of the capture process for a single layer. Extend this for your own result types. You must implement GetWidth and GetHeight to return the width and height of the frame. Add your own method to extract the captured data.

code: class IPixelCaptureOutputFrame

description: Internal structure that contains various bits of information about the capture and encode process


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_UNKNOWN = 0; }


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_RHI = 1; }


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_I420 = 2; }


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_NV12 = 3; }


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_P010 = 4; }


code: namespace PixelCaptureBufferFormat { static const int32 PixelCaptureBufferFormat::FORMAT_USER = 128; }


module: PixelCaptureShaders

code: static void Dispatch ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, const [FRGBToYUVShaderParameters](API\Plugins\PixelCaptureShaders\FRGBToYUVShaderParameters) & InParameters )


className: FRGBToYUVShader

code: class FRGBToYUVShader


className: FRGBToYUVShaderParameters

code: struct FRGBToYUVShaderParameters

DestPlaneU

type: FUnorderedAcces...

DestPlaneUVDimensions

type: FIntPoint

SourceTexture

type: FTextureRHIRef


module: PixelStreaming

code: template<typename T> void Insert ( T && Value )


code: BufferBuilder ( size_t size )


className: BufferBuilder

code: struct BufferBuilder


className: EPixelStreamingCodec

code: enum EPixelStreamingCodec { Invalid, H264, H265, VP8, VP9, }


code: static [FPixelStreamingCreateSessionDescriptionObserver](API\Plugins\PixelStreaming\FPixelStreamingCreateSessionDesc-) * Create ( const [FSuccessCallback](API\Plugins\PixelStreaming\FPixelStreamingCreateSessionDesc-\FSuccessCallback) & successCallback, const [FFailureCallback](API\Plugins\PixelStreaming\FPixelStreamingCreateSessionDesc-\FFailureCallback) & failureCallback )


className: FFailureCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &)> FFailureCallback


className: FSuccessCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(webrtc::SessionDescriptionInterface *)> FSuccessCallback


code: void OnFailure ( webrtc::RTCError Error )


code: void OnSuccess ( webrtc::SessionDescriptionInterface * SDP )


code: FPixelStreamingCreateSessionDescriptionObserver ( const [FSuccessCallback](API\Plugins\PixelStreaming\FPixelStreamingCreateSessionDesc-\FSuccessCallback) & successCallback, const [FFailureCallback](API\Plugins\PixelStreaming\FPixelStreamingCreateSessionDesc-\FFailureCallback) & failureCallback )


code: class FPixelStreamingCreateSessionDescriptionObserver : public CreateSessionDescriptionObserver


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) > Create ( rtc::scoped_refptr< webrtc::DataChannelInterface > InChannel )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) > Create ( [FPixelStreamingPeerConnection](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection) & Connection, int32 SendStreamId, int32 RecvStreamId )


className: FOnClosed

description: Broadcast when the data channel state changes to closed

code: typedef TMulticastDelegate_OneParam< void, [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) & > FOnClosed


className: FOnMessage

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

code: typedef TMulticastDelegate_TwoParams< void, uint8, const webrtc::DataBuffer & > FOnMessage


className: FOnOpen

description: Broadcast when the data channel state changes to open

code: typedef TMulticastDelegate_OneParam< void, [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) & > FOnOpen


code: virtual void OnMessage ( const webrtc::DataBuffer & Buffer )


description: Webrtc::DataChannelObserver implementation.

code: virtual void OnStateChange()


description:
Sends a large buffer of data to the data channel.
True when all data was successfully sent.

code: bool SendArbitraryData ( uint8 Type, const TArray64< uint8 > & DataBytes ) const


description:
Sends a series of arguments to the data channel with the given type.
True of the message was successfully sent.

code: template<typename... Args> bool SendMessage ( uint8 Type, Args... VarArgs )


code: virtual ~FPixelStreamingDataChannel()


className: FPixelStreamingDataChannel

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

code: class FPixelStreamingDataChannel : public DataChannelObserver, public [TSharedFromThis< FPixelStreamingDataChannel >](API\Runtime\Core\Templates\TSharedFromThis)

OnClosed

type: FOnClosed

OnMessageReceived

type: FOnMessage

OnOpen

type: FOnOpen


description: Adds ICE candidate data to the peer connection. Usually supplied from the signalling server.

code: void AddRemoteIceCandidate ( const [FString](API\Runtime\Core\Containers\FString) & SDPMid, int SDPMLineIndex, const [FString](API\Runtime\Core\Containers\FString) & SDP )


className: ApplicationAudioSource

code: static rtc::scoped_refptr< webrtc::AudioSourceInterface > ApplicationAudioSource = nullptr;


className: AudioMixer

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< UE::PixelStreaming::FAudioInputMixer > AudioMixer = MakeShared<UE::PixelStreaming::FAudioInputMixer>();


description:
Creates a new peer connection using the given RTC configuration.
A new peer connection ready to be used.

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FPixelStreamingPeerConnection](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection) > Create ( const [FRTCConfig](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\FRTCConfig) & RTCConfig, bool IsSFU )


description: Asynchronously creates an answer session description for this local peer connection.

code: void CreateAnswer ( [EReceiveMediaOption](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\EReceiveMediaOption) ReceiveOption, const [SDPCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\SDPCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


description: Creates a data connection associated with this peer connection.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) > CreateDataChannel ( int Id, bool Negotiated )


description: Asynchronously creates an offer session description for this local peer connection.

code: void CreateOffer ( [EReceiveMediaOption](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\EReceiveMediaOption) ReceiveOption, const [SDPCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\SDPCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


className: EReceiveMediaOption

description: Flags for CreateOffer/CreateAnswer that indicate what kind of media we indend to receive. Dictates what the resulting SDP will contain. To actually receive audio or video you will need to supply sinks via SetAudioSink/SetVideoSink

code: enum EReceiveMediaOption { Nothing = 0x00, Audio = 0x01, Video = 0x02, All = Audio | Video, }


className: ErrorCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &Error)> ErrorCallback


className: ESDPType

code: enum ESDPType { Offer, Answer, }


className: FOnDataChannel

description: Called when a data channel is opened from the remote side of this connection.

code: typedef TMulticastDelegate_OneParam< void, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingDataChannel](API\Plugins\PixelStreaming\FPixelStreamingDataChannel) > > FOnDataChannel


className: FOnIceCandidate

description: Called when the ICE candidate is emitted.

code: typedef TMulticastDelegate_OneParam< void, const webrtc::IceCandidateInterface * > FOnIceCandidate


className: FOnIceStateChanged

description: Called when the ICE state changes.

code: typedef TMulticastDelegate_OneParam< void, webrtc::PeerConnectionInterface::IceConnectionState > FOnIceStateChanged


description: Causes the video stream to generate a keyframe

code: static void ForceVideoKeyframe()


description:
Gets the global audio source.
The global audio source.

code: static rtc::scoped_refptr< webrtc::AudioSourceInterface > GetApplicationAudioSource()


description:
Gets the currently set audio sink on this connection.
The currently set audio sink. Can be nullptr.


description:
Gets the currently set audio source on this connection.
The currently set audio source. Can be nullptr.

code: rtc::scoped_refptr< webrtc::AudioSourceInterface > GetAudioSource() const


description:
Gets the current local description.
The session description object representing the local description. Can be nullptr.

code: const webrtc::SessionDescriptionInterface * GetLocalDescription() const


description: The negotiated video codec as parsed from the SDP offer/answer. Note: This changes as new offer/answers come in potentially.


description:
Gets the current remote description.
The session description object representing the remote description. Can be nullptr.

code: const webrtc::SessionDescriptionInterface * GetRemoteDescription() const


description:
Gets the currently set video sink on this connection.
The currently set video sink. Can be nullptr.

code: rtc::VideoSinkInterface< webrtc::VideoFrame > * GetVideoSink()


description:
Gets the currently set video source on this connection.
The currently set video source. Can be nullptr.

code: rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > GetVideoSource() const


code: virtual void OnAddStream ( rtc::scoped_refptr< webrtc::MediaStreamInterface > Stream )


code: virtual void OnDataChannel ( rtc::scoped_refptr< webrtc::DataChannelInterface > Channel )


code: virtual void OnIceCandidate ( const webrtc::IceCandidateInterface * Candidate )


code: virtual void OnIceCandidatesRemoved ( const std::vector< cricket::Candidate > & candidates )


code: virtual void OnIceConnectionChange ( webrtc::PeerConnectionInterface::IceConnectionState NewState )


code: virtual void OnIceConnectionReceivingChange ( bool Receiving )


code: virtual void OnIceGatheringChange ( webrtc::PeerConnectionInterface::IceGatheringState NewState )


code: virtual void OnRemoveStream ( rtc::scoped_refptr< webrtc::MediaStreamInterface > Stream )


code: virtual void OnRenegotiationNeeded()


code: virtual void OnRemoveTrack ( rtc::scoped_refptr< webrtc::RtpReceiverInterface > receiver )


description: Webrtc::PeerConnectionObserver implementation.

code: virtual void OnSignalingChange ( webrtc::PeerConnectionInterface::SignalingState NewState )


code: virtual void OnTrack ( rtc::scoped_refptr< webrtc::RtpTransceiverInterface > Transceiver )


className: PeerConnectionFactory

code: static rtc::scoped_refptr< webrtc::PeerConnectionFactoryInterface > PeerConnectionFactory = nullptr;


description: Post a task onto the WebRTC signalling thread.

code: template<typename FunctorT> static void PostSignalingTask ( FunctorT && InFunc )


description: Asynchronously sets the remote description from a session description string offered from a signalling server.

code: void ReceiveOffer ( const [FString](API\Runtime\Core\Containers\FString) & SDP, const [VoidCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\VoidCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


description: Asynchronously sets the remote description from a session description string answered from a signalling server.

code: void ReceiveAnswer ( const [FString](API\Runtime\Core\Containers\FString) & SDP, const [VoidCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\VoidCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


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


className: SDPCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const webrtc::SessionDescriptionInterface *)> SDPCallback


description: Sets an audio sink on this connection that will receive audio data from this connection.

code: void SetAudioSink ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingAudioSink](API\Plugins\PixelStreaming\IPixelStreamingAudioSink) > InSink )


description: Sets an audio source that can supply this connection with audio data.  InAudioSource The source of audio data.

code: void SetAudioSource ( rtc::scoped_refptr< webrtc::AudioSourceInterface > InAudioSource )


description: Asynchronously sets the local description using the given session description object.

code: void SetLocalDescription ( webrtc::SessionDescriptionInterface * SDP, const [VoidCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\VoidCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


description: Asynchronously sets the remote description using the given session description object.

code: void SetRemoteDescription ( webrtc::SessionDescriptionInterface * SDP, const [VoidCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\VoidCallback) & SuccessCallback, const [ErrorCallback](API\Plugins\PixelStreaming\FPixelStreamingPeerConnection\ErrorCallback) & ErrorCallback )


description: Sets a video sink on this connection that will receive frame data from this connection.

code: void SetVideoSink ( rtc::VideoSinkInterface< webrtc::VideoFrame > * InSink )


description: Sets a video source that can supply this connection with frame data.  InVideoSource The source of frame data.

code: void SetVideoSource ( rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > InVideoSource )


description: Sets the callback to be used when the stats collector comes knocking. Decides how stats should be collected.

code: void SetWebRTCStatsCallback ( rtc::scoped_refptr< webrtc::RTCStatsCollectorCallback > InCallback )


description: Shuts down the WebRTC thread and destroys the peer connection factory. No peer connections should be in use after this call.

code: static void Shutdown()


className: SignallingThread

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< rtc::Thread > SignallingThread = nullptr;


className: VoidCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> VoidCallback


className: FPixelStreamingPeerConnection

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

code: class FPixelStreamingPeerConnection : public PeerConnectionObserver

OnEmitIceCandidate

type: FOnIceCandidate

OnIceStateChanged

type: FOnIceStateChan...

OnNewDataChannel

type: FOnDataChannel


className: FPixelStreamingPlayerConfig

code: struct FPixelStreamingPlayerConfig

IsSFU

type: bool


className: FFailureCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &)> FFailureCallback


code: static [FPixelStreamingSetSessionDescriptionObserver](API\Plugins\PixelStreaming\FPixelStreamingSetSessionDescrip-) * Create ( const [FSuccessCallback](API\Plugins\PixelStreaming\FPixelStreamingSetSessionDescrip-\FSuccessCallback) & successCallback, const [FFailureCallback](API\Plugins\PixelStreaming\FPixelStreamingSetSessionDescrip-\FFailureCallback) & failureCallback )


className: FSuccessCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> FSuccessCallback


description: Errors usually mean incompatibility between our session configuration (often H.264, its profile and level) and player, malformed SDP or if player doesn't support UnifiedPlan (whatever was used by proxy)

code: void OnFailure ( webrtc::RTCError Error )


description: We don't need to do anything on success

code: void OnSuccess()


code: FPixelStreamingSetSessionDescriptionObserver ( const [FSuccessCallback](API\Plugins\PixelStreaming\FPixelStreamingSetSessionDescrip-\FSuccessCallback) & successCallback, const [FFailureCallback](API\Plugins\PixelStreaming\FPixelStreamingSetSessionDescrip-\FFailureCallback) & failureCallback )


description: FPixelStreamingSetSessionDescriptionObserverWebRTC requires an implementation ofwebrtc::SetSessionDescriptionObserver_ interface as a callback for setting session description, either on receiving remoteoffer_ (PeerConnection::SetRemoteDescription_) of on sendinganswer_ (`PeerConnection::SetLocalDescription_)

code: class FPixelStreamingSetSessionDescriptionObserver : public SetSessionDescriptionObserver


code: static bool GetCaptureUseFence()


code: static bool GetVPXUseCompute()


className: FPixelStreamingSettings

description: A collection of static methods used to expose settings and their values to other modules dependedant on PixelStreaming

code: class FPixelStreamingSettings


description: Disconnects from the signalling server. Safe to call even when not connected.

code: virtual void Disconnect()


description:
Checks if the connection is established.
True when the signalling server is connected.

code: virtual bool IsConnected() const


className: FJsonObjectPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > FJsonObjectPtr


description: Request a list of active streamers from the signalling server. This is a request to the signalling server so can be used by anyone.

code: virtual void RequestStreamerList()


description: [Stream receiver only] Sends an answer back to the streamer after receiving an offer.

code: virtual void SendAnswer ( const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Sends an answer to the specified player.

code: virtual void SendAnswer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Send a disconnect message to the specified player.

code: virtual void SendDisconnectPlayer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const [FString](API\Runtime\Core\Containers\FString) & Reason )


description: [Stream receiver only] Sends ICE candidate information to the streamer.

code: virtual void SendIceCandidate ( const webrtc::IceCandidateInterface & IceCandidate )


description: [Streamer only] Sends ice candidate information to the specified player.

code: virtual void SendIceCandidate ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::IceCandidateInterface & IceCandidate )


description: Send a message to the signalling server.

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


description: [Stream receiver only] Sends an offer to the streamer.

code: virtual void SendOffer ( const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Sends an offer to the specified player.

code: virtual void SendOffer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::SessionDescriptionInterface & SDP )


description: [Stream receiver only] Send a subscription request to the signalling server.

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


description: [Stream receiver only] Send an unsubscribe request to the signalling server.

code: virtual void SendUnsubscribe()


description: Toggles automatic reconnecting when websocket is closed or unreachable.

code: virtual void SetAutoReconnect ( bool bAutoReconnect )


description: Enables or disables the keep alive pings on this connection. Receiving connections should disable the keep alive since the reference signalling server will reject pings from players and close the connection.

code: virtual void SetKeepAlive ( bool bKeepAlive )


description: IPixelStreamingSignallingConnectionInterface

code: virtual void TryConnect ( [FString](API\Runtime\Core\Containers\FString) URL )


code: FPixelStreamingSignallingConnection ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingSignallingConnectionObserver](API\Plugins\PixelStreaming\IPixelStreamingSignallingConnect-_1) > InObserver, [FString](API\Runtime\Core\Containers\FString) InStreamerId )


className: FPixelStreamingSignallingConnection

description: A specialized signalling server connection object for web socket based Pixel Streaming signalling servers.

code: class FPixelStreamingSignallingConnection : public [IPixelStreamingSignallingConnection](API\Plugins\PixelStreaming\IPixelStreamingSignallingConnect-)


className: FPixelStreamingSimulcastLayer

code: struct FPixelStreamingSimulcastLayer

MaxBitrate

type: int

Scaling

type: float


className: FPixelStreamingSimulcastParameters

description: A struct representing the simulcast paramaters used by PixelStreaming. The parameters contain an array of layers, with each layer having a Scale, MinBitrate and MaxBitrate

Layers

type: TArray<FPixelS...


code: void AddOutputFormat ( int32 Format )


className: FOnFrameCaptured

description: This is broadcast each time a frame exits the adapt process. Used to synchronize framerates with input rates. This should be called once per frame taking into consideration all the target formats and layers within the frame.

code: typedef TMulticastDelegate_NoParams< void > FOnFrameCaptured


description: Used internally by the encode process.

code: rtc::scoped_refptr< webrtc::VideoFrameBuffer > GetFrameBuffer()


className: NextStreamId

code: static uint32 NextStreamId = 1;


description: Feed the input with a new captured frame.

code: virtual void OnFrame ( const [IPixelCaptureInputFrame](API\Plugins\PixelCapture\IPixelCaptureInputFrame) & InputFrame )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelCaptureOutputFrame](API\Plugins\PixelCapture\IPixelCaptureOutputFrame) > RequestFormat ( int32 Format, int32 LayerIndex )


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


code: virtual ~FPixelStreamingVideoInput()


code: FPixelStreamingVideoInput()


className: FPixelStreamingVideoInput

description: The input of the Pixel Streaming system. Frames enter the system when OnFrame is called. The input buffers might need to be converted/adapted to suit the selected video encoder. CreateAdaptProcess should create a PixelStreamingFrameAdapterProcess that does this work.

code: class FPixelStreamingVideoInput : public [IPixelCaptureCapturerSource](API\Plugins\PixelCapture\IPixelCaptureCapturerSource)

OnFrameCaptured

type: FOnFrameCapture...


className: FPixelStreamingVideoInputBackBuffer

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

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


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.

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


description: A Generic video input for I420 frames

code: class FPixelStreamingVideoInputI420 : public [FPixelStreamingVideoInput](API\Plugins\PixelStreaming\FPixelStreamingVideoInput)


description: A Generic video input for NV12 frames

code: class FPixelStreamingVideoInputNV12 : public [FPixelStreamingVideoInput](API\Plugins\PixelStreaming\FPixelStreamingVideoInput)


className: FPixelStreamingVideoInputPIEViewport

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


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPixelStreamingVideoInputRenderTarget](API\Plugins\PixelStreaming\FPixelStreamingVideoInputRenderT-) > Create ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * Target )


className: FPixelStreamingVideoInputRenderTarget

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


code: FPixelStreamingVideoInputRHI()


code: virtual ~FPixelStreamingVideoInputRHI()


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


className: FPixelStreamingVideoInputRHI

description: A Generic video input for RHI frames

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


description: Returns the number of samples to render per callback.

code: virtual int32 GetDesiredNumSamplesToRenderPerCallback() const


description: Optional. Can be overridden to end the sound when generating is finished.

code: virtual bool IsFinished() const


description: Optional. Called on audio generator thread right when the generator begins generating.

code: virtual void OnBeginGenerate()


description: Optional. Called on audio generator thread right when the generator ends generating.

code: virtual void OnEndGenerate()


description: Called when a new buffer is required.

code: virtual int32 OnGenerateAudio ( float * OutAudio, int32 NumSamples )


code: void SetParameters ( const [FSoundGeneratorInitParams](API\Runtime\Engine\Sound\FSoundGeneratorInitParams) & InitParams )


code: static const [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) INVALID_PLAYER_ID = ToPlayerId(FString(TEXT("Invalid Player Id")));


className: FWebRTCSoundGenerator

description: An `ISoundGenerator_ implementation to pump some audio from WebRTC into this synth component

code: class FWebRTCSoundGenerator : public [ISoundGenerator](API\Runtime\Engine\Sound\ISoundGenerator)

bGeneratingAudio

type: FThreadSafeBool


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


code: IPixelStreamingAudioConsumer()


code: IPixelStreamingAudioInput()


code: virtual ~IPixelStreamingAudioConsumer()


className: IPixelStreamingAudioConsumer

description: Interface for consuming audio coming in from the browser.

code: class IPixelStreamingAudioConsumer


description: Pushes audio, which must match the underlying sample rate/num channels of the mixer.

code: void PushAudio ( const float * InBuffer, int32 NumSamples, int32 NumChannels, int32 SampleRate )


code: virtual ~IPixelStreamingAudioInput()


className: IPixelStreamingAudioInput

code: class IPixelStreamingAudioInput


code: void AddAudioConsumer ( [IPixelStreamingAudioConsumer](API\Plugins\PixelStreaming\IPixelStreamingAudioConsumer) * AudioConsumer )


code: IPixelStreamingAudioSink()


code: void RemoveAudioConsumer ( [IPixelStreamingAudioConsumer](API\Plugins\PixelStreaming\IPixelStreamingAudioConsumer) * AudioConsumer )


code: virtual ~IPixelStreamingAudioSink()


className: IPixelStreamingAudioSink

description: Interface for a sink that collects audio coming in from the browser and passes into into UE's audio system.

code: class IPixelStreamingAudioSink : public AudioTrackSinkInterface


description: Tell the input device about a new pixel streaming input component.

code: void AddInputComponent ( [UPixelStreamingInput](API\Plugins\PixelStreaming\UPixelStreamingInput) * InInputComponent )


description: Allows the creation of Video Tracks that are fed the backbuffer

code: rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > CreateExternalVideoSource()


description: Creates a new streamer.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > CreateStreamer ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description:
Create a webrtc::VideoEncoderFactory pointer.
A WebRTC video encoder factory with its encoders populated by Pixel Streaming.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< webrtc::VideoEncoderFactory > CreateVideoEncoderFactory()


description:
Remove a streamer by an ID
The removed streamer. nullptr if the streamer wasn't found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > DeleteStreamer ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description: Remove a streamer by its pointer

code: void DeleteStreamer ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > ToBeDeleted )


description: Find the function to be called whenever the specified message is received.TFunctionThe function called when this message 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 )


description: A method for iterating through all of the streamers on the module.

code: void ForEachStreamer ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) >)> & Func )


className: FReadyEvent

description: Event fired when internal streamer is initialized and the methods on this module are ready for use.

code: class FReadyEvent : public TBaseMulticastDelegate_OneParam< void, IPixelStreamingModule & >


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 [IPixelStreamingModule](API\Plugins\PixelStreaming\IPixelStreamingModule) & Get()


description:
Gets the currently selected encoder codec for all of Pixel Streaming.
A valid EPixelStreamingCodec value.


description:
Get the input components currently attached to Pixel Streaming.
An array of input components.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [UPixelStreamingInput](API\Plugins\PixelStreaming\UPixelStreamingInput) * > GetInputComponents()


description: Get the Default Signaling URL ("ws://127.0.0.1:8888")FStringThe default signaling url ("ws://127.0.0.1:8888")


description: Get the Default Streamer IDFStringThe default streamer ID


description: Get the protocol currently used by each peer.


description:
Find a streamer by an ID.
A pointer to the interface for a streamer. nullptr if the streamer isn't found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > FindStreamer ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description:
Get a streamer by an ID. // This method has been renamed as the module isn't responsible for a Streamer's lifetime, so renaming to Find as opposed to Get makes this more obvious
A pointer to the interface for a streamer. nullptr if the streamer isn't found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPixelStreamingStreamer](API\Plugins\PixelStreaming\IPixelStreamingStreamer) > GetStreamer ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description: Returns aTArraycontaining the keys to the currently held streamers.TArraycontaining the keys to the currently held streamers.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetStreamerIds()


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

code: static bool IsAvailable()


description:
Is the PixelStreaming module actually ready to use? Is the streamer created.
True if Pixel Streaming module methods are ready for use.

code: bool IsReady()


description:
A getter for the OnReady event. Intent is for users to callIPixelStreamingModule::Get().OnReady().AddXXX.
The bindable OnReady event.


description: Register a new message that peers can send and pixel streaming can receive.

code: void RegisterMessage ( [EPixelStreamingMessageDirection](API\Plugins\PixelStreamingInput\EPixelStreamingMessageDirection) MessageDirection, const [FString](API\Runtime\Core\Containers\FString) & MessageType, [FPixelStreamingInputMessage](API\Plugins\PixelStreamingInput\FPixelStreamingInputMessage) Message, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FMemoryReader](API\Runtime\Core\Serialization\FMemoryReader))> & Handler )


description: Used to clean up sources no longer needed

code: void ReleaseExternalVideoSource ( const webrtc::VideoTrackSourceInterface * InVideoSource )


description: Tell the input device that a pixel streaming input component is no longer relevant.

code: void RemoveInputComponent ( [UPixelStreamingInput](API\Plugins\PixelStreaming\UPixelStreamingInput) * InInputComponent )


description: Sets the encoder codec for the whole Pixel Streaming module. Should be called before any streaming starts.

code: void SetCodec ( [EPixelStreamingCodec](API\Plugins\PixelStreaming\EPixelStreamingCodec) Codec )


description: Control coupling the external video source framerate to the video input framerate

code: void SetExternalVideoSourceCoupleFramerate ( bool bShouldCoupleFPS )


description: Sets the target FPS for Externally Consumed video Tracks

code: void SetExternalVideoSourceFPS ( uint32 InFPS )


description: Hook to set the input to the external video source. Will also call Start() on the external video source

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


description: Starts streaming on all streamers.

code: bool StartStreaming()


description: Stops all streamers from streaming.

code: void StopStreaming()


className: IPixelStreamingModule

description: The public interface of the Pixel Streaming module.

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


description: Disconnects from the signalling server. Safe to call even when not connected.

code: void Disconnect()


description:
Checks if the connection is established.
True when the signalling server is connected.

code: bool IsConnected() const


description: Request a list of active streamers from the signalling server. This is a request to the signalling server so can be used by anyone.

code: void RequestStreamerList()


description: [Stream receiver only] Sends an answer back to the streamer after receiving an offer.

code: void SendAnswer ( const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Sends an answer to the specified player.

code: void SendAnswer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Send a disconnect message to the specified player.

code: void SendDisconnectPlayer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const [FString](API\Runtime\Core\Containers\FString) & Reason )


description: [Stream receiver only] Sends ICE candidate information to the streamer.

code: void SendIceCandidate ( const webrtc::IceCandidateInterface & IceCandidate )


description: [Streamer only] Sends ice candidate information to the specified player.

code: void SendIceCandidate ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::IceCandidateInterface & IceCandidate )


description: Send a message to the signalling server.

code: void SendMessage ( const [FString](API\Runtime\Core\Containers\FString) & Msg )


description: [Stream receiver only] Sends an offer to the streamer.

code: void SendOffer ( const webrtc::SessionDescriptionInterface & SDP )


description: [Streamer only] Sends an offer to the specified player.

code: void SendOffer ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const webrtc::SessionDescriptionInterface & SDP )


description: [Stream receiver only] Send a subscription request to the signalling server.

code: void SendSubscribe ( const [FString](API\Runtime\Core\Containers\FString) & StreamerId )


description: [Stream receiver only] Send an unsubscribe request to the signalling server.

code: void SendUnsubscribe()


description: Toggles automatic reconnecting when websocket is closed or unreachable.

code: void SetAutoReconnect ( bool bAutoReconnect )


description: Enables or disables the keep alive pings on this connection. Receiving connections should disable the keep alive since the reference signalling server will reject pings from players and close the connection.

code: void SetKeepAlive ( bool bKeepAlive )


description: Connect to a specified signalling server at ths given URL

code: void TryConnect ( [FString](API\Runtime\Core\Containers\FString) URL )


className: IPixelStreamingSignallingConnection

description: A specialized signalling server connection object for Pixel Streaming signalling servers.


code: void OnSignallingConfig ( const webrtc::PeerConnectionInterface::RTCConfiguration & Config )


code: void OnSignallingConnected()


code: void OnSignallingDisconnected ( int32 StatusCode, const [FString](API\Runtime\Core\Containers\FString) & Reason, bool bWasClean )


code: void OnSignallingPeerDataChannels ( int32 SendStreamId, int32 RecvStreamId )


code: void OnSignallingError ( const [FString](API\Runtime\Core\Containers\FString) & ErrorMsg )


description: Deprecated* Please useOnSignallingPlayerConnected(FPixelStreamingPlayerId PlayerId, const FPixelStreamingPlayerConfig& PlayerConfig, bool bSendOffer). Using this method defaults bSendOffer to true!

code: virtual void OnSignallingPlayerConnected ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const [FPixelStreamingPlayerConfig](API\Plugins\PixelStreaming\FPixelStreamingPlayerConfig) & PlayerConfig )


code: void OnSignallingPlayerConnected ( [FPixelStreamingPlayerId](API\Plugins\PixelStreaming\FPixelStreamingPlayerId) PlayerId, const [FPixelStreamingPlayerConfig](API\Plugins\PixelStreaming\FPixelStreamingPlayerConfig) & PlayerConfig, bool bSendOffer )


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


code: void OnSignallingPlayerCount ( uint32 Count )


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