T
- the provider extension class like for example
ProtocolProviderServiceSipImpl or
ProtocolProviderServiceJabberImplpublic interface OperationSetBasicTelephony<T extends ProtocolProviderService> extends OperationSet
Modifier and Type | Field and Description |
---|---|
static int |
HANGUP_REASON_BUSY_HERE
Reason code used to hangup peer, indicates busy here.
|
static int |
HANGUP_REASON_ENCRYPTION_REQUIRED
Reason code used to hangup peer if call was not encrypted.
|
static int |
HANGUP_REASON_NORMAL_CLEARING
Reason code used to hangup peer, indicates normal hangup.
|
static int |
HANGUP_REASON_TIMEOUT
Reason code used to hangup peer when we wait for some event
and it timeouted.
|
static java.lang.String |
MAX_AUDIO_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the maximum port number that we'd
like our Audio RTP managers to bind upon.
|
static java.lang.String |
MAX_DATA_CHANNEL_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the maximum port number that we'd
like our Data Channel RTP managers to bind upon.
|
static java.lang.String |
MAX_MEDIA_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the maximum port number that we'd
like our RTP managers to bind upon.
|
static java.lang.String |
MAX_VIDEO_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the maximum port number that we'd
like our Video RTP managers to bind upon.
|
static java.lang.String |
MIN_AUDIO_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the minimum port number that we'd
like our Audio RTP managers to bind upon.
|
static java.lang.String |
MIN_DATA_CHANNEL_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the minimum port number that we'd
like our Data Channel (e.g.
|
static java.lang.String |
MIN_MEDIA_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the minimum port number that we'd
like our RTP managers to bind upon.
|
static java.lang.String |
MIN_VIDEO_PORT_NUMBER_PROPERTY_NAME
The name of the property that contains the minimum port number that we'd
like our Video RTP managers to bind upon.
|
Modifier and Type | Method and Description |
---|---|
void |
addCallListener(CallListener listener)
Registers the specified CallListener with this provider so that it could
be notified when incoming calls are received.
|
void |
answerCallPeer(CallPeer peer)
Indicates a user request to answer an incoming call from the specified
CallPeer.
|
Call |
createCall(ConferenceDescription cd,
ChatRoom chatRoom)
Creates a new Call and sends an invite to the conference
described in cd.
|
Call |
createCall(Contact callee)
Creates a new Call and invites a specific CallPeer
to it given by her Contact.
|
Call |
createCall(Contact callee,
CallConference conference)
Creates a new Call and invites a specific CallPeer
to it given by her Contact.
|
Call |
createCall(java.lang.String uri)
Creates a new Call and invites a specific CallPeer to
it given by her String URI.
|
Call |
createCall(java.lang.String uri,
CallConference conference)
Creates a new Call and invites a specific CallPeer to
it given by her String URI.
|
org.jitsi.service.neomedia.recording.Recorder |
createRecorder(Call call)
Creates a new Recorder which is to record the specified
Call (into a file which is to be specified when starting the
returned Recorder).
|
java.util.Iterator<? extends Call> |
getActiveCalls()
Returns an iterator over all currently active calls.
|
T |
getProtocolProvider()
Returns the protocol provider that this operation set belongs to.
|
void |
hangupCallPeer(CallPeer peer)
Indicates a user request to end a call with the specified call
peer.
|
void |
hangupCallPeer(CallPeer peer,
int reasonCode,
java.lang.String reason)
Ends the call with the specified peer.
|
void |
putOffHold(CallPeer peer)
Resumes communication with a call peer previously put on hold.
|
void |
putOnHold(CallPeer peer)
Puts the specified CallPeer "on hold".
|
void |
removeCallListener(CallListener listener)
Removes the specified listener from the list of call listeners.
|
void |
setMute(Call call,
boolean mute)
Sets the mute state of the Call.
|
static final java.lang.String MAX_MEDIA_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MIN_MEDIA_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MIN_VIDEO_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MAX_VIDEO_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MIN_AUDIO_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MAX_AUDIO_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MIN_DATA_CHANNEL_PORT_NUMBER_PROPERTY_NAME
static final java.lang.String MAX_DATA_CHANNEL_PORT_NUMBER_PROPERTY_NAME
static final int HANGUP_REASON_NORMAL_CLEARING
static final int HANGUP_REASON_TIMEOUT
static final int HANGUP_REASON_ENCRYPTION_REQUIRED
static final int HANGUP_REASON_BUSY_HERE
void addCallListener(CallListener listener)
listener
- the listener to register with this provider.void removeCallListener(CallListener listener)
listener
- the listener to unregister.Call createCall(java.lang.String uri) throws OperationFailedException, java.text.ParseException
uri
- the address of the callee who we should invite to a new
CallOperationFailedException
- with the corresponding code if we fail
to create the calljava.text.ParseException
- if callee is not a valid SIP address
StringCall createCall(Contact callee) throws OperationFailedException
callee
- the address of the callee who we should invite to a new
callOperationFailedException
- with the corresponding code if we fail
to create the callCall createCall(java.lang.String uri, CallConference conference) throws OperationFailedException, java.text.ParseException
uri
- the address of the callee who we should invite to a new
Callconference
- the CallConference in which the newly-created
Call is to participateOperationFailedException
- with the corresponding code if we fail
to create the calljava.text.ParseException
- if callee is not a valid SIP address
StringCall createCall(Contact callee, CallConference conference) throws OperationFailedException
callee
- the address of the callee who we should invite to a new
callconference
- the CallConference in which the newly-created
Call is to participateOperationFailedException
- with the corresponding code if we fail
to create the callCall createCall(ConferenceDescription cd, ChatRoom chatRoom) throws OperationFailedException
cd
- the conference to send an invite tochatRoom
- the chat room associated with the call.OperationFailedException
void answerCallPeer(CallPeer peer) throws OperationFailedException
peer
- the call peer that we'd like to answer.OperationFailedException
- with the corresponding code if we
encounter an error while performing this operation.void putOnHold(CallPeer peer) throws OperationFailedException
peer
- the peer that we'd like to put on hold.OperationFailedException
- with the corresponding code if we
encounter an error while performing this operation.void putOffHold(CallPeer peer) throws OperationFailedException
peer
- the call peer to put on hold.OperationFailedException
- with the corresponding code if we
encounter an error while performing this operationvoid hangupCallPeer(CallPeer peer) throws OperationFailedException
peer
- the peer that we'd like to hang up on.OperationFailedException
- with the corresponding code if we
encounter an error while performing this operation.void hangupCallPeer(CallPeer peer, int reasonCode, java.lang.String reason) throws OperationFailedException
peer
- the peer that we'd like to hang up on.reasonCode
- indicates if the hangup is following to a call failure or
simply a disconnect indicate by the reason.reason
- the reason of the hangup. If the hangup is due to a call
failure, then this string could indicate the reason of the failureOperationFailedException
- if we fail to terminate the call.java.util.Iterator<? extends Call> getActiveCalls()
void setMute(Call call, boolean mute)
Muting audio streams sent from the call is implementation specific and one of the possible approaches to it is sending silence.
call
- the Call whos mute state is setmute
- true to mute the call streams being sent to
peers; otherwise, falseT getProtocolProvider()
org.jitsi.service.neomedia.recording.Recorder createRecorder(Call call) throws OperationFailedException
call
- the Call which is to be recorded by the returned
Recorder when the latter is startedOperationFailedException
- if anything goes wrong while creating
the new Recorder for the specified call
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.