|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MeetMeUser
Represents a user of a MeetMe room.
PropertyChangeEvents are fired for the following properties:
MeetMeRoom
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_MUTED
|
static java.lang.String |
PROPERTY_STATE
|
static java.lang.String |
PROPERTY_TALKING
|
Method Summary | |
---|---|
AsteriskChannel |
getChannel()
Returns the channel associated with this user. |
java.util.Date |
getDateJoined()
Returns the date this user joined the MeetMe room. |
java.util.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. |
java.lang.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, getServer, removePropertyChangeListener, removePropertyChangeListener |
Field Detail |
---|
static final java.lang.String PROPERTY_TALKING
static final java.lang.String PROPERTY_MUTED
static final java.lang.String PROPERTY_STATE
Method Detail |
---|
boolean isTalking()
Asterisk supports talker detection since version 1.2.
true
if this user is currently talking and
talker detection is supported, false
otherwise.boolean isMuted()
Supported since Asterisk version 1.4.
true
if this user is muted and
mute detection is supported, false
otherwise.java.util.Date getDateJoined()
This property is immutable.
java.util.Date getDateLeft()
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
.
null
if the user did not yet leave.MeetMeUserState getState()
Initially the user is in state MeetMeUserState.JOINED
.
MeetMeRoom getRoom()
This property is immutable.
java.lang.Integer getUserNumber()
Usually you won't need to access this property directly.
This property is immutable.
AsteriskChannel getChannel()
This property is immutable.
void mute() throws ManagerCommunicationException
ManagerCommunicationException
- if there is a problem talking to the Asterisk server.void unmute() throws ManagerCommunicationException
ManagerCommunicationException
- if there is a problem talking to the Asterisk server.void kick() throws ManagerCommunicationException
ManagerCommunicationException
- if there is a problem talking to the Asterisk server.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |