Skip navigation links

waggle.common.modules.voice
Interface XVoiceModule.Client

All Superinterfaces:

XAPIInterface, XAPIInterface.Client

Enclosing interface:

XVoiceModule

public static interface XVoiceModule.Client

extends XAPIInterface.Client

Client interface for the Voice Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	mute(XObjectID conversationID, XObjectID userID, String callID, Boolean muted) Notification that the user's mute state has changed in a Conversation's conference call.
void	offCall(XObjectID conversationID, XObjectID userID, String callID) Notification that a user is no longer on the Conversation's conference call.
void	onCall(XObjectID conversationID, XObjectID userID, String callID) Notification that a user is on the Conversation's conference call.
void	speaking(XObjectID conversationID, XObjectID userID, Boolean speaking) Notification that a user is speaking in a Conversation's conference call.
void	updateConference(XObjectID conversationID, XObjectID conferenceID, XUpdater updater) Notification that a conference has changed and what the change is.

Method Detail

onCall

void onCall(XObjectID conversationID,
            XObjectID userID,
            String callID)

Notification that a user is on the Conversation's conference call.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

callID - a String containing a unique id for the call

offCall

void offCall(XObjectID conversationID,
             XObjectID userID,
             String callID)

Notification that a user is no longer on the Conversation's conference call.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

callID - a String containing a unique id for the call

speaking

void speaking(XObjectID conversationID,
              XObjectID userID,
              Boolean speaking)

Notification that a user is speaking in a Conversation's conference call.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

speaking - a Boolean which is true if speaking

mute

void mute(XObjectID conversationID,
          XObjectID userID,
          String callID,
          Boolean muted)

Notification that the user's mute state has changed in a Conversation's conference call.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

callID - a String containing a unique id for the call

muted - a Boolean which is true if muted

updateConference

void updateConference(XObjectID conversationID,
                      XObjectID conferenceID,
                      XUpdater updater)

Notification that a conference has changed and what the change is.

Parameters:

conversationID - a XObjectID value

conferenceID - a XObjectID value

updater - a XUpdater containing the updates.

Skip navigation links