org.asteriskjava.live

Interface MeetMeRoom

public interface MeetMeRoom

Represents an Asterisk MeetMe room.

MeetMe rooms bridge multiple channels.

Since:

0.3

Author:

srt

Method Summary

Modifier and Type	Method and Description
String	getRoomNumber() Returns the number of this MeetMe room.
Collection<MeetMeUser>	getUsers() Returns a collection of all active users in this MeetMe room.
boolean	isEmpty() Checks whether there are users in this room or not.
void	lock() Locks this room so no addtional users can join.
void	unlock() Unlocks this room so additional users can join again.

Method Detail

getRoomNumber

String getRoomNumber()

Returns the number of this MeetMe room.

This property is immutable.

Returns:

the number of this MeetMe room.

getUsers

Collection<MeetMeUser> getUsers()

Returns a collection of all active users in this MeetMe room.

Returns:

a collection of all active users in this MeetMe room.

isEmpty

boolean isEmpty()

Checks whether there are users in this room or not.

Returns:

true if this room is empty, false if there are users in it.

Since:

1.0.0

lock

void lock()
   throws ManagerCommunicationException

Locks this room so no addtional users can join.

Throws:

ManagerCommunicationException - if the room can't be locked.

unlock

void unlock()
     throws ManagerCommunicationException

Unlocks this room so additional users can join again.

Throws:

ManagerCommunicationException - if the room can't be locked.