Navigation
API > API/Plugins > API/Plugins/PixelStreaming
The public interface of the Pixel Streaming module.
| Name | IPixelStreamingModule |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingModule.h |
| Include Path | #include "IPixelStreamingModule.h" |
Syntax
class IPixelStreamingModule : public IModuleInterface
Implements Interfaces
Classes
| Name | Remarks |
|---|---|
| FReadyEvent | Event fired when internal streamer is initialized and the methods on this module are ready for use. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddInputComponent
(
UPixelStreamingInput* InInputComponent |
Tell the input device about a new pixel streaming input component. | IPixelStreamingModule.h | |
rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > CreateExternalVideoSource() |
Allows the creation of Video Tracks that are fed the backbuffer | IPixelStreamingModule.h | |
TSharedPtr< IPixelStreamingStreamer > CreateStreamer
(
const FString& StreamerId |
Creates a new streamer. | IPixelStreamingModule.h | |
TUniquePtr< webrtc::VideoEncoderFactory > CreateVideoEncoderFactory() |
Create a webrtc::VideoEncoderFactory pointer. | IPixelStreamingModule.h | |
TSharedPtr< IPixelStreamingStreamer > DeleteStreamer
(
const FString& StreamerId |
Remove a streamer by an ID | IPixelStreamingModule.h | |
void DeleteStreamer
(
TSharedPtr< IPixelStreamingStreamer > ToBeDeleted |
Remove a streamer by its pointer | IPixelStreamingModule.h | |
TSharedPtr< IPixelStreamingStreamer > FindStreamer
(
const FString& StreamerId |
Find a streamer by an ID. | IPixelStreamingModule.h | |
void ForEachStreamer
(
const TFunction< void(TSharedPtr< IPixelStreamingStreamer >)>& Func |
A method for iterating through all of the streamers on the module. | IPixelStreamingModule.h | |
EPixelStreamingCodec GetCodec() |
Gets the currently selected encoder codec for all of Pixel Streaming. | IPixelStreamingModule.h | |
FString GetDefaultSignallingURL() |
Get the Default Signaling URL ("ws://127.0.0.1:8888") | IPixelStreamingModule.h | |
FString GetDefaultStreamerID() |
Get the Default Streamer ID | IPixelStreamingModule.h | |
const TArray< UPixelStreamingInput * > GetInputComponents() |
Get the input components currently attached to Pixel Streaming. | IPixelStreamingModule.h | |
| Returns a TArray containing the keys to the currently held streamers. | IPixelStreamingModule.h | ||
bool IsReady() |
Is the PixelStreaming module actually ready to use? Is the streamer created. | IPixelStreamingModule.h | |
FReadyEvent & OnReady () |
A getter for the OnReady event. | IPixelStreamingModule.h | |
void ReleaseExternalVideoSource
(
const webrtc::VideoTrackSourceInterface* InVideoSource |
Used to clean up sources no longer needed | IPixelStreamingModule.h | |
void RemoveInputComponent
(
UPixelStreamingInput* InInputComponent |
Tell the input device that a pixel streaming input component is no longer relevant. | IPixelStreamingModule.h | |
void SetCodec
(
EPixelStreamingCodec Codec |
Sets the encoder codec for the whole Pixel Streaming module. | IPixelStreamingModule.h | |
void SetExternalVideoSourceCoupleFramerate
(
bool bShouldCoupleFPS |
Control coupling the external video source framerate to the video input framerate | IPixelStreamingModule.h | |
void SetExternalVideoSourceFPS
(
uint32 InFPS |
Sets the target FPS for Externally Consumed video Tracks | IPixelStreamingModule.h | |
void SetExternalVideoSourceInput
(
TSharedPtr< FPixelStreamingVideoInput > InVideoInput |
Hook to set the input to the external video source. | IPixelStreamingModule.h | |
bool StartStreaming() |
Starts streaming on all streamers. | IPixelStreamingModule.h | |
void StopStreaming() |
Stops all streamers from streaming. | IPixelStreamingModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPixelStreamingModule & Get () |
Singleton-like access to this module's interface. | IPixelStreamingModule.h | |
static bool IsAvailable() |
Checks to see if this module is loaded. | IPixelStreamingModule.h |