public interface CallPeer
For SIP calls for example, it would be necessary to create a CallPeerSipImpl class that would provide sip specific implementations of various methods (getAddress() for example would return the peer's sip URI).
Modifier and Type | Field and Description |
---|---|
static long |
CALL_DURATION_START_TIME_UNKNOWN
The constant indicating that a CallPeer has not yet
transitioned into a state marking the beginning of a participation in a
Call or that such a transition may have happened but the
time of its occurrence is unknown.
|
static java.lang.String |
MUTE_PROPERTY_NAME
The mute property name.
|
Modifier and Type | Method and Description |
---|---|
void |
addCallPeerConferenceListener(CallPeerConferenceListener listener)
Adds a specific CallPeerConferenceListener to the
list of listeners interested in and notified about changes in
conference-related information such as this peer acting or not
acting as a conference focus and conference membership details.
|
void |
addCallPeerListener(CallPeerListener listener)
Allows the user interface to register a listener interested in changes
|
void |
addCallPeerSecurityListener(CallPeerSecurityListener listener)
Allows the user interface to register a listener interested in security
status changes.
|
void |
addConferenceMembersSoundLevelListener(ConferenceMembersSoundLevelListener listener)
Adds a specific SoundLevelListener to the list
of listeners interested in and notified about changes in conference
members sound level.
|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Allows the user interface to register a listener interested in property
changes.
|
void |
addStreamSoundLevelListener(SoundLevelListener listener)
Adds a specific SoundLevelListener to the list of
listeners interested in and notified about changes in stream sound level
related information.
|
java.lang.String |
getAddress()
Returns a String locator for that peer.
|
java.lang.String |
getAlternativeIMPPAddress()
Returns an alternative IMPP address corresponding to this
CallPeer.
|
Call |
getCall()
Returns a reference to the call that this peer belongs to.
|
long |
getCallDurationStartTime()
Gets the time at which this CallPeer transitioned
into a state (likely
CallPeerState.CONNECTED ) marking the
start of the duration of the participation in a Call. |
java.net.URL |
getCallInfoURL()
Returns a URL pointing to a location with call control information or
null if such an URL is not available for the current call peer.
|
int |
getConferenceMemberCount()
Gets the number of ConferenceMembers currently known to this
peer if it is acting as a conference focus.
|
java.util.List<ConferenceMember> |
getConferenceMembers()
Gets the ConferenceMembers currently known to this
peer if it is acting as a conference focus.
|
Contact |
getContact()
Returns the contact corresponding to this peer or null if no
particular contact has been associated.
|
CallPeerSecurityStatusEvent |
getCurrentSecuritySettings()
Returns the currently used security settings of this CallPeer.
|
java.lang.String |
getDisplayName()
Returns a human readable name representing this peer.
|
byte[] |
getImage()
The method returns an image representation of the call peer (e.g.
|
java.lang.String |
getPeerID()
Returns a unique identifier representing this peer.
|
ProtocolProviderService |
getProtocolProvider()
Returns the protocol provider that this peer belongs to.
|
CallPeerState |
getState()
Returns an object representing the current state of that peer.
|
java.lang.String |
getURI()
Returns full URI of the address.
|
boolean |
isConferenceFocus()
Determines whether this peer is acting as a conference focus and
thus may provide information about ConferenceMember such as
getConferenceMembers() and getConferenceMemberCount() . |
boolean |
isMute()
Determines whether the audio stream (if any) being sent to this
peer is mute.
|
void |
removeCallPeerConferenceListener(CallPeerConferenceListener listener)
Removes a specific CallPeerConferenceListener from
the list of listeners interested in and notified about changes in
conference-related information such as this peer acting or not
acting as a conference focus and conference membership details.
|
void |
removeCallPeerListener(CallPeerListener listener)
Unregisters the specified listener.
|
void |
removeCallPeerSecurityListener(CallPeerSecurityListener listener)
Unregisters the specified listener.
|
void |
removeConferenceMembersSoundLevelListener(ConferenceMembersSoundLevelListener listener)
Removes a specific SoundLevelListener of the
list of listeners interested in and notified about changes in conference
members sound level.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Unregisters the specified property change listener.
|
void |
removeStreamSoundLevelListener(SoundLevelListener listener)
Removes a specific SoundLevelListener of the list of
listeners interested in and notified about changes in stream sound level
related information.
|
java.lang.String |
toString()
Returns a string representation of the peer in the form of
Display Name <address>;status=CallPeerStatus |
static final long CALL_DURATION_START_TIME_UNKNOWN
static final java.lang.String MUTE_PROPERTY_NAME
void addCallPeerConferenceListener(CallPeerConferenceListener listener)
listener
- a CallPeerConferenceListener to be
notified about changes in conference-related information. If
the specified listener is already in the list of interested
listeners (i.e. it has been previously added), it is not added
again.void addCallPeerListener(CallPeerListener listener)
listener
- a listener instance to register with this peer.void addCallPeerSecurityListener(CallPeerSecurityListener listener)
listener
- a listener instance to register with this peervoid addConferenceMembersSoundLevelListener(ConferenceMembersSoundLevelListener listener)
listener
- the SoundLevelListener to addvoid addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- a property change listener instance to register with this
peer.void addStreamSoundLevelListener(SoundLevelListener listener)
listener
- the SoundLevelListener to addjava.lang.String getAddress()
Call getCall()
long getCallDurationStartTime()
CallPeerState.CONNECTED
) marking the
start of the duration of the participation in a Call.CALL_DURATION_START_TIME_UNKNOWN
if such a transition
has not been performedjava.net.URL getCallInfoURL()
int getConferenceMemberCount()
java.util.List<ConferenceMember> getConferenceMembers()
Contact getContact()
CallPeerSecurityStatusEvent getCurrentSecuritySettings()
java.lang.String getDisplayName()
java.lang.String getAlternativeIMPPAddress()
byte[] getImage()
java.lang.String getPeerID()
ProtocolProviderService getProtocolProvider()
CallPeerState getState()
java.lang.String getURI()
boolean isConferenceFocus()
getConferenceMembers()
and getConferenceMemberCount()
.boolean isMute()
void removeCallPeerConferenceListener(CallPeerConferenceListener listener)
listener
- a CallPeerConferenceListener to no longer
be notified about changes in conference-related informationvoid removeCallPeerListener(CallPeerListener listener)
listener
- the listener to unregister.void removeCallPeerSecurityListener(CallPeerSecurityListener listener)
listener
- the listener to unregistervoid removeConferenceMembersSoundLevelListener(ConferenceMembersSoundLevelListener listener)
listener
- the SoundLevelListener to
removevoid removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- the property change listener to unregister.void removeStreamSoundLevelListener(SoundLevelListener listener)
listener
- the SoundLevelListener to removejava.lang.String toString()
toString
in class java.lang.Object
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.