3 Copyright (C) 2010 Belledonne Communications, Grenoble, France
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 package org.linphone.core;
22 import java.util.List;
23 import java.util.Vector;
26 * Linphone core main object created by method {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object)}.
30 public interface LinphoneCore {
32 * linphone core states
34 static public class GlobalState {
35 @SuppressWarnings("unchecked")
36 static private Vector values = new Vector();
40 static public GlobalState GlobalOff = new GlobalState(0,"GlobalOff");
44 static public GlobalState GlobalStartup = new GlobalState(1,"GlobalStartup");
48 static public GlobalState GlobalOn = new GlobalState(2,"GlobalOn");
52 static public GlobalState GlobalShutdown = new GlobalState(3,"GlobalShutdown");
54 private final int mValue;
55 private final String mStringValue;
57 @SuppressWarnings("unchecked")
58 private GlobalState(int value,String stringValue) {
60 values.addElement(this);
61 mStringValue=stringValue;
63 public static GlobalState fromInt(int value) {
65 for (int i=0; i<values.size();i++) {
66 GlobalState state = (GlobalState) values.elementAt(i);
67 if (state.mValue == value) return state;
69 throw new RuntimeException("state not found ["+value+"]");
71 public String toString() {
76 * Describes proxy registration states.
79 static public class RegistrationState {
80 @SuppressWarnings("unchecked")
81 private static Vector values = new Vector();
85 public static RegistrationState RegistrationNone = new RegistrationState(0,"RegistrationNone");
89 public static RegistrationState RegistrationProgress = new RegistrationState(1,"RegistrationProgress");
93 public static RegistrationState RegistrationOk = new RegistrationState(2,"RegistrationOk");
97 public static RegistrationState RegistrationCleared = new RegistrationState(3,"RegistrationCleared");
101 public static RegistrationState RegistrationFailed = new RegistrationState(4,"RegistrationFailed");
102 private final int mValue;
103 private final String mStringValue;
105 @SuppressWarnings("unchecked")
106 private RegistrationState(int value,String stringValue) {
108 values.addElement(this);
109 mStringValue=stringValue;
111 public static RegistrationState fromInt(int value) {
113 for (int i=0; i<values.size();i++) {
114 RegistrationState state = (RegistrationState) values.elementAt(i);
115 if (state.mValue == value) return state;
117 throw new RuntimeException("state not found ["+value+"]");
119 public String toString() {
124 * Describes firewall policy.
127 static public class FirewallPolicy {
128 @SuppressWarnings("unchecked")
129 static private Vector values = new Vector();
131 * No firewall is assumed.
133 static public FirewallPolicy NoFirewall = new FirewallPolicy(0,"NoFirewall");
135 * Use NAT address (discouraged)
137 static public FirewallPolicy UseNatAddress = new FirewallPolicy(1,"UseNatAddress");
139 * Use stun server to discover RTP addresses and ports.
141 static public FirewallPolicy UseStun = new FirewallPolicy(2,"UseStun");
143 private final int mValue;
144 private final String mStringValue;
146 @SuppressWarnings("unchecked")
147 private FirewallPolicy(int value,String stringValue) {
149 values.addElement(this);
150 mStringValue=stringValue;
152 public static FirewallPolicy fromInt(int value) {
154 for (int i=0; i<values.size();i++) {
155 FirewallPolicy state = (FirewallPolicy) values.elementAt(i);
156 if (state.mValue == value) return state;
158 throw new RuntimeException("state not found ["+value+"]");
160 public String toString() {
169 * Signaling transports ports.
171 static public class Transports {
176 public Transports() {};
177 public Transports(Transports t) {
184 * EC Calibrator Status
186 static public class EcCalibratorStatus {
187 @SuppressWarnings("unchecked")
188 static private Vector values = new Vector();
190 * Calibration in progress
192 static public EcCalibratorStatus InProgress = new EcCalibratorStatus(0,"InProgress");
196 static public EcCalibratorStatus Done = new EcCalibratorStatus(1,"Done");
198 * Calibration in progress
200 static public EcCalibratorStatus Failed = new EcCalibratorStatus(2,"Failed");
202 private final int mValue;
203 private final String mStringValue;
205 @SuppressWarnings("unchecked")
206 private EcCalibratorStatus(int value,String stringValue) {
208 values.addElement(this);
209 mStringValue=stringValue;
211 public static EcCalibratorStatus fromInt(int value) {
213 for (int i=0; i<values.size();i++) {
214 EcCalibratorStatus status = (EcCalibratorStatus) values.elementAt(i);
215 if (status.mValue == value) return status;
217 throw new RuntimeException("status not found ["+value+"]");
219 public String toString() {
227 * clear all added proxy configs
229 public void clearProxyConfigs();
231 * Add a proxy configuration. This will start registration on the proxy, if registration is enabled.
233 * @throws LinphoneCoreException
235 public void addProxyConfig(LinphoneProxyConfig proxyCfg) throws LinphoneCoreException;
237 * Sets the default proxy.
239 * This default proxy must be part of the list of already entered {@link LinphoneProxyConfig}.
240 * Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls.
243 public void setDefaultProxyConfig(LinphoneProxyConfig proxyCfg);
246 * get he default proxy configuration, that is the one used to determine the current identity.
247 * @return null if no default proxy config
249 public LinphoneProxyConfig getDefaultProxyConfig() ;
252 * clear all the added auth info
254 void clearAuthInfos();
256 * Adds authentication information to the LinphoneCore.
257 * <br>This information will be used during all SIP transacations that require authentication.
260 void addAuthInfo(LinphoneAuthInfo info);
263 * Build an address according to the current proxy config. In case destination is not a sip address, the default proxy domain is automatically appended
266 * @throws If no LinphoneAddress can be built from destination
268 public LinphoneAddress interpretUrl(String destination) throws LinphoneCoreException;
271 * Starts a call given a destination. Internally calls {@link #interpretUrl(String)} then {@link #invite(LinphoneAddress)}.
274 public LinphoneCall invite(String destination)throws LinphoneCoreException;
276 * Initiates an outgoing call given a destination LinphoneAddress
277 *<br>The LinphoneAddress can be constructed directly using linphone_address_new(), or created by linphone_core_interpret_url(). The application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application.
278 * @param to the destination of the call (sip address).
279 * @return LinphoneCall
280 * @throws LinphoneCoreException
282 public LinphoneCall invite(LinphoneAddress to)throws LinphoneCoreException;
285 * @param aCall to be terminated
287 public void terminateCall(LinphoneCall aCall);
289 * Returns The LinphoneCall the current call if one is in call
292 public LinphoneCall getCurrentCall();
295 * get current call remote address in case of in/out call
296 * @return null if no call engaged yet
298 public LinphoneAddress getRemoteAddress();
301 * @return TRUE if there is a call running or pending.
303 public boolean isIncall();
306 * @return Returns true if in incoming call is pending, ie waiting for being answered or declined.
308 public boolean isInComingInvitePending();
310 * Main loop function. It is crucial that your application call it periodically.
312 * #iterate() performs various backgrounds tasks:
313 * <li>receiving of SIP messages
314 * <li> handles timers and timeout
315 * <li> performs registration to proxies
316 * <li> authentication retries The application MUST call this function from periodically, in its main loop.
317 * <br> Be careful that this function must be call from the same thread as other liblinphone methods. In not the case make sure all liblinphone calls are serialized with a mutex.
320 public void iterate();
322 * Accept an incoming call.
324 * Basically the application is notified of incoming calls within the
325 * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener.
326 * The application can later respond positively to the call using
328 * @throws LinphoneCoreException
330 public void acceptCall(LinphoneCall aCall) throws LinphoneCoreException;
334 * @return a list of LinphoneCallLog
336 @SuppressWarnings("unchecked")
337 public List getCallLogs();
340 * This method is called by the application to notify the Linphone core library when network is reachable.
341 * Calling this method with true trigger Linphone to initiate a registration process for all proxy
342 * configuration with parameter register set to enable.
343 * This method disable the automatic registration mode. It means you must call this method after each network state changes
344 * @param network state
347 public void setNetworkReachable(boolean isReachable);
350 * @return if false, there is no network connection.
352 public boolean isNetworkReachable();
354 * destroy linphone core and free all underlying resources
356 public void destroy();
358 * Allow to control play level before entering sound card:
361 public void setPlaybackGain(float gain);
363 * get play level before entering sound card:
364 * @return level in db
366 public float getPlaybackGain();
369 * @param level [0..100]
371 public void setPlayLevel(int level);
373 * get playback level [0..100];
374 * -1 if not cannot be determined
377 public int getPlayLevel();
379 * Mutes or unmutes the local microphone.
382 void muteMic(boolean isMuted);
385 * @return true is mic is muted
387 boolean isMicMuted();
390 * Initiate a dtmf signal if in call
393 void sendDtmf(char number);
395 * Initiate a dtmf signal to the speaker if not in call.
396 * Sending of the DTMF is done in another function.
398 * @param duration in ms , -1 for unlimited
400 void playDtmf(char number,int duration);
407 * remove all call logs
409 void clearCallLogs();
411 * get payload type from mime type an clock rate
413 * return null if not found
415 PayloadType findPayloadType(String mime,int clockRate);
417 * not implemented yet
420 * @throws LinphoneCoreException
422 void enablePayloadType(PayloadType pt, boolean enable) throws LinphoneCoreException;
424 * Enables or disable echo cancellation.
427 void enableEchoCancellation(boolean enable);
430 * @return true if echo cancellation is enabled.
432 boolean isEchoCancellationEnabled();
434 * @param transports used for signaling (TCP, UDP and TLS)
436 void setSignalingTransportPorts(Transports transports);
438 * @return transports used for signaling (TCP, UDP, TLS)
440 Transports getSignalingTransportPorts();
445 void enableSpeaker(boolean value);
450 boolean isSpeakerEnabled();
452 * add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
453 * @param lf LinphoenFriend to add
454 * @throws LinphoneCoreException
456 void addFriend(LinphoneFriend lf) throws LinphoneCoreException;
459 * Set my presence status
460 * @param minute_away how long in away
461 * @param status sip uri used to redirect call in state LinphoneStatusMoved
463 void setPresenceInfo(int minute_away,String alternative_contact, OnlineStatus status);
465 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
466 * @param to destination address for messages
468 * @return {@link LinphoneChatRoom} where messaging can take place.
470 LinphoneChatRoom createChatRoom(String to);
472 void setVideoWindow(Object w);
473 void setPreviewWindow(Object w);
475 * Enables video globally.
478 * This function does not have any effect during calls. It just indicates #LinphoneCore to
479 * initiate future calls with video or not. The two boolean parameters indicate in which
480 * direction video is enabled. Setting both to false disables video entirely.
482 * @param vcap_enabled indicates whether video capture is enabled
483 * @param display_enabled indicates whether video display should be shown
486 void enableVideo(boolean vcap_enabled, boolean display_enabled);
488 * Returns TRUE if video is enabled, FALSE otherwise.
491 boolean isVideoEnabled();
494 * Specify a STUN server to help firewall traversal.
495 * @param stun_server Stun server address and port, such as stun.linphone.org or stun.linphone.org:3478
497 void setStunServer(String stun_server);
499 * @return stun server address if previously set.
501 String getStunServer();
504 * Sets policy regarding workarounding NATs
505 * @param pol one of the FirewallPolicy members.
507 void setFirewallPolicy(FirewallPolicy pol);
509 * @return previously set firewall policy.
511 FirewallPolicy getFirewallPolicy();
513 LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException ;
515 int updateCall(LinphoneCall call, LinphoneCallParams params);
517 LinphoneCallParams createDefaultCallParameters();
520 * Sets the path to a wav file used for ringing.
522 * @param path The file must be a wav 16bit linear. Local ring is disabled if null
524 void setRing(String path);
526 * gets the path to a wav file used for ringing.
528 * @param null if not set
533 * Sets file or folder containing trusted root CAs
535 * @param path path to file with multiple PEM certif or to folder with multiple PEM files
537 void setRootCA(String path);
539 void setUploadBandwidth(int bw);
541 void setDownloadBandwidth(int bw);
544 * Sets audio packetization interval suggested for remote end.
545 * @param ptime packetization interval in milliseconds
547 void setDownloadPtime(int ptime);
550 * Sets audio packetization interval sent to remote end.
551 * @param ptime packetization interval in milliseconds
553 void setUploadPtime(int ptime);
555 void setPreferredVideoSize(VideoSize vSize);
557 VideoSize getPreferredVideoSize();
560 * Returns the currently supported audio codecs, as PayloadType elements
563 PayloadType[] getAudioCodecs();
565 * Returns the currently supported video codecs, as PayloadType elements
568 PayloadType[] getVideoCodecs();
570 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
572 void enableKeepAlive(boolean enable);
574 * get keep elive mode
575 * @return true if enable
577 boolean isKeepAliveEnabled();
579 * Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
580 * status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
582 * @throws LinphoneCoreException if operation is still in progress;
584 void startEchoCalibration(Object data) throws LinphoneCoreException;
586 void enableIpv6(boolean enable);
587 void adjustSoftwareVolume(int i);
589 boolean pauseCall(LinphoneCall call);
590 boolean resumeCall(LinphoneCall call);
591 boolean pauseAllCalls();
593 void setZrtpSecretsCache(String file);