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 values = new Vector();
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 values = new Vector();
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 values = new Vector();
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 class MediaEncryption {
194 static private Vector values = new Vector();
198 static public MediaEncryption None = new MediaEncryption(0,"None");
202 static public MediaEncryption SRTP = new MediaEncryption(1,"SRTP");
206 static public 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 values = new Vector();
234 public static final int IN_PROGRESS_STATUS=0;
235 public static final int DONE_STATUS=1;
236 public static final int FAILED_STATUS=2;
238 * Calibration in progress
240 static public EcCalibratorStatus InProgress = new EcCalibratorStatus(IN_PROGRESS_STATUS,"InProgress");
244 static public EcCalibratorStatus Done = new EcCalibratorStatus(DONE_STATUS,"Done");
246 * Calibration in progress
248 static public EcCalibratorStatus Failed = new EcCalibratorStatus(FAILED_STATUS,"Failed");
250 private final int mValue;
251 private final String mStringValue;
254 private EcCalibratorStatus(int value,String stringValue) {
256 values.addElement(this);
257 mStringValue=stringValue;
259 public static EcCalibratorStatus fromInt(int value) {
261 for (int i=0; i<values.size();i++) {
262 EcCalibratorStatus status = (EcCalibratorStatus) values.elementAt(i);
263 if (status.mValue == value) return status;
265 throw new RuntimeException("status not found ["+value+"]");
267 public String toString() {
275 * clear all added proxy configs
277 public void clearProxyConfigs();
279 * Add a proxy configuration. This will start registration on the proxy, if registration is enabled.
281 * @throws LinphoneCoreException
283 public void addProxyConfig(LinphoneProxyConfig proxyCfg) throws LinphoneCoreException;
285 * Sets the default proxy.
287 * This default proxy must be part of the list of already entered {@link LinphoneProxyConfig}.
288 * Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls.
291 public void setDefaultProxyConfig(LinphoneProxyConfig proxyCfg);
294 * get he default proxy configuration, that is the one used to determine the current identity.
295 * @return null if no default proxy config
297 public LinphoneProxyConfig getDefaultProxyConfig() ;
300 * clear all the added auth info
302 void clearAuthInfos();
304 * Adds authentication information to the LinphoneCore.
305 * <br>This information will be used during all SIP transacations that require authentication.
308 void addAuthInfo(LinphoneAuthInfo info);
311 * Build an address according to the current proxy config. In case destination is not a sip address, the default proxy domain is automatically appended
314 * @throws If no LinphoneAddress can be built from destination
316 public LinphoneAddress interpretUrl(String destination) throws LinphoneCoreException;
319 * Starts a call given a destination. Internally calls {@link #interpretUrl(String)} then {@link #invite(LinphoneAddress)}.
322 public LinphoneCall invite(String destination)throws LinphoneCoreException;
324 * Initiates an outgoing call given a destination LinphoneAddress
325 *<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.
326 * @param to the destination of the call (sip address).
327 * @return LinphoneCall
328 * @throws LinphoneCoreException
330 public LinphoneCall invite(LinphoneAddress to)throws LinphoneCoreException;
333 * @param aCall to be terminated
335 public void terminateCall(LinphoneCall aCall);
337 * Returns The LinphoneCall the current call if one is in call
340 public LinphoneCall getCurrentCall();
343 * get current call remote address in case of in/out call
344 * @return null if no call engaged yet
346 public LinphoneAddress getRemoteAddress();
349 * @return TRUE if there is a call running or pending.
351 public boolean isIncall();
354 * @return Returns true if in incoming call is pending, ie waiting for being answered or declined.
356 public boolean isInComingInvitePending();
358 * Main loop function. It is crucial that your application call it periodically.
360 * #iterate() performs various backgrounds tasks:
361 * <li>receiving of SIP messages
362 * <li> handles timers and timeout
363 * <li> performs registration to proxies
364 * <li> authentication retries The application MUST call this function from periodically, in its main loop.
365 * <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.
368 public void iterate();
370 * Accept an incoming call.
372 * Basically the application is notified of incoming calls within the
373 * {@link LinphoneCoreListener#callState} listener method.
374 * The application can later respond positively to the call using
376 * @throws LinphoneCoreException
378 public void acceptCall(LinphoneCall aCall) throws LinphoneCoreException;
381 * Accept an incoming call.
383 * Basically the application is notified of incoming calls within the
384 * {@link LinphoneCoreListener#callState} listener method.
385 * The application can later respond positively to the call using
387 * @throws LinphoneCoreException
389 public void acceptCallWithParams(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
392 * Accept call modifications initiated by other end.
394 * Basically the application is notified of incoming calls within the
395 * {@link LinphoneCoreListener#callState} listener method.
396 * The application can later respond positively to the call using
398 * @throws LinphoneCoreException
400 public void acceptCallUpdate(LinphoneCall aCall, LinphoneCallParams params) throws LinphoneCoreException;
404 * Prevent LinphoneCore from performing an automatic answer
406 * Basically the application is notified of incoming calls within the
407 * {@link LinphoneCoreListener#callState} listener method.
408 * The application can later respond positively to the call using
410 * @throws LinphoneCoreException
412 public void deferCallUpdate(LinphoneCall aCall) throws LinphoneCoreException;
415 * @return a list of LinphoneCallLog
417 public LinphoneCallLog[] getCallLogs();
420 * This method is called by the application to notify the Linphone core library when network is reachable.
421 * Calling this method with true trigger Linphone to initiate a registration process for all proxy
422 * configuration with parameter register set to enable.
423 * This method disable the automatic registration mode. It means you must call this method after each network state changes
424 * @param network state
427 public void setNetworkReachable(boolean isReachable);
430 * @return if false, there is no network connection.
432 public boolean isNetworkReachable();
434 * destroy linphone core and free all underlying resources
436 public void destroy();
438 * Allow to control play level before entering sound card:
441 public void setPlaybackGain(float gain);
443 * get play level before entering sound card:
444 * @return level in db
446 public float getPlaybackGain();
449 * @param level [0..100]
451 public void setPlayLevel(int level);
453 * get playback level [0..100];
454 * -1 if not cannot be determined
457 public int getPlayLevel();
459 * Mutes or unmutes the local microphone.
462 void muteMic(boolean isMuted);
465 * @return true is mic is muted
467 boolean isMicMuted();
470 * Initiate a dtmf signal if in call
473 void sendDtmf(char number);
475 * Initiate a dtmf signal to the speaker if not in call.
476 * Sending of the DTMF is done in another function.
478 * @param duration in ms , -1 for unlimited
480 void playDtmf(char number,int duration);
487 * remove all call logs
489 void clearCallLogs();
491 * get payload type from mime type, clock rate, and number of channels.-
493 * return null if not found
495 PayloadType findPayloadType(String mime, int clockRate, int channels);
497 * get payload type from mime type and clock rate..
499 * return null if not found
501 PayloadType findPayloadType(String mime, int clockRate);
503 * not implemented yet
506 * @throws LinphoneCoreException
508 void enablePayloadType(PayloadType pt, boolean enable) throws LinphoneCoreException;
510 * Enables or disable echo cancellation.
513 void enableEchoCancellation(boolean enable);
516 * @return true if echo cancellation is enabled.
518 boolean isEchoCancellationEnabled();
520 * Get echo limiter status (another method of doing echo suppressionn, more brute force)
521 * @return true if echo limiter is enabled
523 boolean isEchoLimiterEnabled();
525 * @param transports used for signaling (TCP, UDP and TLS)
527 void setSignalingTransportPorts(Transports transports);
529 * @return transports used for signaling (TCP, UDP, TLS)
531 Transports getSignalingTransportPorts();
536 void enableSpeaker(boolean value);
541 boolean isSpeakerEnabled();
543 * add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
544 * @param lf LinphoenFriend to add
545 * @throws LinphoneCoreException
547 void addFriend(LinphoneFriend lf) throws LinphoneCoreException;
550 * Set my presence status
551 * @param minute_away how long in away
552 * @param status sip uri used to redirect call in state LinphoneStatusMoved
554 void setPresenceInfo(int minute_away,String alternative_contact, OnlineStatus status);
556 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
557 * @param to destination address for messages
559 * @return {@link LinphoneChatRoom} where messaging can take place.
561 LinphoneChatRoom createChatRoom(String to);
563 void setVideoWindow(Object w);
564 void setPreviewWindow(Object w);
565 void setDeviceRotation(int rotation);
567 void setVideoDevice(int id);
568 int getVideoDevice();
571 * Enables video globally.
574 * This function does not have any effect during calls. It just indicates #LinphoneCore to
575 * initiate future calls with video or not. The two boolean parameters indicate in which
576 * direction video is enabled. Setting both to false disables video entirely.
578 * @param vcap_enabled indicates whether video capture is enabled
579 * @param display_enabled indicates whether video display should be shown
582 void enableVideo(boolean vcap_enabled, boolean display_enabled);
584 * Returns TRUE if video is enabled, FALSE otherwise.
587 boolean isVideoEnabled();
590 * Specify a STUN server to help firewall traversal.
591 * @param stun_server Stun server address and port, such as stun.linphone.org or stun.linphone.org:3478
593 void setStunServer(String stun_server);
595 * @return stun server address if previously set.
597 String getStunServer();
600 * Sets policy regarding workarounding NATs
601 * @param pol one of the FirewallPolicy members.
603 void setFirewallPolicy(FirewallPolicy pol);
605 * @return previously set firewall policy.
607 FirewallPolicy getFirewallPolicy();
609 LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException ;
611 int updateCall(LinphoneCall call, LinphoneCallParams params);
613 LinphoneCallParams createDefaultCallParameters();
616 * Sets the path to a wav file used for ringing.
618 * @param path The file must be a wav 16bit linear. Local ring is disabled if null
620 void setRing(String path);
622 * gets the path to a wav file used for ringing.
624 * @param null if not set
629 * Sets file or folder containing trusted root CAs
631 * @param path path to file with multiple PEM certif or to folder with multiple PEM files
633 void setRootCA(String path);
635 void setUploadBandwidth(int bw);
637 void setDownloadBandwidth(int bw);
640 * Sets audio packetization interval suggested for remote end.
641 * @param ptime packetization interval in milliseconds
643 void setDownloadPtime(int ptime);
646 * Sets audio packetization interval sent to remote end.
647 * @param ptime packetization interval in milliseconds
649 void setUploadPtime(int ptime);
651 void setPreferredVideoSize(VideoSize vSize);
653 VideoSize getPreferredVideoSize();
656 * Returns the currently supported audio codecs, as PayloadType elements
659 PayloadType[] getAudioCodecs();
661 * Returns the currently supported video codecs, as PayloadType elements
664 PayloadType[] getVideoCodecs();
666 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
668 void enableKeepAlive(boolean enable);
670 * get keep elive mode
671 * @return true if enable
673 boolean isKeepAliveEnabled();
675 * Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
676 * status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
678 * @throws LinphoneCoreException if operation is still in progress;
680 void startEchoCalibration(Object data) throws LinphoneCoreException;
682 void enableIpv6(boolean enable);
687 void adjustSoftwareVolume(int i);
689 boolean pauseCall(LinphoneCall call);
690 boolean resumeCall(LinphoneCall call);
691 boolean pauseAllCalls();
693 void setZrtpSecretsCache(String file);
694 void enableEchoLimiter(boolean val);
696 boolean isInConference();
697 boolean enterConference();
698 void leaveConference();
700 void addToConference(LinphoneCall call);
701 void addAllToConference();
702 void removeFromConference(LinphoneCall call);
704 void terminateConference();
705 int getConferenceSize();
707 void terminateAllCalls();
708 LinphoneCall[] getCalls();
712 void transferCall(LinphoneCall call, String referTo);
713 void transferCallToAnother(LinphoneCall callToTransfer, LinphoneCall destination);
715 LinphoneCall findCallFromUri(String uri);
718 void setMaxCalls(int max);
719 boolean isMyself(String uri);
722 * Use this method to check the calls state and forbid proposing actions
723 * which could result in an active call.
724 * Eg: don't start a new call if one is in outgoing ringing.
725 * Eg: don't merge to conference either as it could result
726 * in two active calls (conference and accepted call).
729 boolean soundResourcesLocked();
731 * Returns whether given media encryption is supported by liblinphone.
733 boolean mediaEncryptionSupported(MediaEncryption menc);
735 * set media encryption (rtp) to use
736 * @params menc: MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
738 void setMediaEncryption(MediaEncryption menc);
740 * return selected media encryption
741 * @return MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
743 MediaEncryption getMediaEncryption();
745 * Set media encryption required for outgoing calls
747 void setMediaEncryptionMandatory(boolean yesno);
749 * @return if media encryption is required for outgoing calls
751 boolean isMediaEncryptionMandatory();
754 * @param path path to music file played to remote side when on hold.
756 void setPlayFile(String path);
757 void tunnelEnable(boolean enable);
758 void tunnelAutoDetect();
759 void tunnelCleanServers();
760 void tunnelSetHttpProxy(String proxy_host, int port, String username, String password);
762 * @param host tunnel server ip address
763 * @param port tunnel server tls port, recommended value is 443
764 * @param udpMirrorPort remote port on the tunnel server side used to test udp reachability
765 * @param roundTripDelay udp packet round trip delay in ms considered as acceptable. recommended value is 1000 ms
767 void tunnelAddServerAndMirror(String host, int port, int udpMirrorPort, int roundTripDelay);
769 boolean isTunnelAvailable();
771 LinphoneProxyConfig[] getProxyConfigList();
773 void setVideoPolicy(boolean autoInitiate, boolean autoAccept);
775 void setUserAgent(String name, String version);
777 void setCpuCount(int count);
782 public void removeCallLog(LinphoneCallLog log);
785 * @return count of missed calls
787 public int getMissedCallsCount();
790 * Set missed calls count to zero
792 public void resetMissedCallsCount();
794 * re-initiates registration if network is up.
796 public void refreshRegisters();
799 * return the version code of linphone core
801 public String getVersion();
804 * remove a linphone friend from linphone core and linphonerc
806 void removeFriend(LinphoneFriend lf);
809 * return a linphone friend (if exists) that matches the sip address
811 LinphoneFriend findFriendByAddress(String sipUri);
814 * Sets the UDP port used for audio streaming.
816 void setAudioPort(int port);
819 * Sets the UDP port range from which to randomly select the port used for audio streaming.
821 void setAudioPortRange(int minPort, int maxPort);
824 * Sets the UDP port used for video streaming.
826 void setVideoPort(int port);
829 * Sets the UDP port range from which to randomly select the port used for video streaming.
831 void setVideoPortRange(int minPort, int maxPort);
834 * Set the incoming call timeout in seconds.
835 * If an incoming call isn't answered for this timeout period, it is
836 * automatically declined.
838 void setIncomingTimeout(int timeout);