Agora Interactive Whiteboard Java API Reference
Public Member Functions | List of all members
com.herewhite.sdk.domain.BroadcastState Class Reference
Inheritance diagram for com.herewhite.sdk.domain.BroadcastState:
com.herewhite.sdk.domain.WhiteObject

Public Member Functions

ViewMode getMode ()
 
Long getBroadcasterId ()
 
RoomMember getBroadcasterInformation ()
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

The view state of the local user, as well as the user information of the host (if any) in the room.

When the local user is in the Follower view mode, you can call getBroadcasterId and getBroadcasterInformation to get the information of the host in the room.

Member Function Documentation

◆ getMode()

ViewMode com.herewhite.sdk.domain.BroadcastState.getMode ( )

Gets the view mode of the user.

Returns
The view mode of the user.

◆ getBroadcasterId()

Long com.herewhite.sdk.domain.BroadcastState.getBroadcasterId ( )

Gets the user ID of the host.

For the SDK earlier than v2.4.8, this method call returns 0 by mistake when there is no host in the room. v2.4.8 fixed this issue. As of v2.4.8, this method call returns null when there is no host in the room.

Returns
The user ID of the host.

◆ getBroadcasterInformation()

RoomMember com.herewhite.sdk.domain.BroadcastState.getBroadcasterInformation ( )

Gets the user information of the host.

Returns
The user information of the host. See RoomMember.