Class ScreenSharingSpaceComponent

Inheritance Relationships

Base Types

Class Documentation

class ScreenSharingSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IShadowCasterComponent, public csp::multiplayer::ITransformComponent, public csp::multiplayer::IVisibleComponent

Enables screen sharing within the space.

The screen sharing component facilitates the sharing of a user’s screen within a space. The component itself does not make assumptions about the mechanism by which the screen is shared. It provides properties to define a default image to be displayed when no users are sharing their screen, as well a UserId property to store the Id of the user currently sharing their screen.

Public Functions

ScreenSharingSpaceComponent(csp::common::LogSystem *LogSystem, SpaceEntity *Parent)

Constructs the screen sharing component, and associates it with the specified Parent space entity.

Parameters

Parent – The Space entity that owns this component.

const csp::common::String &GetUserId() const

Gets the ID of the user who is currently sharing their screen to this component.

Note

An empty string means that no user is currently sharing their screen to this component.

Returns

csp::common::String& : The ID of the user who is currently sharing their screen to this component.

void SetUserId(const csp::common::String &Value)

Sets the ID of the user who is sharing their screen to this component.

Parameters

Value – csp::common::String& : The ID of the user who is sharing their screen to this component. This must be set to an empty string when the user finishes sharing.

const csp::common::String &GetDefaultImageCollectionId() const

Gets the ID of the asset collection associated with the default image for this component.

Note

To retrieve this component’s default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.

Returns

csp::common::String& : The ID of the default image asset collection associated with this component.

void SetDefaultImageCollectionId(const csp::common::String &Value)

Sets the ID of the asset collection associated with the default image for this component.

Note

To retrieve this component’s default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.

Parameters

Value – csp::common::String& : The ID of the default image asset collection associated with this component.

const csp::common::String &GetDefaultImageAssetId() const

Gets the ID of the asset associated with the default image for this component.

Note

To retrieve this component’s default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.

Returns

csp::common::String& : The ID of the default image asset associated with this component.

void SetDefaultImageAssetId(const csp::common::String &Value)

Sets the ID of the asset associated with the default image for this component.

Note

To retrieve this component’s default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.

Parameters

Value – csp::common::String& : The ID of the default image asset associated with this component.

float GetAttenuationRadius() const

Gets the radius from this component origin within which the audio of this video can be heard by the user.

Note

Only when the user position is within this radius the audio of the video should be heard.

Returns

The radius within which the audio of the video can be heard by the user.

void SetAttenuationRadius(float Value)

Sets the radius from this component origin within which the audio of this video can be heard by the user.

Note

Only when the user position is within this radius the audio of the video should be heard.

Parameters

Value – The radius within which the audio of the video can be heard by the user.