Navigation
API > API/Plugins > API/Plugins/PixelStreamingPlayer
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UPixelStreamingPeerComponent
References
| Module | PixelStreamingPlayer |
| Header | /Engine/Plugins/Experimental/PixelStreamingPlayer/Source/PixelStreamingPlayer/Public/PixelStreamingPeerComponent.h |
| Include | #include "PixelStreamingPeerComponent.h" |
Syntax
UCLASS (BlueprintType, Blueprintable, Category="PixelStreaming",
Meta=(DisplayName="PixelStreaming Peer Component", BlueprintSpawnableComponent))
class UPixelStreamingPeerComponent : public UActorComponent
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
FPixelStreamingOnIceCandidate | OnIceCandidate | Once negotiation is completed the Peer Connection can generate Ice Candidate objects. |
    |
FPixelStreamingOnIceConnection | OnIceConnection | Once a connection has been connected and streaming should be available. |
    |
FPixelStreamingOnIceDisconnection | OnIceDisconnection | When an ice connection is lost. |
   |
TObjectPtr< UPixelStreamingMediaTexture > | VideoSink | A sink for the video data received once this connection has finished negotiating. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UPixelStreamingPeerComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
FPixelStreamingSessionDescriptionWrapper | CreateAnswer
(
const FString& Offer |
Creates an answer to the given offer objet that was provided. |
   |
FPixelStreamingSessionDescriptionWrapper | CreateOffer () |
Creates an offer. |
   |
void | ReceiveAnswer
(
const FString& Offer |
Receives an answer from a streamer after we've sent an offer to receive. |
   |
void | ReceiveIceCandidate
(
const FPixelStreamingIceCandidateWrapper& Candidate |
Notify the peer connection of an ICE candidate sent by the singalling connection. |
   |
void | SetConfig
(
const FPixelStreamingRTCConfigWrapper& Config |
Sets the RTC Configuration for this Peer Connection. |