com.herewhite.sdk.domain.WhiteDisplayerState Class Reference

Inheritance diagram for com.herewhite.sdk.domain.WhiteDisplayerState:

Public Member Functions
GlobalState	getGlobalState ()
RoomMember[]	getRoomMembers ()
SceneState	getSceneState ()
CameraState	getCameraState ()
Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String	toString ()
JSONObject	toJSON ()

Static Public Member Functions
static< T extends GlobalState > void	setCustomGlobalStateClass (Class< T > classOfT)

Detailed Description

The WhiteDisplayerState class, which is inherited by the Room instances.

Since

2.4.8

Member Function Documentation

setCustomGlobalStateClass()

static< T extends GlobalState > void com.herewhite.sdk.domain.WhiteDisplayerState.setCustomGlobalStateClass ( Class< T >  classOfT )

static

Sets the customized GlobalState class.

Since

2.4.8

A successful call of this method casts all GlobalState variables to the instances of the customized class.

Parameters

<T>	Type constraint. The customized GlobalState must extend the GlobalState class.
classOfT	The customized GlobalState class.

getGlobalState()

GlobalState com.herewhite.sdk.domain.WhiteDisplayerState.getGlobalState

(

)

Gets the global state of the room.

Returns

The global state of the room.

getRoomMembers()

RoomMember[] com.herewhite.sdk.domain.WhiteDisplayerState.getRoomMembers

(

)

Gets the list of members in the room.

Note

Only users in interactive mode (with read and write permissions) are room members; users in subscription mode (with read-only permission) are not included in the member list.

Returns

The member list of the room. See RoomMember.

getSceneState()

SceneState com.herewhite.sdk.domain.WhiteDisplayerState.getSceneState

(

)

Gets the state of the scenes under the current scene directory.

Returns

The state of the scenes under the current scene directory. See SceneState.

getCameraState()

CameraState com.herewhite.sdk.domain.WhiteDisplayerState.getCameraState

(

)

Gets the state of the view.

Returns

The state of the view. See CameraState.