Skip navigation links

com.oracle.sft.api
Interface Conference

All Superinterfaces:

Communication, Interaction

public interface Conference

extends Interaction

Represents a Conference. It extends Interaction. More than two parties can be added to the conference.

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.sft.api.Communication

Communication.State

Method Summary

ConferenceInfo	createConferenceInfo() Create an instance of ConferenceInfo.
<P extends MediaParticipant> Collection<P>	getAllMediaParticipants(Class<P> type) Get a collection of particular type of Participants in the conference.
Collection<UserParticipant>	getAllParticipants() Return all the participants in the conference.
ConferenceInfo	getConferenceInfo() Returns object that represent the conference-info defined in RFC 4575.
Focus	getFocus() Return the focus of the conference.
void	muteParticipant(String name) Mute a UserParticipant that has joined the conference.
void	muteParticipant(UserParticipant up) Mute a UserParticipant that has joined the conference.
void	notify(ConferenceInfo conferenceInfo) Send a notification to interested subscribers for this conference state.
void	referParticipant(String name) Refer a UserParticipant to join the conference.
void	unmuteParticipant(String name) Unmute a UserParticipant that has joined the conference.
void	unmuteParticipant(UserParticipant up) Unmute a UserParticipant that has joined the conference.

Methods inherited from interface com.oracle.sft.api.Interaction

addParticipant, addParticipant, addParticipant, addParticipant, getParticipant, getParticipant, removeParticipant, removeParticipant, replaceParticipant, replaceParticipant

Methods inherited from interface com.oracle.sft.api.Communication

addAgent, end, getAgent, getAgents, getInitiator, getName, getState, removeAgent

Method Detail

getAllParticipants

Collection<UserParticipant> getAllParticipants()

Return all the participants in the conference.

Returns:

a Collection of UserParticipant objects.

getAllMediaParticipants

<P extends MediaParticipant> Collection<P> getAllMediaParticipants(Class<P> type)

Get a collection of particular type of Participants in the conference.

Type Parameters:

P - Type of the Participant.

Parameters:

type - Class of the Participant.

Returns:

An instance of Participant

getFocus

Focus getFocus()

Return the focus of the conference.

Returns:

An instance of Focus

referParticipant

void referParticipant(String name)

Refer a UserParticipant to join the conference. Executing this method will send a REFER request to that participant, then the participant can get the conference URI from the REFER request and join the conference by sending INVITE request to this URI. Following is an example code. Conference c = ....; c.referParticipantJoin("alice@example.com");

Parameters:

name - Name of the UserParticipant

muteParticipant

void muteParticipant(String name)

Mute a UserParticipant that has joined the conference.

Parameters:

name - the name of UserParticipant.

muteParticipant

void muteParticipant(UserParticipant up)

Mute a UserParticipant that has joined the conference.

Parameters:

up - the instance of UserParticipant.

unmuteParticipant

void unmuteParticipant(String name)

Unmute a UserParticipant that has joined the conference.

Parameters:

name - the name of UserParticipant.

unmuteParticipant

void unmuteParticipant(UserParticipant up)

Unmute a UserParticipant that has joined the conference.

Parameters:

up - the instance of UserParticipant.

getConferenceInfo

ConferenceInfo getConferenceInfo()

Returns object that represent the conference-info defined in RFC 4575.

Returns:

An instance of ConferenceInfo

createConferenceInfo

ConferenceInfo createConferenceInfo()

Create an instance of ConferenceInfo.

Returns:

an instance of ConferenceInfo

notify

void notify(ConferenceInfo conferenceInfo)

Send a notification to interested subscribers for this conference state. Notice that in most cases, the SFT Container will send the notification for event like participant joins or participant leaves. If application changed the ConferenceInfo, like conference identifiers and service URIs, application can trigger a notification by invoke this method.

Parameters:

conferenceInfo - The ConferenceInfo that will notify to subscriber.

Skip navigation links