1. Epic GamesDeveloper
  3. UPixelStreamingPeerComponent

UPixelStreamingPeerComponent

A blueprint representation of a Pixel Streaming Peer Connection.

API > API/Plugins > API/Plugins/PixelStreamingPlayer

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

   
Name UPixelStreamingPeerComponent
Type class
Header File /Engine/Plugins/Experimental/PixelStreamingPlayer/Source/PixelStreamingPlayer/Public/PixelStreamingPeerComponent.h
Include Path #include "PixelStreamingPeerComponent.h"

Syntax

UCLASS (BlueprintType, Blueprintable, Category="PixelStreaming",  
       Meta=(DisplayName="PixelStreaming Peer Component", BlueprintSpawnableComponent))  
class UPixelStreamingPeerComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPixelStreamingPeerComponent ( const FObjectInitializer& ObjectInitializer
)

   PixelStreamingPeerComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnIceCandidate FPixelStreamingOnIceCandidate Once negotiation is completed the Peer Connection can generate Ice Candidate objects. PixelStreamingPeerComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnIceConnection FPixelStreamingOnIceConnection Once a connection has been connected and streaming should be available. PixelStreamingPeerComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnIceDisconnection FPixelStreamingOnIceDisconnection When an ice connection is lost. PixelStreamingPeerComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
VideoSink TObjectPtr< UPixelStreamingMediaTexture > A sink for the video data received once this connection has finished negotiating. PixelStreamingPeerComponent.h
  • EditDefaultsOnly
  • Category="Properties"
  • Meta=(DisplayName="Pixel Streaming Video Sink", AllowPrivateAccess=true)

Protected

Name Type Remarks Include Path Unreal Specifiers
PeerConnection TUniquePtr< FPixelStreamingPeerConnection >   PixelStreamingPeerComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FPixelStreamingSessionDescriptionWrapper CreateAnswer ( const FString& Offer
)

 Creates an answer to the given offer objet that was provided. PixelStreamingPeerComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"
Creates an offer. PixelStreamingPeerComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void ReceiveAnswer ( const FString& Offer
)

 Receives an answer from a streamer after we've sent an offer to receive. PixelStreamingPeerComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void ReceiveIceCandidate ( const FPixelStreamingIceCandidateWrapper& Candidate
)

 Notify the peer connection of an ICE candidate sent by the singalling connection. PixelStreamingPeerComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void SetConfig ( const FPixelStreamingRTCConfigWrapper& Config
)

 Sets the RTC Configuration for this Peer Connection. PixelStreamingPeerComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page