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 * Declines an incoming call, providing a reason for declining it.
402 public void declineCall(LinphoneCall aCall, Reason reason);
404 * Returns The LinphoneCall the current call if one is in call
407 public LinphoneCall getCurrentCall();
410 * get current call remote address in case of in/out call
411 * @return null if no call engaged yet
413 public LinphoneAddress getRemoteAddress();
416 * @return TRUE if there is a call running or pending.
418 public boolean isIncall();
421 * @return Returns true if in incoming call is pending, ie waiting for being answered or declined.
423 public boolean isInComingInvitePending();
425 * Main loop function. It is crucial that your application call it periodically.
427 * #iterate() performs various backgrounds tasks:
428 * <li>receiving of SIP messages
429 * <li> handles timers and timeout
430 * <li> performs registration to proxies
431 * <li> authentication retries The application MUST call this function from periodically, in its main loop.
432 * <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.
435 public void iterate();
437 * Accept an incoming call.
439 * Basically the application is notified of incoming calls within the
440 * {@link LinphoneCoreListener#callState} listener method.
441 * The application can later respond positively to the call using
443 * @throws LinphoneCoreException
445 public void acceptCall(LinphoneCall aCall) throws LinphoneCoreException;
448 * Accept an incoming call.
450 * Basically the application is notified of incoming calls within the
451 * {@link LinphoneCoreListener#callState} listener method.
452 * The application can later respond positively to the call using
454 * @throws LinphoneCoreException
456 public void acceptCallWithParams(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
459 * Accept call modifications initiated by other end.
461 * Basically the application is notified of incoming calls within the
462 * {@link LinphoneCoreListener#callState} listener method.
463 * The application can later respond positively to the call using
465 * @throws LinphoneCoreException
467 public void acceptCallUpdate(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
471 * Prevent LinphoneCore from performing an automatic answer
473 * Basically the application is notified of incoming calls within the
474 * {@link LinphoneCoreListener#callState} listener method.
475 * The application can later respond positively to the call using
477 * @throws LinphoneCoreException
479 public void deferCallUpdate(LinphoneCall aCall) throws LinphoneCoreException;
481 public void startRinging();
484 * @return a list of LinphoneCallLog
486 public LinphoneCallLog[] getCallLogs();
489 * This method is called by the application to notify the Linphone core library when network is reachable.
490 * Calling this method with true trigger Linphone to initiate a registration process for all proxy
491 * configuration with parameter register set to enable.
492 * This method disable the automatic registration mode. It means you must call this method after each network state changes
493 * @param network state
496 public void setNetworkReachable(boolean isReachable);
499 * @return if false, there is no network connection.
501 public boolean isNetworkReachable();
503 * destroy linphone core and free all underlying resources
505 public void destroy();
507 * Allow to control play level before entering sound card:
510 public void setPlaybackGain(float gain);
512 * get play level before entering sound card:
513 * @return level in db
515 public float getPlaybackGain();
518 * @param level [0..100]
520 public void setPlayLevel(int level);
522 * get playback level [0..100];
523 * -1 if not cannot be determined
526 public int getPlayLevel();
528 * Mutes or unmutes the local microphone.
531 void muteMic(boolean isMuted);
534 * @return true is mic is muted
536 boolean isMicMuted();
539 * Initiate a dtmf signal if in call
542 void sendDtmf(char number);
544 * Initiate a dtmf signal to the speaker if not in call.
545 * Sending of the DTMF is done in another function.
547 * @param duration in ms , -1 for unlimited
549 void playDtmf(char number,int duration);
556 * remove all call logs
558 void clearCallLogs();
560 * get payload type from mime type, clock rate, and number of channels.-
562 * return null if not found
564 PayloadType findPayloadType(String mime, int clockRate, int channels);
566 * get payload type from mime type and clock rate..
568 * return null if not found
570 PayloadType findPayloadType(String mime, int clockRate);
572 * not implemented yet
575 * @throws LinphoneCoreException
577 void enablePayloadType(PayloadType pt, boolean enable) throws LinphoneCoreException;
579 * Enables or disable echo cancellation.
582 void enableEchoCancellation(boolean enable);
585 * @return true if echo cancellation is enabled.
587 boolean isEchoCancellationEnabled();
589 * Get echo limiter status (another method of doing echo suppression, more brute force)
590 * @return true if echo limiter is enabled
592 boolean isEchoLimiterEnabled();
594 * @param transports used for signaling (TCP, UDP and TLS)
596 void setSignalingTransportPorts(Transports transports);
598 * @return transports used for signaling (TCP, UDP, TLS)
600 Transports getSignalingTransportPorts();
602 * Activates or deactivates the speaker.
605 void enableSpeaker(boolean value);
607 * Tells whether the speaker is activated.
608 * @return true if speaker enabled, false otherwise
610 boolean isSpeakerEnabled();
612 * add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
613 * @param lf LinphoenFriend to add
614 * @throws LinphoneCoreException
616 void addFriend(LinphoneFriend lf) throws LinphoneCoreException;
619 * Set my presence status
620 * @param minute_away how long in away
621 * @param status sip uri used to redirect call in state LinphoneStatusMoved
623 void setPresenceInfo(int minute_away,String alternative_contact, OnlineStatus status);
625 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
626 * @param to destination address for messages
628 * @return {@link LinphoneChatRoom} where messaging can take place.
630 LinphoneChatRoom createChatRoom(String to);
632 void setVideoWindow(Object w);
633 void setPreviewWindow(Object w);
634 void setDeviceRotation(int rotation);
636 void setVideoDevice(int id);
637 int getVideoDevice();
640 * Enables video globally.
643 * This function does not have any effect during calls. It just indicates #LinphoneCore to
644 * initiate future calls with video or not. The two boolean parameters indicate in which
645 * direction video is enabled. Setting both to false disables video entirely.
647 * @param vcap_enabled indicates whether video capture is enabled
648 * @param display_enabled indicates whether video display should be shown
651 void enableVideo(boolean vcap_enabled, boolean display_enabled);
653 * Returns TRUE if video is enabled, FALSE otherwise.
656 boolean isVideoEnabled();
659 * Specify a STUN server to help firewall traversal.
660 * @param stun_server Stun server address and port, such as stun.linphone.org or stun.linphone.org:3478
662 void setStunServer(String stun_server);
664 * @return stun server address if previously set.
666 String getStunServer();
669 * Sets policy regarding workarounding NATs
670 * @param pol one of the FirewallPolicy members.
672 void setFirewallPolicy(FirewallPolicy pol);
674 * @return previously set firewall policy.
676 FirewallPolicy getFirewallPolicy();
678 LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException ;
680 int updateCall(LinphoneCall call, LinphoneCallParams params);
682 LinphoneCallParams createDefaultCallParameters();
685 * Sets the path to a wav file used for ringing.
687 * @param path The file must be a wav 16bit linear. Local ring is disabled if null
689 void setRing(String path);
691 * gets the path to a wav file used for ringing.
693 * @param null if not set
698 * Sets file or folder containing trusted root CAs
700 * @param path path to file with multiple PEM certif or to folder with multiple PEM files
702 void setRootCA(String path);
704 void setUploadBandwidth(int bw);
706 void setDownloadBandwidth(int bw);
709 * Sets audio packetization interval suggested for remote end.
710 * @param ptime packetization interval in milliseconds
712 void setDownloadPtime(int ptime);
715 * Sets audio packetization interval sent to remote end.
716 * @param ptime packetization interval in milliseconds
718 void setUploadPtime(int ptime);
720 void setPreferredVideoSize(VideoSize vSize);
722 VideoSize getPreferredVideoSize();
725 * Returns the currently supported audio codecs, as PayloadType elements
728 PayloadType[] getAudioCodecs();
730 * Returns the currently supported video codecs, as PayloadType elements
733 PayloadType[] getVideoCodecs();
735 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
737 void enableKeepAlive(boolean enable);
739 * get keep elive mode
740 * @return true if enable
742 boolean isKeepAliveEnabled();
744 * Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
745 * status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
747 * @throws LinphoneCoreException if operation is still in progress;
749 void startEchoCalibration(Object data) throws LinphoneCoreException;
752 * Returns true if echo calibration is recommended.
753 * If the device has a builtin echo canceller or calibration value is already known, it will return false.
755 boolean needsEchoCalibration();
757 void enableIpv6(boolean enable);
762 void adjustSoftwareVolume(int i);
767 boolean pauseCall(LinphoneCall call);
771 boolean resumeCall(LinphoneCall call);
772 boolean pauseAllCalls();
774 void setZrtpSecretsCache(String file);
775 void enableEchoLimiter(boolean val);
778 * Indicates whether the local user is part of the conference.
780 boolean isInConference();
782 * Connect the local user to the conference.
784 boolean enterConference();
786 * Disconnect the local user from the conference.
788 void leaveConference();
791 * Add an established call to the conference. The LinphoneCore is able to manage one client based conference.
793 void addToConference(LinphoneCall call);
795 * Remove an established call from the conference.
797 void removeFromConference(LinphoneCall call);
798 void addAllToConference();
801 * Terminate the conference, all users are disconnected.
803 void terminateConference();
804 int getConferenceSize();
807 * Request recording of the conference into a supplied file path.
810 void startConferenceRecording(String path);
813 * Stop recording of the conference.
815 void stopConferenceRecording();
817 void terminateAllCalls();
821 LinphoneCall[] getCalls();
825 void transferCall(LinphoneCall call, String referTo);
826 void transferCallToAnother(LinphoneCall callToTransfer, LinphoneCall destination);
828 LinphoneCall findCallFromUri(String uri);
831 void setMaxCalls(int max);
832 boolean isMyself(String uri);
835 * Use this method to check the calls state and forbid proposing actions
836 * which could result in an active call.
837 * Eg: don't start a new call if one is in outgoing ringing.
838 * Eg: don't merge to conference either as it could result
839 * in two active calls (conference and accepted call).
842 boolean soundResourcesLocked();
844 * Returns whether given media encryption is supported by liblinphone.
846 boolean mediaEncryptionSupported(MediaEncryption menc);
848 * set media encryption (rtp) to use
849 * @params menc: MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
851 void setMediaEncryption(MediaEncryption menc);
853 * return selected media encryption
854 * @return MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
856 MediaEncryption getMediaEncryption();
858 * Set media encryption required for outgoing calls
860 void setMediaEncryptionMandatory(boolean yesno);
862 * @return if media encryption is required for outgoing calls
864 boolean isMediaEncryptionMandatory();
867 * @param path path to music file played to remote side when on hold.
869 void setPlayFile(String path);
870 void tunnelEnable(boolean enable);
871 void tunnelAutoDetect();
872 void tunnelCleanServers();
873 void tunnelSetHttpProxy(String proxy_host, int port, String username, String password);
875 * @param host tunnel server ip address
876 * @param port tunnel server tls port, recommended value is 443
877 * @param udpMirrorPort remote port on the tunnel server side used to test udp reachability
878 * @param roundTripDelay udp packet round trip delay in ms considered as acceptable. recommended value is 1000 ms
880 void tunnelAddServerAndMirror(String host, int port, int udpMirrorPort, int roundTripDelay);
882 boolean isTunnelAvailable();
884 LinphoneProxyConfig[] getProxyConfigList();
886 void setVideoPolicy(boolean autoInitiate, boolean autoAccept);
888 void setStaticPicture(String path);
890 void setUserAgent(String name, String version);
892 void setCpuCount(int count);
897 public void removeCallLog(LinphoneCallLog log);
900 * @return count of missed calls
902 public int getMissedCallsCount();
905 * Set missed calls count to zero
907 public void resetMissedCallsCount();
909 * re-initiates registration if network is up.
911 public void refreshRegisters();
914 * return the version code of linphone core
916 public String getVersion();
919 * remove a linphone friend from linphone core and linphonerc
921 void removeFriend(LinphoneFriend lf);
924 * return a linphone friend (if exists) that matches the sip address
926 LinphoneFriend findFriendByAddress(String sipUri);
929 * Sets the UDP port used for audio streaming.
931 void setAudioPort(int port);
934 * Sets the UDP port range from which to randomly select the port used for audio streaming.
936 void setAudioPortRange(int minPort, int maxPort);
939 * Sets the UDP port used for video streaming.
941 void setVideoPort(int port);
944 * Sets the UDP port range from which to randomly select the port used for video streaming.
946 void setVideoPortRange(int minPort, int maxPort);
949 * Set the incoming call timeout in seconds.
950 * If an incoming call isn't answered for this timeout period, it is
951 * automatically declined.
953 void setIncomingTimeout(int timeout);
956 * Set the call timeout in seconds.
957 * Once this time is elapsed (ringing included), the call is automatically hung up.
959 void setInCallTimeout(int timeout);
961 void setMicrophoneGain(float gain);
964 * Set username and display name to use if no LinphoneProxyConfig configured
966 void setPrimaryContact(String displayName, String username);
969 * Enable/Disable the use of SIP INFO for DTMFs
971 void setUseSipInfoForDtmfs(boolean use);
974 * Enable/Disable the use of inband DTMFs
976 void setUseRfc2833ForDtmfs(boolean use);
979 * @return returns LpConfig object to read/write to the config file: usefull if you wish to extend
980 * the config file with your own sections
982 LpConfig getConfig();
986 * Return the availability of uPnP.
988 * @return true if uPnP is available otherwise return false.
990 public boolean upnpAvailable();
993 * Return the internal state of uPnP.
995 * @return an UpnpState.
997 public UpnpState getUpnpState();
1000 * Return the external ip address of router.
1001 * In some cases the uPnP can have an external ip address but not a usable uPnP
1002 * (state different of Ok).
1004 * @return a null terminated string containing the external ip address. If the
1005 * the external ip address is not available return null.
1007 public String getUpnpExternalIpaddress();