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();
189 public static final int IN_PROGRESS_STATUS=0;
190 public static final int DONE_STATUS=1;
191 public static final int FAILED_STATUS=2;
193 * Calibration in progress
195 static public EcCalibratorStatus InProgress = new EcCalibratorStatus(IN_PROGRESS_STATUS,"InProgress");
199 static public EcCalibratorStatus Done = new EcCalibratorStatus(DONE_STATUS,"Done");
201 * Calibration in progress
203 static public EcCalibratorStatus Failed = new EcCalibratorStatus(FAILED_STATUS,"Failed");
205 private final int mValue;
206 private final String mStringValue;
208 @SuppressWarnings("unchecked")
209 private EcCalibratorStatus(int value,String stringValue) {
211 values.addElement(this);
212 mStringValue=stringValue;
214 public static EcCalibratorStatus fromInt(int value) {
216 for (int i=0; i<values.size();i++) {
217 EcCalibratorStatus status = (EcCalibratorStatus) values.elementAt(i);
218 if (status.mValue == value) return status;
220 throw new RuntimeException("status not found ["+value+"]");
222 public String toString() {
230 * clear all added proxy configs
232 public void clearProxyConfigs();
234 * Add a proxy configuration. This will start registration on the proxy, if registration is enabled.
236 * @throws LinphoneCoreException
238 public void addProxyConfig(LinphoneProxyConfig proxyCfg) throws LinphoneCoreException;
240 * Sets the default proxy.
242 * This default proxy must be part of the list of already entered {@link LinphoneProxyConfig}.
243 * Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls.
246 public void setDefaultProxyConfig(LinphoneProxyConfig proxyCfg);
249 * get he default proxy configuration, that is the one used to determine the current identity.
250 * @return null if no default proxy config
252 public LinphoneProxyConfig getDefaultProxyConfig() ;
255 * clear all the added auth info
257 void clearAuthInfos();
259 * Adds authentication information to the LinphoneCore.
260 * <br>This information will be used during all SIP transacations that require authentication.
263 void addAuthInfo(LinphoneAuthInfo info);
266 * Build an address according to the current proxy config. In case destination is not a sip address, the default proxy domain is automatically appended
269 * @throws If no LinphoneAddress can be built from destination
271 public LinphoneAddress interpretUrl(String destination) throws LinphoneCoreException;
274 * Starts a call given a destination. Internally calls {@link #interpretUrl(String)} then {@link #invite(LinphoneAddress)}.
277 public LinphoneCall invite(String destination)throws LinphoneCoreException;
279 * Initiates an outgoing call given a destination LinphoneAddress
280 *<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.
281 * @param to the destination of the call (sip address).
282 * @return LinphoneCall
283 * @throws LinphoneCoreException
285 public LinphoneCall invite(LinphoneAddress to)throws LinphoneCoreException;
288 * @param aCall to be terminated
290 public void terminateCall(LinphoneCall aCall);
292 * Returns The LinphoneCall the current call if one is in call
295 public LinphoneCall getCurrentCall();
298 * get current call remote address in case of in/out call
299 * @return null if no call engaged yet
301 public LinphoneAddress getRemoteAddress();
304 * @return TRUE if there is a call running or pending.
306 public boolean isIncall();
309 * @return Returns true if in incoming call is pending, ie waiting for being answered or declined.
311 public boolean isInComingInvitePending();
313 * Main loop function. It is crucial that your application call it periodically.
315 * #iterate() performs various backgrounds tasks:
316 * <li>receiving of SIP messages
317 * <li> handles timers and timeout
318 * <li> performs registration to proxies
319 * <li> authentication retries The application MUST call this function from periodically, in its main loop.
320 * <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.
323 public void iterate();
325 * Accept an incoming call.
327 * Basically the application is notified of incoming calls within the
328 * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener.
329 * The application can later respond positively to the call using
331 * @throws LinphoneCoreException
333 public void acceptCall(LinphoneCall aCall) throws LinphoneCoreException;
337 * @return a list of LinphoneCallLog
339 @SuppressWarnings("unchecked")
340 public List getCallLogs();
343 * This method is called by the application to notify the Linphone core library when network is reachable.
344 * Calling this method with true trigger Linphone to initiate a registration process for all proxy
345 * configuration with parameter register set to enable.
346 * This method disable the automatic registration mode. It means you must call this method after each network state changes
347 * @param network state
350 public void setNetworkReachable(boolean isReachable);
353 * @return if false, there is no network connection.
355 public boolean isNetworkReachable();
357 * destroy linphone core and free all underlying resources
359 public void destroy();
361 * Allow to control play level before entering sound card:
364 public void setPlaybackGain(float gain);
366 * get play level before entering sound card:
367 * @return level in db
369 public float getPlaybackGain();
372 * @param level [0..100]
374 public void setPlayLevel(int level);
376 * get playback level [0..100];
377 * -1 if not cannot be determined
380 public int getPlayLevel();
382 * Mutes or unmutes the local microphone.
385 void muteMic(boolean isMuted);
388 * @return true is mic is muted
390 boolean isMicMuted();
393 * Initiate a dtmf signal if in call
396 void sendDtmf(char number);
398 * Initiate a dtmf signal to the speaker if not in call.
399 * Sending of the DTMF is done in another function.
401 * @param duration in ms , -1 for unlimited
403 void playDtmf(char number,int duration);
410 * remove all call logs
412 void clearCallLogs();
414 * get payload type from mime type an clock rate
416 * return null if not found
418 PayloadType findPayloadType(String mime,int clockRate);
420 * not implemented yet
423 * @throws LinphoneCoreException
425 void enablePayloadType(PayloadType pt, boolean enable) throws LinphoneCoreException;
427 * Enables or disable echo cancellation.
430 void enableEchoCancellation(boolean enable);
433 * @return true if echo cancellation is enabled.
435 boolean isEchoCancellationEnabled();
437 * Get echo limiter status (another method of doing echo suppressionn, more brute force)
438 * @return true if echo limiter is enabled
440 boolean isEchoLimiterEnabled();
442 * @param transports used for signaling (TCP, UDP and TLS)
444 void setSignalingTransportPorts(Transports transports);
446 * @return transports used for signaling (TCP, UDP, TLS)
448 Transports getSignalingTransportPorts();
453 void enableSpeaker(boolean value);
458 boolean isSpeakerEnabled();
460 * add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
461 * @param lf LinphoenFriend to add
462 * @throws LinphoneCoreException
464 void addFriend(LinphoneFriend lf) throws LinphoneCoreException;
467 * Set my presence status
468 * @param minute_away how long in away
469 * @param status sip uri used to redirect call in state LinphoneStatusMoved
471 void setPresenceInfo(int minute_away,String alternative_contact, OnlineStatus status);
473 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
474 * @param to destination address for messages
476 * @return {@link LinphoneChatRoom} where messaging can take place.
478 LinphoneChatRoom createChatRoom(String to);
480 void setVideoWindow(Object w);
481 void setPreviewWindow(Object w);
482 void setDeviceRotation(int rotation);
484 void setVideoDevice(int id);
485 int getVideoDevice();
488 * Enables video globally.
491 * This function does not have any effect during calls. It just indicates #LinphoneCore to
492 * initiate future calls with video or not. The two boolean parameters indicate in which
493 * direction video is enabled. Setting both to false disables video entirely.
495 * @param vcap_enabled indicates whether video capture is enabled
496 * @param display_enabled indicates whether video display should be shown
499 void enableVideo(boolean vcap_enabled, boolean display_enabled);
501 * Returns TRUE if video is enabled, FALSE otherwise.
504 boolean isVideoEnabled();
507 * Specify a STUN server to help firewall traversal.
508 * @param stun_server Stun server address and port, such as stun.linphone.org or stun.linphone.org:3478
510 void setStunServer(String stun_server);
512 * @return stun server address if previously set.
514 String getStunServer();
517 * Sets policy regarding workarounding NATs
518 * @param pol one of the FirewallPolicy members.
520 void setFirewallPolicy(FirewallPolicy pol);
522 * @return previously set firewall policy.
524 FirewallPolicy getFirewallPolicy();
526 LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException ;
528 int updateCall(LinphoneCall call, LinphoneCallParams params);
530 LinphoneCallParams createDefaultCallParameters();
533 * Sets the path to a wav file used for ringing.
535 * @param path The file must be a wav 16bit linear. Local ring is disabled if null
537 void setRing(String path);
539 * gets the path to a wav file used for ringing.
541 * @param null if not set
546 * Sets file or folder containing trusted root CAs
548 * @param path path to file with multiple PEM certif or to folder with multiple PEM files
550 void setRootCA(String path);
552 void setUploadBandwidth(int bw);
554 void setDownloadBandwidth(int bw);
557 * Sets audio packetization interval suggested for remote end.
558 * @param ptime packetization interval in milliseconds
560 void setDownloadPtime(int ptime);
563 * Sets audio packetization interval sent to remote end.
564 * @param ptime packetization interval in milliseconds
566 void setUploadPtime(int ptime);
568 void setPreferredVideoSize(VideoSize vSize);
570 VideoSize getPreferredVideoSize();
573 * Returns the currently supported audio codecs, as PayloadType elements
576 PayloadType[] getAudioCodecs();
578 * Returns the currently supported video codecs, as PayloadType elements
581 PayloadType[] getVideoCodecs();
583 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
585 void enableKeepAlive(boolean enable);
587 * get keep elive mode
588 * @return true if enable
590 boolean isKeepAliveEnabled();
592 * Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
593 * status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
595 * @throws LinphoneCoreException if operation is still in progress;
597 void startEchoCalibration(Object data) throws LinphoneCoreException;
599 void enableIpv6(boolean enable);
600 void adjustSoftwareVolume(int i);
602 boolean pauseCall(LinphoneCall call);
603 boolean resumeCall(LinphoneCall call);
604 boolean pauseAllCalls();
606 void setZrtpSecretsCache(String file);
607 void enableEchoLimiter(boolean val);
609 boolean isInConference();
610 void enterConference();
611 void leaveConference();
613 void addToConference(LinphoneCall call);
614 void addAllToConference();
615 void removeFromConference(LinphoneCall call);
617 void terminateConference();
618 int getConferenceSize();
620 void terminateAllCalls();
621 @SuppressWarnings("unchecked") List getCalls();
625 void transferCall(LinphoneCall call, String referTo);
626 void transferCallToAnother(LinphoneCall callToTransfer, LinphoneCall destination);
628 LinphoneCall findCallFromUri(String uri);
631 void setMaxCalls(int max);
632 boolean isMyself(String uri);
635 * Use this method to check the calls state and forbid proposing actions
636 * which could result in an active call.
637 * Eg: don't start a new call if one is in outgoing ringing.
638 * Eg: don't merge to conference either as it could result
639 * in two active calls (conference and accepted call).
642 boolean soundResourcesLocked();
644 * set media encryption (rtp) to use
645 * @params menc: 'none', 'srtp' or 'zrtp'
647 void setMediaEncryption(String menc);
649 * return selected media encryption
650 * @return 'none', 'srtp' or 'zrtp'
652 String getMediaEncryption();
654 * Set media encryption required for outgoing calls
656 void setMediaEncryptionMandatory(boolean yesno);
658 * @return if media encryption is required for ougtoing calls
660 boolean isMediaEncryptionMandatory();