com.twilio.video

Class Room

java.lang.Object

com.twilio.video.Room

public class Room
extends Object

A Room represents a media session with zero or more remote Participants. Media shared by any one RemoteParticipant is distributed equally to all other Participants.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Room.Listener Listener definition of room related events.
static class	Room.State Represents the current state of a Room.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnects from the room.
RemoteParticipant	getDominantSpeaker() Returns the dominant speaker of the Room.
LocalParticipant	getLocalParticipant() Returns the current local participant.
String	getMediaRegion() Returns the region where media is processed.
String	getName() Returns the name of the current room.
List<RemoteParticipant>	getRemoteParticipants() Returns all currently connected participants.
String	getSid() Returns the SID of the current room.
Room.State	getState() Returns the current room state.
void	getStats(StatsListener statsListener) Retrieve stats for all media tracks and notify StatsListener via calling thread.
boolean	isRecording() Returns whether any media in the Room is being recorded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

Returns the name of the current room. This method will return the SID if the room was created without a name.

getSid

public String getSid()

Returns the SID of the current room.

getMediaRegion

public String getMediaRegion()

Returns the region where media is processed. This property is set in Group Rooms by the time the Room reaches Room.State.CONNECTED. This method returns null under the following conditions:

• The Room has not reached the Room.State.CONNECTED state.
• The instance represents a peer-to-peer Room.

getState

public Room.State getState()

Returns the current room state.

getDominantSpeaker

public RemoteParticipant getDominantSpeaker()

Returns the dominant speaker of the Room.

To enable this feature, add an invocation of ConnectOptions.Builder.enableDominantSpeaker with true when building your ConnectOptions. This method returns null when one of the following conditions are true:

• The Room topology is P2P.
• The dominant speaker feature was not enabled via ConnectOptions.Builder.enableDominantSpeaker.
• There is currently no dominant speaker.

isRecording

public boolean isRecording()

Returns whether any media in the Room is being recorded.

getRemoteParticipants

public List<RemoteParticipant> getRemoteParticipants()

Returns all currently connected participants.

Returns:

list of participants.

getLocalParticipant

public LocalParticipant getLocalParticipant()

Returns the current local participant. If the room has not reached Room.State.CONNECTED then this method will return null.

getStats

public void getStats(StatsListener statsListener)

Retrieve stats for all media tracks and notify StatsListener via calling thread. In case where room is in Room.State.DISCONNECTED state, reports won't be delivered.

Parameters:

statsListener - listener that receives stats reports for all media tracks.

disconnect

public void disconnect()

Disconnects from the room.