org.asteriskjava.live

Interface MeetMeUser

All Superinterfaces:

LiveObject

public interface MeetMeUser
extends LiveObject

Represents a user of a MeetMe room.

PropertyChangeEvents are fired for the following properties:

• talking
• muted
• state

Since:

0.3

Author:

srt

See Also:

MeetMeRoom

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_MUTED
static String	PROPERTY_STATE
static String	PROPERTY_TALKING

Method Summary

Modifier and Type	Method and Description
AsteriskChannel	getChannel() Returns the channel associated with this user.
Date	getDateJoined() Returns the date this user joined the MeetMe room.
Date	getDateLeft() Returns the date this user left the MeetMe room.
MeetMeRoom	getRoom() Returns the MeetMe room this user joined.
MeetMeUserState	getState() Returns the lifecycle status of this MeetMeUser.
Integer	getUserNumber() Returns the user number assigned to this user in the room.
boolean	isMuted() Returns whether this user is muted or not.
boolean	isTalking() Returns whether this user is currently talking or not.
void	kick() Removes this user from the MeetMe room.
void	mute() Stops sending voice from this user to the MeetMe room.
void	unmute() (Re)starts sending voice from this user to the MeetMe room.

Methods inherited from interface org.asteriskjava.live.LiveObject

addPropertyChangeListener, addPropertyChangeListener, getLastUpdateMillis, getServer, removePropertyChangeListener, removePropertyChangeListener

Field Detail

PROPERTY_TALKING

static final String PROPERTY_TALKING

See Also:

Constant Field Values

PROPERTY_MUTED

static final String PROPERTY_MUTED

See Also:

Constant Field Values

PROPERTY_STATE

static final String PROPERTY_STATE

See Also:

Constant Field Values

Method Detail

isTalking

boolean isTalking()

Returns whether this user is currently talking or not.

Asterisk supports talker detection since version 1.2.

Returns:

true if this user is currently talking and talker detection is supported, false otherwise.

isMuted

boolean isMuted()

Returns whether this user is muted or not.

Supported since Asterisk version 1.4.

Returns:

true if this user is muted and mute detection is supported, false otherwise.

getDateJoined

Date getDateJoined()

Returns the date this user joined the MeetMe room.

This property is immutable.

Returns:

the date this user joined the MeetMe room.

getDateLeft

Date getDateLeft()

Returns the date this user left the MeetMe room.

This property is null as long as the user is in state MeetMeUserState.JOINED and set to date the user left when entering MeetMeUserState.LEFT.

Returns:

the date this user left the MeetMe room or null if the user did not yet leave.

getState

MeetMeUserState getState()

Returns the lifecycle status of this MeetMeUser.

Initially the user is in state MeetMeUserState.JOINED.

Returns:

the lifecycle status of this MeetMeUser.

getRoom

MeetMeRoom getRoom()

Returns the MeetMe room this user joined.

This property is immutable.

Returns:

the MeetMe room this user joined.

getUserNumber

Integer getUserNumber()

Returns the user number assigned to this user in the room.

Usually you won't need to access this property directly.

This property is immutable.

Returns:

the user number assigned to this user in the room.

getChannel

AsteriskChannel getChannel()

Returns the channel associated with this user.

This property is immutable.

Returns:

the channel associated with this user.

mute

void mute()
   throws ManagerCommunicationException

Stops sending voice from this user to the MeetMe room.

Throws:

ManagerCommunicationException - if there is a problem talking to the Asterisk server.

unmute

void unmute()
     throws ManagerCommunicationException

(Re)starts sending voice from this user to the MeetMe room.

Throws:

ManagerCommunicationException - if there is a problem talking to the Asterisk server.

kick

void kick()
   throws ManagerCommunicationException

Removes this user from the MeetMe room.

Throws:

ManagerCommunicationException - if there is a problem talking to the Asterisk server.