blob: 1773d9ee5c0692fd883a25b4765417bee1c44735 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol;
import java.text.*;
import java.util.*;
import net.java.sip.communicator.service.neomedia.*;
import net.java.sip.communicator.service.protocol.event.*;
/**
* An Operation Set defining all basic telephony operations such as conducting
* simple calls and etc. Note that video is not considered as a part of a
* supplementary operation set and if included in the service should be available
* behind the basic telephony set.
*
* @param <T> the provider extension class like for example
* <tt>ProtocolProviderServiceSipImpl</tt> or
* <tt>ProtocolProviderServiceJabberImpl</tt>
*
* @author Emil Ivov
* @author Lubomir Marinov
*/
public interface OperationSetBasicTelephony<T extends ProtocolProviderService>
extends OperationSet
{
/**
* The name of the property that contains the minimum port number that we'd
* like our RTP managers to bind upon.
*/
public static final String MIN_MEDIA_PORT_NUMBER_PROPERTY_NAME
= "net.java.sip.communicator.service.protocol.MIN_MEDIA_PORT_NUMBER";
/**
* The name of the property that contains the maximum port number that we'd
* like our RTP managers to bind upon.
*/
public static final String MAX_MEDIA_PORT_NUMBER_PROPERTY_NAME
= "net.java.sip.communicator.service.protocol.MAX_MEDIA_PORT_NUMBER";
/**
* Registers the specified CallListener with this provider so that it could
* be notified when incoming calls are received. This method is called
* by the implementation of the PhoneUI service.
* @param listener the listener to register with this provider.
*
*/
public void addCallListener(CallListener listener);
/**
* Removes the specified listener from the list of call listeners.
* @param listener the listener to unregister.
*/
public void removeCallListener(CallListener listener);
/**
* Create a new call and invite the specified CallPeer to it.
*
* @param uri the address of the callee that we should invite to a new
* call.
* @return CallPeer the CallPeer that will represented by the
* specified uri. All following state change events will be delivered
* through that call peer. The Call that this peer is a member
* of could be retrieved from the CallParticipatn instance with the use
* of the corresponding method.
* @throws OperationFailedException with the corresponding code if we fail
* to create the call.
* @throws ParseException if <tt>callee</tt> is not a valid sip address
* string.
*/
public Call createCall(String uri)
throws OperationFailedException
, ParseException;
/**
* Create a new call and invite the specified CallPeer to it.
*
* @param callee the address of the callee that we should invite to a new
* call.
* @return CallPeer the CallPeer that will represented by the
* specified uri. All following state change events will be delivered
* through that call peer. The Call that this peer is a member
* of could be retrieved from the CallParticipatn instance with the use
* of the corresponding method.
* @throws OperationFailedException with the corresponding code if we fail
* to create the call.
*/
public Call createCall(Contact callee)
throws OperationFailedException;
/**
* Indicates a user request to answer an incoming call from the specified
* CallPeer.
* @param peer the call peer that we'd like to answer.
* @throws OperationFailedException with the corresponding code if we
* encounter an error while performing this operation.
*/
public void answerCallPeer(CallPeer peer)
throws OperationFailedException;
/**
* Puts the specified CallPeer "on hold". In other words incoming
* media flows are not played and outgoing media flows are either muted or
* stopped, without actually interrupting the session.
* @param peer the peer that we'd like to put on hold.
* @throws OperationFailedException with the corresponding code if we
* encounter an error while performing this operation.
*/
public void putOnHold(CallPeer peer)
throws OperationFailedException;
/**
* Resumes communication with a call peer previously put on hold. If
* the specified peer is not "On Hold" at the time putOffHold is
* called, the method has no effect.
*
* @param peer the call peer to put on hold.
* @throws OperationFailedException with the corresponding code if we
* encounter an error while performing this operation
*/
public void putOffHold(CallPeer peer)
throws OperationFailedException;
/**
* Indicates a user request to end a call with the specified call
* peer.
* @param peer the peer that we'd like to hang up on.
* @throws OperationFailedException with the corresponding code if we
* encounter an error while performing this operation.
*/
public void hangupCallPeer(CallPeer peer)
throws OperationFailedException;
/**
* Returns an iterator over all currently active calls.
* @return Iterator
*/
public Iterator<? extends Call> getActiveCalls();
/**
* Sets the mute state of the <tt>Call</tt>.
* <p>
* Muting audio streams sent from the call is implementation specific
* and one of the possible approaches to it is sending silence.
* </p>
*
* @param call the <tt>Call</tt> whos mute state is set
* @param mute <tt>true</tt> to mute the call streams being sent to
* <tt>peers</tt>; otherwise, <tt>false</tt>
*/
public void setMute(Call call, boolean mute);
/**
* Returns the protocol provider that this operation set belongs to.
*
* @return a reference to the <tt>ProtocolProviderService</tt> that created
* this operation set.
*/
public T getProtocolProvider();
/**
* Creates a new <tt>Recorder</tt> which is to record the specified
* <tt>Call</tt> (into a file which is to be specified when starting the
* returned <tt>Recorder</tt>).
*
* @param call the <tt>Call</tt> which is to be recorded by the returned
* <tt>Recorder</tt> when the latter is started
* @return a new <tt>Recorder</tt> which is to record the specified
* <tt>call</tt> (into a file which is to be specified when starting the
* returned <tt>Recorder</tt>)
* @throws OperationFailedException if anything goes wrong while creating
* the new <tt>Recorder</tt> for the specified <tt>call</tt>
*/
public Recorder createRecorder(Call call)
throws OperationFailedException;
}
|
