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;
21 import java.util.Vector;
24 * Linphone core main object created by method {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object)}.
28 public interface LinphoneCore {
30 * linphone core states
32 static public class GlobalState {
34 static private Vector<GlobalState> values = new Vector<GlobalState>();
38 static public GlobalState GlobalOff = new GlobalState(0,"GlobalOff");
42 static public GlobalState GlobalStartup = new GlobalState(1,"GlobalStartup");
46 static public GlobalState GlobalOn = new GlobalState(2,"GlobalOn");
50 static public GlobalState GlobalShutdown = new GlobalState(3,"GlobalShutdown");
52 private final int mValue;
53 private final String mStringValue;
56 private GlobalState(int value,String stringValue) {
58 values.addElement(this);
59 mStringValue=stringValue;
61 public static GlobalState fromInt(int value) {
63 for (int i=0; i<values.size();i++) {
64 GlobalState state = (GlobalState) values.elementAt(i);
65 if (state.mValue == value) return state;
67 throw new RuntimeException("state not found ["+value+"]");
69 public String toString() {
74 * Describes proxy registration states.
77 static public class RegistrationState {
79 private static Vector<RegistrationState> values = new Vector<RegistrationState>();
83 public static RegistrationState RegistrationNone = new RegistrationState(0,"RegistrationNone");
87 public static RegistrationState RegistrationProgress = new RegistrationState(1,"RegistrationProgress");
91 public static RegistrationState RegistrationOk = new RegistrationState(2,"RegistrationOk");
95 public static RegistrationState RegistrationCleared = new RegistrationState(3,"RegistrationCleared");
99 public static RegistrationState RegistrationFailed = new RegistrationState(4,"RegistrationFailed");
100 private final int mValue;
101 private final String mStringValue;
104 private RegistrationState(int value,String stringValue) {
106 values.addElement(this);
107 mStringValue=stringValue;
109 public static RegistrationState fromInt(int value) {
111 for (int i=0; i<values.size();i++) {
112 RegistrationState state = (RegistrationState) values.elementAt(i);
113 if (state.mValue == value) return state;
115 throw new RuntimeException("state not found ["+value+"]");
117 public String toString() {
122 * Describes firewall policy.
125 static public class FirewallPolicy {
127 static private Vector<FirewallPolicy> values = new Vector<FirewallPolicy>();
129 * No firewall is assumed.
131 static public FirewallPolicy NoFirewall = new FirewallPolicy(0,"NoFirewall");
133 * Use NAT address (discouraged)
135 static public FirewallPolicy UseNatAddress = new FirewallPolicy(1,"UseNatAddress");
137 * Use stun server to discover RTP addresses and ports.
139 static public FirewallPolicy UseStun = new FirewallPolicy(2,"UseStun");
143 static public FirewallPolicy UseIce = new FirewallPolicy(3,"UseIce");
145 private final int mValue;
146 private final String mStringValue;
149 private FirewallPolicy(int value,String stringValue) {
151 values.addElement(this);
152 mStringValue=stringValue;
154 public static FirewallPolicy fromInt(int value) {
156 for (int i=0; i<values.size();i++) {
157 FirewallPolicy state = (FirewallPolicy) values.elementAt(i);
158 if (state.mValue == value) return state;
160 throw new RuntimeException("state not found ["+value+"]");
162 public String toString() {
171 * Signaling transports ports.
173 static public class Transports {
178 public Transports() {};
179 public Transports(Transports t) {
184 public String toString() {
185 return "udp["+udp+"] tcp["+tcp+"] tls["+tls+"]";
189 * Media (RTP) encryption enum-like.
192 static public final class MediaEncryption {
194 static private Vector<MediaEncryption> values = new Vector<MediaEncryption>();
198 static public final MediaEncryption None = new MediaEncryption(0,"None");
202 static public final MediaEncryption SRTP = new MediaEncryption(1,"SRTP");
206 static public final MediaEncryption ZRTP = new MediaEncryption(2,"ZRTP");
207 protected final int mValue;
208 private final String mStringValue;
211 private MediaEncryption(int value,String stringValue) {
213 values.addElement(this);
214 mStringValue=stringValue;
216 public static MediaEncryption fromInt(int value) {
218 for (int i=0; i<values.size();i++) {
219 MediaEncryption menc = (MediaEncryption) values.elementAt(i);
220 if (menc.mValue == value) return menc;
222 throw new RuntimeException("MediaEncryption not found ["+value+"]");
224 public String toString() {
229 * EC Calibrator Status
231 static public class EcCalibratorStatus {
233 static private Vector<EcCalibratorStatus> values = new Vector<EcCalibratorStatus>();
234 /* Do not change the values of these constants or the strings associated with them to prevent breaking
235 the collection of echo canceller calibration results during the wizard! */
236 public static final int IN_PROGRESS_STATUS=0;
237 public static final int DONE_STATUS=1;
238 public static final int FAILED_STATUS=2;
239 public static final int DONE_NO_ECHO_STATUS=3;
241 * Calibration in progress
243 static public EcCalibratorStatus InProgress = new EcCalibratorStatus(IN_PROGRESS_STATUS,"InProgress");
245 * Calibration done that produced an echo delay measure
247 static public EcCalibratorStatus Done = new EcCalibratorStatus(DONE_STATUS,"Done");
251 static public EcCalibratorStatus Failed = new EcCalibratorStatus(FAILED_STATUS,"Failed");
253 * Calibration done with no echo detected
255 static public EcCalibratorStatus DoneNoEcho = new EcCalibratorStatus(DONE_NO_ECHO_STATUS, "DoneNoEcho");
257 private final int mValue;
258 private final String mStringValue;
261 private EcCalibratorStatus(int value,String stringValue) {
263 values.addElement(this);
264 mStringValue=stringValue;
266 public static EcCalibratorStatus fromInt(int value) {
268 for (int i=0; i<values.size();i++) {
269 EcCalibratorStatus status = (EcCalibratorStatus) values.elementAt(i);
270 if (status.mValue == value) return status;
272 throw new RuntimeException("status not found ["+value+"]");
274 public String toString() {
282 static public class UpnpState {
283 static private Vector<UpnpState> values = new Vector<UpnpState>();
287 static public UpnpState Idle = new UpnpState(0, "Idle");
291 static public UpnpState Pending = new UpnpState(1, "Pending");
295 static public UpnpState Adding = new UpnpState(2, "Adding");
299 static public UpnpState Removing = new UpnpState(3, "Removing");
303 static public UpnpState NotAvailable = new UpnpState(4, "Not available");
307 static public UpnpState Ok = new UpnpState(5, "Ok");
311 static public UpnpState Ko = new UpnpState(6, "Ko");
312 protected final int mValue;
313 private final String mStringValue;
315 private UpnpState(int value, String stringValue) {
317 values.addElement(this);
318 mStringValue = stringValue;
320 public static UpnpState fromInt(int value) {
321 for (int i = 0; i < values.size(); i++) {
322 UpnpState mstate = (UpnpState) values.elementAt(i);
323 if (mstate.mValue == value) return mstate;
325 throw new RuntimeException("UpnpState not found [" + value + "]");
327 public String toString() {
333 * Set the context of creation of the LinphoneCore.
335 public void setContext(Object context);
338 * clear all added proxy configs
340 public void clearProxyConfigs();
342 * Add a proxy configuration. This will start registration on the proxy, if registration is enabled.
344 * @throws LinphoneCoreException
346 public void addProxyConfig(LinphoneProxyConfig proxyCfg) throws LinphoneCoreException;
348 * Sets the default proxy.
350 * This default proxy must be part of the list of already entered {@link LinphoneProxyConfig}.
351 * Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls.
354 public void setDefaultProxyConfig(LinphoneProxyConfig proxyCfg);
357 * get he default proxy configuration, that is the one used to determine the current identity.
358 * @return null if no default proxy config
360 public LinphoneProxyConfig getDefaultProxyConfig() ;
363 * clear all the added auth info
365 void clearAuthInfos();
367 * Adds authentication information to the LinphoneCore.
368 * <br>This information will be used during all SIP transacations that require authentication.
371 void addAuthInfo(LinphoneAuthInfo info);
374 * Build an address according to the current proxy config. In case destination is not a sip address, the default proxy domain is automatically appended
377 * @throws If no LinphoneAddress can be built from destination
379 public LinphoneAddress interpretUrl(String destination) throws LinphoneCoreException;
382 * Starts a call given a destination. Internally calls {@link #interpretUrl(String)} then {@link #invite(LinphoneAddress)}.
385 public LinphoneCall invite(String destination)throws LinphoneCoreException;
387 * Initiates an outgoing call given a destination LinphoneAddress
388 *<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.
389 * @param to the destination of the call (sip address).
390 * @return LinphoneCall
391 * @throws LinphoneCoreException
393 public LinphoneCall invite(LinphoneAddress to)throws LinphoneCoreException;
396 * @param aCall to be terminated
398 public void terminateCall(LinphoneCall aCall);
400 * Returns The LinphoneCall the current call if one is in call
403 public LinphoneCall getCurrentCall();
406 * get current call remote address in case of in/out call
407 * @return null if no call engaged yet
409 public LinphoneAddress getRemoteAddress();
412 * @return TRUE if there is a call running or pending.
414 public boolean isIncall();
417 * @return Returns true if in incoming call is pending, ie waiting for being answered or declined.
419 public boolean isInComingInvitePending();
421 * Main loop function. It is crucial that your application call it periodically.
423 * #iterate() performs various backgrounds tasks:
424 * <li>receiving of SIP messages
425 * <li> handles timers and timeout
426 * <li> performs registration to proxies
427 * <li> authentication retries The application MUST call this function from periodically, in its main loop.
428 * <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.
431 public void iterate();
433 * Accept an incoming call.
435 * Basically the application is notified of incoming calls within the
436 * {@link LinphoneCoreListener#callState} listener method.
437 * The application can later respond positively to the call using
439 * @throws LinphoneCoreException
441 public void acceptCall(LinphoneCall aCall) throws LinphoneCoreException;
444 * Accept an incoming call.
446 * Basically the application is notified of incoming calls within the
447 * {@link LinphoneCoreListener#callState} listener method.
448 * The application can later respond positively to the call using
450 * @throws LinphoneCoreException
452 public void acceptCallWithParams(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
455 * Accept call modifications initiated by other end.
457 * Basically the application is notified of incoming calls within the
458 * {@link LinphoneCoreListener#callState} listener method.
459 * The application can later respond positively to the call using
461 * @throws LinphoneCoreException
463 public void acceptCallUpdate(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
467 * Prevent LinphoneCore from performing an automatic answer
469 * Basically the application is notified of incoming calls within the
470 * {@link LinphoneCoreListener#callState} listener method.
471 * The application can later respond positively to the call using
473 * @throws LinphoneCoreException
475 public void deferCallUpdate(LinphoneCall aCall) throws LinphoneCoreException;
477 public void startRinging();
480 * @return a list of LinphoneCallLog
482 public LinphoneCallLog[] getCallLogs();
485 * This method is called by the application to notify the Linphone core library when network is reachable.
486 * Calling this method with true trigger Linphone to initiate a registration process for all proxy
487 * configuration with parameter register set to enable.
488 * This method disable the automatic registration mode. It means you must call this method after each network state changes
489 * @param network state
492 public void setNetworkReachable(boolean isReachable);
495 * @return if false, there is no network connection.
497 public boolean isNetworkReachable();
499 * destroy linphone core and free all underlying resources
501 public void destroy();
503 * Allow to control play level before entering sound card:
506 public void setPlaybackGain(float gain);
508 * get play level before entering sound card:
509 * @return level in db
511 public float getPlaybackGain();
514 * @param level [0..100]
516 public void setPlayLevel(int level);
518 * get playback level [0..100];
519 * -1 if not cannot be determined
522 public int getPlayLevel();
524 * Mutes or unmutes the local microphone.
527 void muteMic(boolean isMuted);
530 * @return true is mic is muted
532 boolean isMicMuted();
535 * Initiate a dtmf signal if in call
538 void sendDtmf(char number);
540 * Initiate a dtmf signal to the speaker if not in call.
541 * Sending of the DTMF is done in another function.
543 * @param duration in ms , -1 for unlimited
545 void playDtmf(char number,int duration);
552 * remove all call logs
554 void clearCallLogs();
556 * get payload type from mime type, clock rate, and number of channels.-
558 * return null if not found
560 PayloadType findPayloadType(String mime, int clockRate, int channels);
562 * get payload type from mime type and clock rate..
564 * return null if not found
566 PayloadType findPayloadType(String mime, int clockRate);
568 * not implemented yet
571 * @throws LinphoneCoreException
573 void enablePayloadType(PayloadType pt, boolean enable) throws LinphoneCoreException;
575 * Enables or disable echo cancellation.
578 void enableEchoCancellation(boolean enable);
581 * @return true if echo cancellation is enabled.
583 boolean isEchoCancellationEnabled();
585 * Get echo limiter status (another method of doing echo suppression, more brute force)
586 * @return true if echo limiter is enabled
588 boolean isEchoLimiterEnabled();
590 * @param transports used for signaling (TCP, UDP and TLS)
592 void setSignalingTransportPorts(Transports transports);
594 * @return transports used for signaling (TCP, UDP, TLS)
596 Transports getSignalingTransportPorts();
598 * Activates or deactivates the speaker.
601 void enableSpeaker(boolean value);
603 * Tells whether the speaker is activated.
604 * @return true if speaker enabled, false otherwise
606 boolean isSpeakerEnabled();
608 * add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
609 * @param lf LinphoenFriend to add
610 * @throws LinphoneCoreException
612 void addFriend(LinphoneFriend lf) throws LinphoneCoreException;
615 * Set my presence status
616 * @param minute_away how long in away
617 * @param status sip uri used to redirect call in state LinphoneStatusMoved
619 void setPresenceInfo(int minute_away,String alternative_contact, OnlineStatus status);
621 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
622 * @param to destination address for messages
624 * @return {@link LinphoneChatRoom} where messaging can take place.
626 LinphoneChatRoom createChatRoom(String to);
628 void setVideoWindow(Object w);
629 void setPreviewWindow(Object w);
630 void setDeviceRotation(int rotation);
632 void setVideoDevice(int id);
633 int getVideoDevice();
636 * Enables video globally.
639 * This function does not have any effect during calls. It just indicates #LinphoneCore to
640 * initiate future calls with video or not. The two boolean parameters indicate in which
641 * direction video is enabled. Setting both to false disables video entirely.
643 * @param vcap_enabled indicates whether video capture is enabled
644 * @param display_enabled indicates whether video display should be shown
647 void enableVideo(boolean vcap_enabled, boolean display_enabled);
649 * Returns TRUE if video is enabled, FALSE otherwise.
652 boolean isVideoEnabled();
655 * Specify a STUN server to help firewall traversal.
656 * @param stun_server Stun server address and port, such as stun.linphone.org or stun.linphone.org:3478
658 void setStunServer(String stun_server);
660 * @return stun server address if previously set.
662 String getStunServer();
665 * Sets policy regarding workarounding NATs
666 * @param pol one of the FirewallPolicy members.
668 void setFirewallPolicy(FirewallPolicy pol);
670 * @return previously set firewall policy.
672 FirewallPolicy getFirewallPolicy();
674 LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException ;
676 int updateCall(LinphoneCall call, LinphoneCallParams params);
678 LinphoneCallParams createDefaultCallParameters();
681 * Sets the path to a wav file used for ringing.
683 * @param path The file must be a wav 16bit linear. Local ring is disabled if null
685 void setRing(String path);
687 * gets the path to a wav file used for ringing.
689 * @param null if not set
694 * Sets file or folder containing trusted root CAs
696 * @param path path to file with multiple PEM certif or to folder with multiple PEM files
698 void setRootCA(String path);
700 void setUploadBandwidth(int bw);
702 void setDownloadBandwidth(int bw);
705 * Sets audio packetization interval suggested for remote end.
706 * @param ptime packetization interval in milliseconds
708 void setDownloadPtime(int ptime);
711 * Sets audio packetization interval sent to remote end.
712 * @param ptime packetization interval in milliseconds
714 void setUploadPtime(int ptime);
716 void setPreferredVideoSize(VideoSize vSize);
718 VideoSize getPreferredVideoSize();
721 * Returns the currently supported audio codecs, as PayloadType elements
724 PayloadType[] getAudioCodecs();
726 * Returns the currently supported video codecs, as PayloadType elements
729 PayloadType[] getVideoCodecs();
731 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
733 void enableKeepAlive(boolean enable);
735 * get keep elive mode
736 * @return true if enable
738 boolean isKeepAliveEnabled();
740 * Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
741 * status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
743 * @throws LinphoneCoreException if operation is still in progress;
745 void startEchoCalibration(Object data) throws LinphoneCoreException;
747 void enableIpv6(boolean enable);
752 void adjustSoftwareVolume(int i);
754 boolean pauseCall(LinphoneCall call);
755 boolean resumeCall(LinphoneCall call);
756 boolean pauseAllCalls();
758 void setZrtpSecretsCache(String file);
759 void enableEchoLimiter(boolean val);
761 boolean isInConference();
762 boolean enterConference();
763 void leaveConference();
765 void addToConference(LinphoneCall call);
766 void addAllToConference();
767 void removeFromConference(LinphoneCall call);
769 void terminateConference();
770 int getConferenceSize();
772 void terminateAllCalls();
773 LinphoneCall[] getCalls();
777 void transferCall(LinphoneCall call, String referTo);
778 void transferCallToAnother(LinphoneCall callToTransfer, LinphoneCall destination);
780 LinphoneCall findCallFromUri(String uri);
783 void setMaxCalls(int max);
784 boolean isMyself(String uri);
787 * Use this method to check the calls state and forbid proposing actions
788 * which could result in an active call.
789 * Eg: don't start a new call if one is in outgoing ringing.
790 * Eg: don't merge to conference either as it could result
791 * in two active calls (conference and accepted call).
794 boolean soundResourcesLocked();
796 * Returns whether given media encryption is supported by liblinphone.
798 boolean mediaEncryptionSupported(MediaEncryption menc);
800 * set media encryption (rtp) to use
801 * @params menc: MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
803 void setMediaEncryption(MediaEncryption menc);
805 * return selected media encryption
806 * @return MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
808 MediaEncryption getMediaEncryption();
810 * Set media encryption required for outgoing calls
812 void setMediaEncryptionMandatory(boolean yesno);
814 * @return if media encryption is required for outgoing calls
816 boolean isMediaEncryptionMandatory();
819 * @param path path to music file played to remote side when on hold.
821 void setPlayFile(String path);
822 void tunnelEnable(boolean enable);
823 void tunnelAutoDetect();
824 void tunnelCleanServers();
825 void tunnelSetHttpProxy(String proxy_host, int port, String username, String password);
827 * @param host tunnel server ip address
828 * @param port tunnel server tls port, recommended value is 443
829 * @param udpMirrorPort remote port on the tunnel server side used to test udp reachability
830 * @param roundTripDelay udp packet round trip delay in ms considered as acceptable. recommended value is 1000 ms
832 void tunnelAddServerAndMirror(String host, int port, int udpMirrorPort, int roundTripDelay);
834 boolean isTunnelAvailable();
836 LinphoneProxyConfig[] getProxyConfigList();
838 void setVideoPolicy(boolean autoInitiate, boolean autoAccept);
840 void setStaticPicture(String path);
842 void setUserAgent(String name, String version);
844 void setCpuCount(int count);
849 public void removeCallLog(LinphoneCallLog log);
852 * @return count of missed calls
854 public int getMissedCallsCount();
857 * Set missed calls count to zero
859 public void resetMissedCallsCount();
861 * re-initiates registration if network is up.
863 public void refreshRegisters();
866 * return the version code of linphone core
868 public String getVersion();
871 * remove a linphone friend from linphone core and linphonerc
873 void removeFriend(LinphoneFriend lf);
876 * return a linphone friend (if exists) that matches the sip address
878 LinphoneFriend findFriendByAddress(String sipUri);
881 * Sets the UDP port used for audio streaming.
883 void setAudioPort(int port);
886 * Sets the UDP port range from which to randomly select the port used for audio streaming.
888 void setAudioPortRange(int minPort, int maxPort);
891 * Sets the UDP port used for video streaming.
893 void setVideoPort(int port);
896 * Sets the UDP port range from which to randomly select the port used for video streaming.
898 void setVideoPortRange(int minPort, int maxPort);
901 * Set the incoming call timeout in seconds.
902 * If an incoming call isn't answered for this timeout period, it is
903 * automatically declined.
905 void setIncomingTimeout(int timeout);
908 * Set the call timeout in seconds.
909 * Once this time is elapsed (ringing included), the call is automatically hung up.
911 void setInCallTimeout(int timeout);
913 void setMicrophoneGain(float gain);
916 * Set username and display name to use if no LinphoneProxyConfig configured
918 void setPrimaryContact(String displayName, String username);
921 * Enable/Disable the use of SIP INFO for DTMFs
923 void setUseSipInfoForDtmfs(boolean use);
926 * Enable/Disable the use of inband DTMFs
928 void setUseRfc2833ForDtmfs(boolean use);
931 * @return returns LpConfig object to read/write to the config file: usefull if you wish to extend
932 * the config file with your own sections
934 LpConfig getConfig();
938 * Return the availability of uPnP.
940 * @return true if uPnP is available otherwise return false.
942 public boolean upnpAvailable();
945 * Return the internal state of uPnP.
947 * @return an UpnpState.
949 public UpnpState getUpnpState();
952 * Return the external ip address of router.
953 * In some cases the uPnP can have an external ip address but not a usable uPnP
954 * (state different of Ok).
956 * @return a null terminated string containing the external ip address. If the
957 * the external ip address is not available return null.
959 public String getUpnpExternalIpaddress();