1. Epic GamesDeveloper
  3. IPixelStreamingModule

IPixelStreamingModule

The public interface of the Pixel Streaming module.

API > API/Plugins > API/Plugins/PixelStreaming

Inheritance Hierarchy

References

   
Module PixelStreaming
Header /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingModule.h
Include #include "IPixelStreamingModule.h"

Syntax

class IPixelStreamingModule : public IModuleInterface

Remarks

The public interface of the Pixel Streaming module.

Functions

  Type Name Description
Public function void

AddInputComponent ( UPixelStreamingInput* InInputComponent
)

 Tell the input device about a new pixel streaming input component.
Public function rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > Allows the creation of Video Tracks that are fed the backbuffer
Public function TSharedPtr< IPixelStreamingStreamer >

CreateStreamer ( const FString& StreamerId
)

 Creates a new streamer.
Public function TUniquePtr< webrtc::VideoEncoderFactory > Create a webrtc::VideoEncoderFactory pointer.
Public function TSharedPtr< IPixelStreamingStreamer >

DeleteStreamer ( const FString& StreamerId
)

 Remove a streamer by an ID
Public function void Remove a streamer by its pointer
Public function TSharedPtr< IPixelStreamingStreamer >

FindStreamer ( const FString& StreamerId
)

 Find a streamer by an ID.
Public function void A method for iterating through all of the streamers on the module.
Public function Static IPixelStreamingModule &

Get ()

 Singleton-like access to this module's interface.
Public function Const EPixelStreamingCodec Gets the currently selected encoder codec for all of Pixel Streaming.
Public function FString Get the Default Signaling URL ("ws://127.0.0.1:8888")
Public function FString Get the Default Streamer ID
Public function const TArray< UPixelStreamingInput * > Get the input components currently attached to Pixel Streaming.
Public function TArray< FString > Returns a TArray containing the keys to the currently held streamers.
Public function Static bool Checks to see if this module is loaded.
Public function bool

IsReady ()

 Is the PixelStreaming module actually ready to use? Is the streamer created.
Public function FReadyEvent &

OnReady ()

 A getter for the OnReady event.
Public function void

ReleaseExternalVideoSource ( const webrtc::VideoTrackSourceInterface* InVideoSource
)

 Used to clean up sources no longer needed
Public function void Tell the input device that a pixel streaming input component is no longer relevant.
Public function void Sets the encoder codec for the whole Pixel Streaming module.
Public function void

SetExternalVideoSourceCoupleFramerate ( bool bShouldCoupleFPS
)

 Control coupling the external video source framerate to the video input framerate
Public function void

SetExternalVideoSourceFPS ( uint32 InFPS
)

 Sets the target FPS for Externally Consumed video Tracks
Public function void Hook to set the input to the external video source.
Public function bool Starts streaming on all streamers.
Public function void Stops all streamers from streaming.

Classes

  Type Name Description
Public class FReadyEvent Event fired when internal streamer is initialized and the methods on this module are ready for use.  

Deprecated Functions

  Type Name Description
Public function TFunction< void(FMemoryReader)>

FindMessageHandler ( const FString& MessageType
)

 FindMessageHandler(...) has been moved from the PixelStreaming module to IPixelStreamingInputHandler. This object can be obtained from an (IPixelStreamingStreamer)->GetInputHandler()
Public function const FPixelStreamingInputProtocol GetProtocol() is deprecated. Simply access the required direction with FPixelStreamingInputProtocol::ToStreamerProcol or FPixelStreamingInputProtocol::FromStreamerProcol
Public function TSharedPtr< IPixelStreamingStreamer >

GetStreamer ( const FString& StreamerId
)

 GetStreamer() is deprecated. Please use FindStreamer instead.
Public function void

RegisterMessage ( EPixelStreamingMessageDirection MessageDirection,
const FString& MessageType,
FPixelStreamingInputMessage Message,
const TFunction< void(FMemoryReader)>& Handler
)

 RegisterMessage(...) is no longer needed. Just add your message to the protocol using FPixelStreamingInputProtocol::Direction.Add(XXX);, and then add the handler to the Streamer's input handler

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page