IPixelStreamingModule

The public interface to this module

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

PixelStreaming

Header

/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingModule.h

Include

#include "IPixelStreamingModule.h"

Syntax

class IPixelStreamingModule : public IInputDeviceModule

Remarks

The public interface to this module

Functions

Name Description

Public function

void

 

AddPlayerConfig

(
    TSharedRef< class FJsonObject >& J...
)

Add any player config JSON to the given object which relates to configuring the input system for the pixel streaming on the browser.

Public function

TSharedPtr< ...

 

CreatePlayer

(
    IMediaEventSink& EventSink
)

Public function

void

 

FreezeFrame

(
    UTexture2D* Texture
)

Freeze Pixel Streaming.

Public function Static

IPixelStream...

 

Get()

Singleton-like access to this module's interface.

Public function

FInputDevice...

 

GetInputDevice()

Returns a reference to the input device.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function Const

bool

 

IsPlayerInitialized()

Public function

void

 

SendCommand

(
    const FString& Descriptor
)

Send a data command back to the browser where we are sending video.

Public function

void

 

SendResponse

(
    const FString& Descriptor
)

Send a data response back to the browser where we are sending video.

Public function

void

 

UnfreezeFrame()

Unfreeze Pixel Streaming.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss