net.java.sip.communicator.service.protocol
Interface ConferenceMember

All Known Implementing Classes:

AbstractConferenceMember, ConferenceMemberGibberishImpl, ConferenceMemberJabberImpl, ConferenceMemberSipImpl

public interface ConferenceMember

Represents a member and its details in a telephony conference managed by a CallPeer in its role as a conference focus.

Author:

Lubomir Marinov

Field Summary

static String	DISPLAY_NAME_PROPERTY_NAME The name of the property of ConferenceMember which specifies the user-friendly display name of the respective ConferenceMember in the conference.
static String	STATE_PROPERTY_NAME The name of the property of ConferenceMember which specifies the state of the device and signaling session of the respective ConferenceMember in the conference.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds a specific PropertyChangeListener to the list of listeners interested in and notified about changes in the values of the properties of this ConferenceMember such as #DISPLAY_NAME_PROPERTY_NAME and #STATE_PROPERTY_NAME.
String	getAddress() Gets the SIP address of this ConferenceMember as specified by the conference-info XML received from its conferenceFocusCallPeer.
CallPeer	getConferenceFocusCallPeer() Gets the CallPeer which is the conference focus of this ConferenceMember.
String	getDisplayName() Gets the user-friendly display name of this ConferenceMember in the conference.
long	getSSRC() Returns the SSRC value associated with this participant or null if the value is not currently known.;
ConferenceMemberState	getState() Gets the state of the device and signaling session of this ConferenceMember in the conference in the form of a ConferenceMemberState value.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a specific PropertyChangeListener from the list of listeners interested in and notified about changes in the values of the properties of this ConferenceMember such as #DISPLAY_NAME_PROPERTY_NAME and #STATE_PROPERTY_NAME.

Field Detail

DISPLAY_NAME_PROPERTY_NAME

static final String DISPLAY_NAME_PROPERTY_NAME

The name of the property of ConferenceMember which specifies the user-friendly display name of the respective ConferenceMember in the conference.

See Also:

Constant Field Values

STATE_PROPERTY_NAME

static final String STATE_PROPERTY_NAME

The name of the property of ConferenceMember which specifies the state of the device and signaling session of the respective ConferenceMember in the conference.

See Also:

Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Adds a specific PropertyChangeListener to the list of listeners interested in and notified about changes in the values of the properties of this ConferenceMember such as #DISPLAY_NAME_PROPERTY_NAME and #STATE_PROPERTY_NAME.

Parameters:

listener - a PropertyChangeListener to be notified about changes in the values of the properties of this ConferenceMember. If the specified listener is already in the list of interested listeners (i.e. it has been previously added), it is not added again.

getAddress

String getAddress()

Gets the SIP address of this ConferenceMember as specified by the conference-info XML received from its conferenceFocusCallPeer.

Returns:

the SIP address of this ConferenceMember as specified by the conference-info XML received from its conferenceFocusCallPeer

getDisplayName

String getDisplayName()

Gets the user-friendly display name of this ConferenceMember in the conference.

Returns:

the user-friendly display name of this ConferenceMember in the conference

getConferenceFocusCallPeer

CallPeer getConferenceFocusCallPeer()

Gets the CallPeer which is the conference focus of this ConferenceMember.

Returns:

the CallPeer which is the conference focus of this ConferenceMember

getState

ConferenceMemberState getState()

Gets the state of the device and signaling session of this ConferenceMember in the conference in the form of a ConferenceMemberState value.

Returns:

a ConferenceMemberState value which represents the state of the device and signaling session of this ConferenceMember in the conference

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Removes a specific PropertyChangeListener from the list of listeners interested in and notified about changes in the values of the properties of this ConferenceMember such as #DISPLAY_NAME_PROPERTY_NAME and #STATE_PROPERTY_NAME.

Parameters:

listener - a PropertyChangeListener to no longer be notified about changes in the values of the properties of this ConferenceMember

getSSRC

long getSSRC()

Returns the SSRC value associated with this participant or null if the value is not currently known.;

Returns:

the ssrc associated with the RTP stream that this participant is transmitting or null if this value is not currently known.