UPixelStreamingSettings

Config loaded/saved to an .ini file.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

PixelStreaming

Header

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

Include

#include "PixelStreamingSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=PixelStreaming, defaultconfig, Meta=(DisplayName="PixelStreaming"))
class UPixelStreamingSettings : public UDeveloperSettings

Remarks

Config loaded/saved to an .ini file.

Variables

Name Description

Public variable UProperty Category, EditAnywhere Config

bool

 

bPixelStreamerMouseAlwaysAttached

Pixel Streaming may be running on a machine which has no physical mouse attached, and yet the browser is sending mouse positions.

Public variable UProperty Category, EditAnywhere Config

FSoftClassPath

 

PixelStreamerDefaultCursorClassName

Pixel streaming always requires various software cursors so they will be visible in the video stream sent to the browser to allow the user to click and interact with UI elements.

Public variable UProperty Category, EditAnywhere Config

FSoftClassPath

 

PixelStreamerHiddenCursorClassName

Pixel Streaming can have a server-side cursor (where the cursor itself is shown as part of the video), or a client-side cursor (where the cursor is shown by the browser).

Public variable UProperty Category, EditAnywhere Config

FSoftClassPath

 

PixelStreamerTextEditBeamCursorClassName

Constructors

Name Description

Public function

UPixelStreamingSettings

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UDeveloperSettings

Name Description

Public function Virtual Const

FName

 

GetCategoryName()

Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

Public function Virtual Const

FText

 

GetSectionText()

Gets the section text, uses the classes DisplayName by default.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

UObject interface

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