witine/linphone-ios
1
0
Fork 0
forked from mirrors/linphone-iphone
Code Pull requests Activity

Fix all JavaDoc errors

Browse source
This commit is contained in:
François Grisez 2016-09-30 11:56:19 +02:00
parent cdf31df81e
commit 68b6f0b2f2
22 changed files with 204 additions and 220 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
java/common/org/linphone/core/LinphoneAddress.java
View file

@ -24,7 +24,7 @@ import java.util.Vector;
* Object that represents a SIP address.
* The LinphoneAddress is an opaque object to represents SIP addresses, ie the content of SIP's 'from' and 'to' headers.
* A SIP address is made of display name, username, domain name, port, and various uri headers (such as tags).
* It looks like 'Alice <sip:alice@example.net>'. The LinphoneAddress has methods to extract and manipulate all parts of the address.
* It looks like 'Alice &lt;sip:alice@example.net&gt;'. The LinphoneAddress has methods to extract and manipulate all parts of the address.
* When some part of the address (for example the username) is empty, the accessor methods return null.
* <br> Can be instanciated using both {@link LinphoneCoreFactory#createLinphoneAddress(String, String, String)} or {@link LinphoneCoreFactory#createLinphoneAddress(String)}
* @author jehanmonnier

21
java/common/org/linphone/core/LinphoneAuthInfo.java
View file

@ -20,17 +20,16 @@ package org.linphone.core;
/**
* Object holding authentication information.
* In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.
*<br>This object is instantiated using either {@link LinphoneCoreFactory#createAuthInfo(String, String, String)} or {@link LinphoneCoreFactory#createAuthInfo(String, String, String, String, String)}.
*<br>
*Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in order to become known and used automatically when needed.
*Use {@link LinphoneCore#addAuthInfo(LinphoneAuthInfo)} for that purpose.
*<br>
*The LinphoneCore object can take the initiative to request authentication information when needed to the application
*through the {@link LinphoneCoreListener#authInfoRequested(LinphoneCore, String, String)} listener.
*<br>
*The application can respond to this information request later using {@link LinphoneCore#addAuthInfo(LinphoneAuthInfo)}.
*This will unblock all pending authentication transactions and retry them with authentication headers.
*
* <br>This object is instantiated using either {@link LinphoneCoreFactory#createAuthInfo(String, String, String, String)} or {@link LinphoneCoreFactory#createAuthInfo(String, String, String, String, String, String)}.
* <br>
* Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in order to become known and used automatically when needed.
* Use {@link LinphoneCore#addAuthInfo(LinphoneAuthInfo)} for that purpose.
* <br>
* The LinphoneCore object can take the initiative to request authentication information when needed to the application
* through the {@link LinphoneCoreListener#authInfoRequested(LinphoneCore, String, String, String)} listener.
* <br>
* The application can respond to this information request later using {@link LinphoneCore#addAuthInfo(LinphoneAuthInfo)}.
* This will unblock all pending authentication transactions and retry them with authentication headers.
*/
public interface LinphoneAuthInfo {
/**

4
java/common/org/linphone/core/LinphoneCall.java
View file

@ -172,7 +172,7 @@ public interface LinphoneCall {
CallDirection getDirection();
/**
* get the call log associated to this call.
* @Return LinphoneCallLog
* @return LinphoneCallLog
**/
LinphoneCallLog getCallLog();
@ -250,7 +250,7 @@ public interface LinphoneCall {
* 1-2 = very poor quality <br>
* 0-1 = can't be worse, mostly unusable <br>
*
* @returns The function returns -1 if no quality measurement is available, for example if no
* @return The function returns -1 if no quality measurement is available, for example if no
* active audio stream exist. Otherwise it returns the quality rating.
*/
float getCurrentQuality();

9
java/common/org/linphone/core/LinphoneCallParams.java
View file

@ -44,7 +44,7 @@ public interface LinphoneCallParams {
MediaEncryption getMediaEncryption();
/**
* set media encryption (rtp) to use
* @params menc: MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
* @param menc MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
*/
void setMediaEnctyption(MediaEncryption menc);
@ -94,7 +94,6 @@ public interface LinphoneCallParams {
/**
* Returns the value of a custom header given its name.
* If no header with that name exists, then null is returned.
* @param name
* @return value for the header, or null if it doesn't exist.
*/
String getCustomHeader(String name);
@ -210,7 +209,7 @@ public interface LinphoneCallParams {
void enableRealTimeText(boolean yesno);
/**
* Use to get real time text following rfc4103.
* @returns returns true if call rtt is activated.
* @return returns true if call rtt is activated.
**/
boolean realTimeTextEnabled();
@ -228,13 +227,13 @@ public interface LinphoneCallParams {
/**
* Set the audio stream direction.
* @param The audio stream direction associated with this call params.
* @param dir The audio stream direction associated with this call params.
**/
void setAudioDirection(MediaDirection dir);
/**
* Set the video stream direction.
* @param The video stream direction associated with this call params.
* @param dir The video stream direction associated with this call params.
**/
void setVideoDirection(MediaDirection dir);
}

6
java/common/org/linphone/core/LinphoneChatMessage.java
View file

@ -119,22 +119,18 @@ public interface LinphoneChatMessage {
/**
* Linphone message can carry external body as defined by rfc2017
* @param message #LinphoneChatMessage
* @return return external body url null if not present.
*/
String getExternalBodyUrl();
/**
* Linphone message can carry external body as defined by rfc2017
* @param #LinphoneChatMessage
* @param url ex: access-type=URL; URL="http://www.foo.com/file"
*/
void setExternalBodyUrl(String url);
/**
* Add a custom header into the message.
* @param name
* @param value
*/
void addCustomHeader(String name, String value);
@ -231,7 +227,7 @@ public interface LinphoneChatMessage {
* Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140
* To commit a message, use #linphone_chat_room_send_message
* @param character T.140 char
* @throw LinphoneCoreExeption .
* @throws LinphoneCoreException
*/
void putChar(long character) throws LinphoneCoreException;

7
java/common/org/linphone/core/LinphoneChatRoom.java
View file

@ -42,14 +42,13 @@ public interface LinphoneChatRoom {
/**
* Send a message to peer member of this chat room.
* @param chat message
* @param message chat message
*/
@Deprecated
void sendMessage(LinphoneChatMessage message, LinphoneChatMessage.StateListener listener);
/**
* Create a LinphoneChatMessage
* @param chatRoom chat room associated to the message
* @param message message to send
* @return LinphoneChatMessage object
*/
@ -143,13 +142,13 @@ public interface LinphoneChatRoom {
/**
* get Curent Call associated to this chatroom if any
* To commit a message, use #linphone_chat_room_send_message
* @returns LinphoneCall or NULL.
* @return LinphoneCall or NULL.
*/
public LinphoneCall getCall();
/**
* When realtime text is enabled LinphoneCallParams.realTimeTextEnabled, LinphoneCoreListener.isComposingReceived is call every time a char is received from peer.
* At the end of remote typing a regular LinphoneChatMessage is received with committed data from LinphoneCoreListener.messageReceived .
* @returns RFC 4103/T.140 char
* @return RFC 4103/T.140 char
*/
long getChar();

190
java/common/org/linphone/core/LinphoneCore.java
View file

@ -27,7 +27,7 @@ import org.linphone.mediastream.video.capture.hwconf.AndroidCameraConfiguration;
import android.view.SurfaceView;
/**
* Linphone core main object created by method {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object)}.
* Linphone core main object created by method {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object, Object)}.
*
*/
@ -224,7 +224,6 @@ public interface LinphoneCore {
/**
* Linphone core SIP transport ports.
* Use with {@link LinphoneCore#setSignalingTransportPorts(Transports)}
* @ingroup initializing
*/
static public class Transports {
/**
@ -661,7 +660,6 @@ public interface LinphoneCore {
/**
* Sets the default proxy.
*<br>
* This default proxy must be part of the list of already entered {@link LinphoneProxyConfig}.
* Toggling it as default will make LinphoneCore favor the identity associated with the proxy configuration in all incoming and outgoing calls.
* Better proxy configuration match may override this choice. Pass null to unset the default proxy.
@ -696,7 +694,7 @@ public interface LinphoneCore {
void clearAuthInfos();
/**
* Adds authentication information to the LinphoneCore.
* <br>This information will be used during all SIP transacations that require authentication.
* This information will be used during all SIP transacations that require authentication.
* @param info
*/
void addAuthInfo(LinphoneAuthInfo info);
@ -705,18 +703,18 @@ public interface LinphoneCore {
* Build an address according to the current proxy config. In case destination is not a sip address, the default proxy domain is automatically appended
* @param destination
* @return
* @throws If no LinphoneAddress can be built from destination
* @throws LinphoneCoreException if no LinphoneAddress can be built from destination
*/
public LinphoneAddress interpretUrl(String destination) throws LinphoneCoreException;
/**
* Starts a call given a destination. Internally calls {@link #interpretUrl(String)} then {@link #invite(LinphoneAddress)}.
* @param uri
* @param destination
*/
public LinphoneCall invite(String destination)throws LinphoneCoreException;
/**
* Initiates an outgoing call given a destination LinphoneAddress
*<br>The LinphoneAddress can be constructed directly using {@link LinphoneCoreFactory#createLinphoneAddress} , or created {@link LinphoneCore#interpretUrl(String)}. .
* The LinphoneAddress can be constructed directly using {@link LinphoneCoreFactory#createLinphoneAddress} , or created {@link LinphoneCore#interpretUrl(String)}. .
* @param to the destination of the call (sip address).
* @return linphone call
* @throws LinphoneCoreException if linphone call cannot be created
@ -756,12 +754,13 @@ public interface LinphoneCore {
public boolean isInComingInvitePending();
/**
* Main loop function. It is crucial that your application call it periodically.
*
* #iterate() performs various backgrounds tasks:
* <li>receiving of SIP messages
* <li> handles timers and timeout
* <li> performs registration to proxies
* <li> authentication retries The application MUST call this function from periodically, in its main loop.
* #iterate() performs various backgrounds tasks:
* <ul>
* <li>receiving of SIP messages</li>
* <li> handles timers and timeout</li>
* <li> performs registration to proxies</li>
* <li> authentication retries The application MUST call this function from periodically, in its main loop.</li>
* </ul>
* <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.
*/
@ -841,7 +840,7 @@ public interface LinphoneCore {
public void destroy();
/**
* Allow to control play level before entering sound card:
* @param level in db
* @param gain in db
*/
public void setPlaybackGain(float gain);
/**
@ -1024,7 +1023,7 @@ public interface LinphoneCore {
boolean isEchoLimiterEnabled();
/**
* Set transport ports linphone core will listen on
* @param local transports ports used for signaling (TCP, UDP and TLS)
* @param transports transports ports used for signaling (TCP, UDP and TLS)
*/
void setSignalingTransportPorts(Transports transports);
/**Get
@ -1042,13 +1041,12 @@ public interface LinphoneCore {
/**
* Set the timeout in milliseconds for SIP transport (TCP or TLS connection establishment maximum time).
* @param timeout_ms
**/
*/
void setSipTransportTimeout(int timeout_ms);
/**
* Get the current SIP transport timeout.
* @param timeout_ms
**/
*/
int getSipTransportTimeout();
/**
@ -1142,46 +1140,43 @@ public interface LinphoneCore {
/**
* Set the native video window id where the video is to be displayed.
* On Android, it must be of type {@link AndroidVideoWindowImpl}
* @param video window of type {@link AndroidVideoWindowImpl}
**/
* @param w window of type {@link AndroidVideoWindowImpl}
*/
void setVideoWindow(Object w);
/**
* Set the native video window id where the video preview is to be displayed.
* On Android, it must of type {@link SurfaceView}
* @param video window of type {@link SurfaceView}
**/
* On Android, it must of type android.view.SurfaceView
* @param w window of type android.view.SurfaceView
*/
void setPreviewWindow(Object w);
/**
* Tells the core the device current orientation. This can be used by capture filters
* on mobile devices to select between portrait/landscape mode and to produce properly
* oriented images. The exact meaning of the value in rotation if left to each device
* specific implementations.
*@param rotation . Android supported values are 0, 90, 180 and 270.
*
**/
* @param rotation Android supported values are 0, 90, 180 and 270.
*/
void setDeviceRotation(int rotation);
/**
* Sets the active video device.
*
* @param id of the video device as returned by {@link AndroidCameraConfiguration#retrieveCameras}
**/
*/
void setVideoDevice(int id);
/**
* Returns the id of the currently active video device as found in {@link AndroidCameraConfiguration#retrieveCameras}.
**/
*/
int getVideoDevice();
/**
* Returns true if the underlying sdk support video
*
* */
*/
boolean isVideoSupported();
/**
* Returns true if the underlying sdk support vCards
*
* */
*/
boolean isVCardSupported();
/**
@ -1195,13 +1190,13 @@ public interface LinphoneCore {
* @param vcap_enabled indicates whether video capture is enabled
* @param display_enabled indicates whether video display should be shown
*
**/
*/
void enableVideo(boolean vcap_enabled, boolean display_enabled);
/**
* Returns TRUE if video is enabled, FALSE otherwise.
*
***/
*/
boolean isVideoEnabled();
/**
@ -1220,7 +1215,7 @@ public interface LinphoneCore {
* Sets policy regarding workarounding NATs
* @param pol one of the FirewallPolicy members.
* @deprecated
**/
*/
void setFirewallPolicy(FirewallPolicy pol);
/**
@ -1252,12 +1247,12 @@ public interface LinphoneCore {
/**
* Initiates an outgoing call given a destination LinphoneAddress
*
* @param addr the destination of the call {@link #LinphoneAddress }.
* @param params call parameters {@link #LinphoneCallParams }
* @param destination the destination of the call {@link LinphoneAddress}.
* @param params call parameters {@link LinphoneCallParams}
*
*<br>The LinphoneAddress can be constructed directly using {@link LinphoneCoreFactory#createLinphoneAddress} , or created {@link LinphoneCore#interpretUrl(String)}.
* <br>The LinphoneAddress can be constructed directly using {@link LinphoneCoreFactory#createLinphoneAddress} , or created {@link LinphoneCore#interpretUrl(String)}.
*
* @return a {@link #LinphoneCall LinphoneCall} object
* @return a {@link LinphoneCall} object
* @throws LinphoneCoreException in case of failure
**/
LinphoneCall inviteAddressWithParams(LinphoneAddress destination, LinphoneCallParams params) throws LinphoneCoreException;
@ -1266,7 +1261,7 @@ public interface LinphoneCore {
* Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore.
*
* In this version this is limited to the following use cases:
* - setting up/down the video stream according to the video parameter of the {@link LinphoneCallParams} (see {@link LinphoneCallParams#enableVideo} ).
* - setting up/down the video stream according to the video parameter of the {@link LinphoneCallParams} (see {@link LinphoneCallParams#setVideoEnabled(boolean)} ).
* - changing the size of the transmitted video after calling {@link LinphoneCore#setPreferredVideoSize(VideoSize)}
*
* In case no changes are requested through the {@link LinphoneCallParams} argument, then this argument can be omitted and set to null.
@ -1341,7 +1336,7 @@ public interface LinphoneCore {
* This is IP bandwidth, in kbit/s.
* This information is used signaled to other parties during
* calls (within SDP messages) so that the remote end can have
* sufficient knowledge to properly configure its audio & video
* sufficient knowledge to properly configure its audio &amp; video
* codec output bitrate to not overflow available bandwidth.
*
* @param bw the bandwidth in kbits/s, 0 for infinite
@ -1428,10 +1423,10 @@ public interface LinphoneCore {
boolean isKeepAliveEnabled();
/**
* Start an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
* status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(EcCalibratorStatus, int, Object)}
* Status is notified to {@link LinphoneCoreListener#ecCalibrationStatus(LinphoneCore, EcCalibratorStatus, int, Object)}
* @param listener the LinphoneEchoCalibrationListener to call when the calibration is done
* @throws LinphoneCoreException if operation is still in progress;
**/
*/
void startEchoCalibration(LinphoneCoreListener listener) throws LinphoneCoreException;
/**
@ -1448,7 +1443,7 @@ public interface LinphoneCore {
/**
* Start the speaker and the micro to test the echo
* @param bitrate
* @param rate
* @return the status
*/
int startEchoTester(int rate);
@ -1517,8 +1512,8 @@ public interface LinphoneCore {
* However, by calling {@link #leaveConference()} and {@link #enterConference()} the application can decide to temporarily
* move out and in the local participant from the conference.
*
* @returns true if successful
**/
* @return true if successful
*/
boolean enterConference();
/**
* Moves the local participant out of the conference.
@ -1537,7 +1532,6 @@ public interface LinphoneCore {
void addToConference(LinphoneCall call);
/**
* Remove a call from the conference.
* @param call a call that has been previously merged into the conference.
*
* After removing the remote participant belonging to the supplied call, the call becomes a normal call in paused state.
* If one single remote participant is left alone together with the local user in the conference after the removal, then the conference is
@ -1547,31 +1541,26 @@ public interface LinphoneCore {
* In other words, unless {@link #leaveConference()} is explicitely called, the last remote participant of a conference is automatically
* put in a simple call in running state.
*
**/
* @param call a call that has been previously merged into the conference.
*/
void removeFromConference(LinphoneCall call);
/**
* Add all calls into a conference.
*
* Merge all established calls (either in {@link LinphoneCall.State#StreamsRunning} or {@link LinphoneCall.State#Paused}) into a conference.
*
**/
*/
void addAllToConference();
/**
* Terminates the conference and the calls associated with it.
*
* All the calls that were merged to the conference are terminated, and the conference resources are destroyed.
*
**/
*/
void terminateConference();
/**
* Returns the number of participants to the conference, including the local participant.
*
* Typically, after merging two calls into the conference, there is total of 3 participants:
* the local participant (or local user), and two remote participants that were the destinations of the two previously establised calls.
*
* @returns the number of participants to the conference
**/
* @return the number of participants to the conference
*/
int getConferenceSize();
/**
@ -1592,12 +1581,12 @@ public interface LinphoneCore {
/**
* Returns all calls.
* @return an array with all call currently handle by Linphone core
**/
*/
LinphoneCall[] getCalls();
/**
* Get number of calls currently handled by Linphone core
* @returns number of calls
* */
* @return number of calls
*/
int getCallsNb();
/**
@ -1614,9 +1603,9 @@ public interface LinphoneCore {
* This method will send a transfer request to the transfered person. The phone of the transfered is then
* expected to automatically call to the destination of the transfer. The receiver of the transfer will then automatically
* close the call with us (the 'dest' call).
* @param call a running call you want to transfer
* @param dest a running call whose remote person will receive the transfer
**/
* @param callToTransfer a running call you want to transfer
* @param destination a running call whose remote person will receive the transfer
*/
void transferCallToAnother(LinphoneCall callToTransfer, LinphoneCall destination);
/**
@ -1666,7 +1655,7 @@ public interface LinphoneCore {
boolean mediaEncryptionSupported(MediaEncryption menc);
/**
* set media encryption (rtp) to use
* @params menc: MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
* @param menc MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
*/
void setMediaEncryption(MediaEncryption menc);
/**
@ -1674,7 +1663,7 @@ public interface LinphoneCore {
* @return MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP
*/
MediaEncryption getMediaEncryption();
/**
/**
* Set media encryption required for outgoing calls
*/
void setMediaEncryptionMandatory(boolean yesno);
@ -1814,8 +1803,8 @@ public interface LinphoneCore {
void setStaticPicture(String path);
/**
* Sets the user agent string used in SIP messages.
* @param user agent name
* @param user agent version
* @param name user agent name
* @param version user agent version
**/
void setUserAgent(String name, String version);
/**
@ -1999,7 +1988,7 @@ public interface LinphoneCore {
/**
* Create an empty INFO message.
* It can later be sent using {@link LinphoneCall.sendInfoMessage() }.
* It can later be sent using {@link LinphoneCall#sendInfoMessage(LinphoneInfoMessage)}.
* @return the new info message.
*/
public LinphoneInfoMessage createInfoMessage();
@ -2023,7 +2012,6 @@ public interface LinphoneCore {
* @param resource the destination resource
* @param event the event name
* @param expires the whished duration of the subscription
* @param body an optional body, may be NULL.
* @return a LinphoneEvent holding the context of the created subcription.
*/
public LinphoneEvent createSubscribe(LinphoneAddress resource, String event, int expires);
@ -2082,11 +2070,11 @@ public interface LinphoneCore {
/**
* Migrate configuration so that all SIP transports are enabled.
* Versions of linphone < 3.7 did not support using multiple SIP transport simultaneously.
* Versions of linphone &lt; 3.7 did not support using multiple SIP transport simultaneously.
* This function helps application to migrate the configuration so that all transports are enabled.
* Existing proxy configuration are added a transport parameter so that they continue using the unique transport that was set previously.
* This function must be used just after creating the core, before any call to linphone_core_iterate()
* @returns 1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
* @return 1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
*/
public int migrateToMultiTransport();
@ -2097,12 +2085,10 @@ public interface LinphoneCore {
/**
* When receiving an incoming, accept to start a media session as early-media.
* This means the call is not accepted but audio & video streams can be established if the remote party supports early media.
* However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio & video are played normally.
* This means the call is not accepted but audio &amp; video streams can be established if the remote party supports early media.
* However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio &amp; video are played normally.
* The call can then later be fully accepted using linphone_core_accept_call() or linphone_core_accept_call_with_params().
* @param lc the linphonecore
* @param call the call
* @param params the call params, can be NULL.
* @return true if successful, false otherwise.
*/
public boolean acceptEarlyMedia(LinphoneCall call);
@ -2110,9 +2096,8 @@ public interface LinphoneCore {
/**
* Accept an early media session for an incoming call.
* This is identical as calling linphone_core_accept_early_media_with_params() with NULL call parameters.
* @see linphone_core_accept_early_media_with_params()
* @param call the incoming call
* @param params
* @param params the call params, can be NULL.
* @return true if successful, false otherwise.
*/
public boolean acceptEarlyMediaWithParams(LinphoneCall call, LinphoneCallParams params);
@ -2135,7 +2120,7 @@ public interface LinphoneCore {
* Assign an audio file to be played locally in replacement of common telephony tone.
* This is typically used to internationalize tones.
* @param id a tone id
* @param wav a path to a 16 bit PCM linear wav file.
* @param wavfile a path to a 16 bit PCM linear wav file.
*/
public void setTone(ToneID id, String wavfile);
@ -2164,16 +2149,14 @@ public interface LinphoneCore {
/**
* Inconditionnaly disable incoming chat messages.
* @param lc the core
* @param deny_reason the deny reason (using ReasonNone has no effect).
**/
* @param denycode the deny reason (using ReasonNone has no effect).
*/
public void disableChat(Reason denycode);
/**
* Enable reception of incoming chat messages.
* By default it is enabled but it can be disabled with linphone_core_disable_chat().
* @param lc the core
**/
*/
public void enableChat();
@ -2261,14 +2244,13 @@ public interface LinphoneCore {
/**
* Use to set multicast address to be used for audio stream.
* @param ip an ipv4/6 multicast address
* @return
* @thow LinphoneCoreException
**/
* @throws LinphoneCoreException
*/
public void setAudioMulticastAddr(String ip) throws LinphoneCoreException;
/**
* Use to set multicast address to be used for video stream.
* @param ip an ipv4/6 multicast address
* @thow LinphoneCoreException
* @throws LinphoneCoreException
**/
public void setVideoMulticastAddr(String ip) throws LinphoneCoreException;
@ -2287,56 +2269,54 @@ public interface LinphoneCore {
/**
* Use to set multicast ttl to be used for audio stream.
* @param ttl value or -1 if not used. [0..255] default value is 1
* @thow LinphoneCoreException
* @throws LinphoneCoreException
**/
public void setAudioMulticastTtl(int ttl) throws LinphoneCoreException;
/**
* Use to set multicast ttl to be used for video stream.
* @param ttl value or -1 if not used. [0..255] default value is 1
* @thow LinphoneCoreException
* @throws LinphoneCoreException
**/
public void setVideoMulticastTtl(int ttl) throws LinphoneCoreException;
/**
* Use to get multicast ttl to be used for audio stream.
* @return a time to leave value
* @thow LinphoneCoreException
* **/
*/
public int getAudioMulticastTtl();
/**
* Use to get multicast ttl to be used for video stream.
* @return a time to leave value
* @thow LinphoneCoreException
**/
*/
public int getVideoMulticastTtl();
/**
* Use to enable multicast rtp for audio stream.
* * If enabled, outgoing calls put a multicast address from {@link linphone_core_get_video_multicast_addr} into audio cline. In case of outgoing call audio stream is sent to this multicast address.
* If enabled, outgoing calls put a multicast address from {@link getAudioMulticastAddr()} into audio cline. In case of outgoing call audio stream is sent to this multicast address.
* <br> For incoming calls behavior is unchanged.
* @param yesno if yes, subsequent calls will propose multicast ip set by {@link linphone_core_set_audio_multicast_addr}
**/
* @param yesno if yes, subsequent calls will propose multicast ip set by {@link setAudioMulticastAddr(String)}
*/
public void enableAudioMulticast(boolean yesno);
/**
* Use to get multicast state of audio stream.
* @return true if subsequent calls will propose multicast ip set by {@link linphone_core_set_audio_multicast_addr}
**/
* @return true if subsequent calls will propose multicast ip set by {@link setAudioMulticastAddr(String)}
*/
public boolean audioMulticastEnabled();
/**
* Use to enable multicast rtp for video stream.
* If enabled, outgoing calls put a multicast address from {@link linphone_core_get_video_multicast_addr} into video cline. In case of outgoing call video stream is sent to this multicast address.
* If enabled, outgoing calls put a multicast address from {@link getVideoMulticastAddr()} into video cline. In case of outgoing call video stream is sent to this multicast address.
* <br> For incoming calls behavior is unchanged.
* @param yesno if yes, subsequent outgoing calls will propose multicast ip set by {@link linphone_core_set_video_multicast_addr}
**/
* @param yesno if yes, subsequent outgoing calls will propose multicast ip set by {@link setVideoMulticastAddr(String)}
*/
public void enableVideoMulticast(boolean yesno);
/**
* Use to get multicast state of video stream.
* @return true if subsequent calls will propose multicast ip set by {@link linphone_core_set_video_multicast_addr}
**/
* @return true if subsequent calls will propose multicast ip set by {@link setVideoMulticastAddr(String)}
*/
public boolean videoMulticastEnabled();
/**
@ -2353,14 +2333,12 @@ public interface LinphoneCore {
/**
* Set the video preset to be used for video calls.
* @param lc LinphoneCore object
* @param preset The name of the video preset to be used (can be null to use the default video preset).
*/
public void setVideoPreset(String preset);
/**
* Get the video preset used for video calls.
* @param lc LinphoneCore object
* @return The name of the video preset used for video calls (can be null if the default video preset is used).
*/
public String getVideoPreset();

11
java/common/org/linphone/core/LinphoneCoreFactory.java
View file

@ -32,7 +32,7 @@ abstract public class LinphoneCoreFactory {
static LinphoneCoreFactory theLinphoneCoreFactory;
/**
* Indicate the name of the class used by this factory
* @param pathName
* @param className
*/
public static void setFactoryClassName (String className) {
factoryName = className;
@ -51,11 +51,12 @@ abstract public class LinphoneCoreFactory {
return theLinphoneCoreFactory;
}
/**
* create {@link LinphoneAuthInfo}
* Create {@link LinphoneAuthInfo}
* @param username
* @param userid user id as set in auth header
* @param passwd
* */
* @param password
* @param realm
* @param domain
*/
abstract public LinphoneAuthInfo createAuthInfo(String username,String password, String realm, String domain);
/**
* create {@link LinphoneAuthInfo}

39
java/common/org/linphone/core/LinphoneCoreListener.java
View file

@ -112,20 +112,28 @@ public interface LinphoneCoreListener {
*/
void publishStateChanged(LinphoneCore lc, LinphoneEvent ev, PublishState state);
/**< @Deprecated Notifies the application that it should show up
* @return */
/**
* Notifies the application that it should show up
* @deprecated
*/
void show(LinphoneCore lc);
/**< @Deprecated Callback that notifies various events with human readable text.
* @return */
/**
* Callback that notifies various events with human readable text.
* @deprecated
*/
void displayStatus(LinphoneCore lc,String message);
/**< @Deprecated Callback to display a message to the user
* @return */
/**
* Callback to display a message to the user
* @deprecated
*/
void displayMessage(LinphoneCore lc,String message);
/** @Deprecated Callback to display a warning to the user
* @return */
/**
* Callback to display a warning to the user
* @deprecated
*/
void displayWarning(LinphoneCore lc,String message);
/**
@ -158,10 +166,10 @@ public interface LinphoneCoreListener {
*/
int fileTransferSend(LinphoneCore lc, LinphoneChatMessage message, LinphoneContent content, ByteBuffer buffer, int size);
/** General State notification
/**
* General State notification
* @param state LinphoneCore.State
* @return
* */
*/
void globalState(LinphoneCore lc,LinphoneCore.GlobalState state, String message);
/**
@ -180,16 +188,15 @@ public interface LinphoneCoreListener {
/**
* invoked when a new linphone chat message is received
* @param lc LinphoneCore
* @param room LinphoneChatRoom involved in this conversation. Can be be created by the framework in case the from is not present in any chat room.
* @param message incoming linphone chat message message
* @param cr LinphoneChatRoom involved in this conversation. Can be be created by the framework in case the from is not present in any chat room.
* @param message incoming linphone chat message message
*/
void messageReceived(LinphoneCore lc, LinphoneChatRoom cr, LinphoneChatMessage message);
/** Call State notification
* @param state LinphoneCall.State
* @return
* */
*/
void callState(LinphoneCore lc, LinphoneCall call, LinphoneCall.State state, String message);
/**
@ -211,7 +218,7 @@ public interface LinphoneCoreListener {
/**
* invoked when a composing notification is received
* @param lc LinphoneCore
* @param room LinphoneChatRoom involved in the conversation.
* @param cr LinphoneChatRoom involved in the conversation.
*/
void isComposingReceived(LinphoneCore lc, LinphoneChatRoom cr);

9
java/common/org/linphone/core/LinphoneEvent.java
View file

@ -1,5 +1,8 @@
package org.linphone.core;
/**
* LinphoneEvent
*/
public interface LinphoneEvent {
/**
* Get the event name as standardized by the event package RFC.
@ -20,7 +23,7 @@ public interface LinphoneEvent {
SubscriptionState getSubscriptionState();
/**
* Accept an incoming subscription. After it is accepted the application can immediately start to send notifications with
* {@link LinphoneEvent.notify() }.
* {@link #notify(LinphoneContent) notify()}.
*/
void acceptSubscription();
@ -37,13 +40,13 @@ public interface LinphoneEvent {
void notify(LinphoneContent content);
/**
* Update a subscription initiated previously with {@link LinphoneCore.subscribe() }
* Update a subscription initiated previously with {@link LinphoneCore#subscribe(LinphoneAddress, String, int, LinphoneContent) LinphoneCore.subscribe()}
* @param content the data to be put in the subscribe request.
*/
void updateSubscribe(LinphoneContent content);
/**
* Update a Publish previously started with {@link LinphoneCore.publish() }.
* Update a Publish previously started with {@link LinphoneCore#publish(LinphoneAddress, String, int, LinphoneContent)}.
* @param content the data to be put in the publish request.
*/
void updatePublish(LinphoneContent content);

3
java/common/org/linphone/core/LinphoneFriend.java
View file

@ -31,8 +31,7 @@ import java.util.Vector;
public interface LinphoneFriend {
/**
* Enum controlling behavior for incoming subscription request.
* Use by {@link LinphoneFriend#setIncSubscribePolicy()}
*
* Used by {@link setIncSubscribePolicy(SubscribePolicy)}
*/
static class SubscribePolicy {

2
java/common/org/linphone/core/LinphoneInfoMessage.java
View file

@ -2,7 +2,7 @@ package org.linphone.core;
/**
* The LinphoneInfoMessage represents an informational message (INFO) to be transmitted or received by the LinphoneCore.
* It can be created with {@link LinphoneCore.createInfoMessage() }.
* It can be created with {@link LinphoneCore#createInfoMessage()}.
* @author smorlat
*
*/

30
java/common/org/linphone/core/LinphoneProxyConfig.java
View file

@ -19,9 +19,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
package org.linphone.core;
/**
* The LinphoneProxyConfig object represents a proxy configuration to be used by the LinphoneCore object. Its fields must not be used directly in favour of the accessors methods.
* Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with {@link LinphoneCore#addProxyConfig(LinphoneProxyConfig)}. This will automatically triggers the registration, if enabled.
*<br>The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object)} there might already be a default proxy that can be examined with {@link LinphoneCore#getDefaultProxyConfig()} .
*
* Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with {@link LinphoneCore#addProxyConfig(LinphoneProxyConfig)}. This will automatically triggers the registration, if enabled.<br>
* The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after {@link LinphoneCoreFactory#createLinphoneCore(LinphoneCoreListener, String, String, Object, Object)}
* there might already be a default proxy that can be examined with {@link LinphoneCore#getDefaultProxyConfig()} .
*/
public interface LinphoneProxyConfig {
@ -37,13 +37,13 @@ public interface LinphoneProxyConfig {
public void done();
/**
* Sets the user identity as a SIP address.
* @param identity This identity is normally formed with display name, username and domain, such as: Alice <sip:alice@example.net> The REGISTER messages will have from and to set to this identity.
* @param identity This identity is normally formed with display name, username and domain, such as: Alice &lt;sip:alice@example.net&gt; The REGISTER messages will have from and to set to this identity.
*/
public void setIdentity(String identity) throws LinphoneCoreException;
/**
*get the SIP identity that belongs to this proxy configuration.
*
* @return The SIP identity is a SIP address (Display Name <sip:username> )
* @return The SIP identity is a SIP address (Display Name &lt;sip:username&gt; )
*/
public String getIdentity();
/**
@ -60,9 +60,11 @@ public interface LinphoneProxyConfig {
/**
*Sets the proxy address
* Examples of valid sip proxy address are:
*<li>IP address: sip:87.98.157.38
*<li>IP address with port: sip:87.98.157.38:5062
*<li>hostnames : sip:sip.example.net
* <ul>
* <li>IP address: sip:87.98.157.38</li>
* <li>IP address with port: sip:87.98.157.38:5062</li>
* <li>hostnames : sip:sip.example.net</li>
* </ul>
* @param proxyUri
* @throws LinphoneCoreException
*/
@ -91,7 +93,7 @@ public interface LinphoneProxyConfig {
public String normalizePhoneNumber(String number);
/**
* Normalize a human readable sip uri into a fully qualified LinphoneAddress.
* A sip address should look like DisplayName \<sip:username\@domain:port\> .
* A sip address should look like DisplayName &lt;sip:username\@domain:port&gt;.
* @param username the string to parse
* @return NULL if invalid input, normalized sip address otherwise.
*/
@ -259,7 +261,7 @@ public interface LinphoneProxyConfig {
* @param contact_params a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else"
*
* The main use case for this function is provide the proxy additional information regarding the user agent, like for example unique identifier or android push id.
* As an example, the contact address in the SIP register sent will look like <sip:joe@15.128.128.93:50421>;android-push-id=43143-DFE23F-2323-FA2232.
* As an example, the contact address in the SIP register sent will look like &lt;sip:joe@15.128.128.93:50421&gt;;android-push-id=43143-DFE23F-2323-FA2232.
**/
public void setContactParameters(String contact_params);
@ -274,7 +276,7 @@ public interface LinphoneProxyConfig {
* @param params a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else"
*
* The main use case for this function is provide the proxy additional information regarding the user agent, like for example unique identifier or apple push id.
* As an example, the contact address in the SIP register sent will look like <sip:joe@15.128.128.93:50421;apple-push-id=43143-DFE23F-2323-FA2232>.
* As an example, the contact address in the SIP register sent will look like &lt;sip:joe@15.128.128.93:50421;apple-push-id=43143-DFE23F-2323-FA2232&gt;.
**/
public void setContactUriParameters(String params);
@ -338,15 +340,15 @@ public interface LinphoneProxyConfig {
/**
* Set a custom header
* @param a string containing the name of the header
* @param a string containing the value of the header
* @param name a string containing the name of the header
* @param value a string containing the value of the header
**/
public void setCustomHeader(String name, String value);
/**
* Return the value of a header
* @param name a string containing the name of the header
* @retur the value of the header
* @return the value of the header
**/
public String getCustomHeader(String name);

1
java/common/org/linphone/core/LpConfig.java
View file

@ -121,7 +121,6 @@ public interface LpConfig {
* Gets a int range from the config
* @param section the section in the lpconfig
* @param key the name of the setting
* @param defaultValue the default value if not set
* @return the value of the setting or the default value if not set
*/
int[] getIntRange(String section, String key, int defaultMin, int defaultMax);

24
java/common/org/linphone/core/OpenH264DownloadHelperListener.java
View file

@ -2,17 +2,17 @@ package org.linphone.core;
public interface OpenH264DownloadHelperListener {
/**
* Called at the beginning of download with current < max Called
* at each iteration of download Called at the ending of download
* with current > max
* @param current: Size of file already downloaded
* @param max: Size of file we want to download
*/
void OnProgress(int current, int max);
* Called at the beginning of download with current &lt; max Called
* at each iteration of download Called at the ending of download
* with current &gt; max
* @param current: Size of file already downloaded
* @param max: Size of file we want to download
*/
void OnProgress(int current, int max);
/**
* Called when we failed to download codec
* @param error: Error message
*/
void OnError(String error);
* Called when we failed to download codec
* @param error: Error message
*/
void OnError(String error);
}

6
java/common/org/linphone/core/PresenceActivity.java
View file

@ -35,8 +35,8 @@ public interface PresenceActivity {
/**
* Sets the type of activity of a presence activity.
* @param acttype The activity type to set for the activity.
* @return 0 if successful, a value < 0 in case of error.
* @param type The activity type to set for the activity.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setType(PresenceActivityType type);
@ -49,7 +49,7 @@ public interface PresenceActivity {
/**
* Sets the description of a presence activity.
* @param description An additional description of the activity. Can be null if no additional description is to be added.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setDescription(String description);

20
java/common/org/linphone/core/PresenceModel.java
View file

@ -30,7 +30,7 @@ public interface PresenceModel {
/**
* Sets the basic status of a presence model.
* @param basic_status The #BasicStatus to set for the #PresenceModel object.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setBasicStatus(PresenceBasicStatus basic_status);
@ -62,7 +62,7 @@ public interface PresenceModel {
* Sets the activity of a presence model (limits to only one activity).
* @param activity The #PresenceActivityType to set for the model.
* @param description An additional description of the activity to set for the model. Can be null if no additional description is to be added.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*
* WARNING: This method will modify the basic status of the model according to the activity being set.
* If you don't want the basic status to be modified automatically, you can use the combination of setBasicStatus(), clearActivities() and addActivity().
@ -85,13 +85,13 @@ public interface PresenceModel {
/**
* Adds an activity to a presence model.
* @param activity The #PresenceActivity to add to the model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addActivity(PresenceActivity activity);
/**
* Clears the activities of a presence model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearActivities();
@ -106,7 +106,7 @@ public interface PresenceModel {
* Adds a note to a presence model.
* @param note_content The note to be added to the presence model.
* @param lang The language of the note to be added. Can be null if no language is to be specified for the note.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*
* Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one.
*/
@ -114,7 +114,7 @@ public interface PresenceModel {
/**
* Clears all the notes of a presence model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearNotes();
@ -134,13 +134,13 @@ public interface PresenceModel {
/**
* Adds a service to a presence model.
* @param service The #PresenceService object to add to the model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addService(PresenceService service);
/**
* Clears the services of a presence model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearServices();
@ -160,13 +160,13 @@ public interface PresenceModel {
/**
* Adds a person to a presence model.
* @param person The #PresencePerson object to add to the model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addPerson(PresencePerson person);
/**
* Clears the persons of a presence model.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearPersons();

4
java/common/org/linphone/core/PresenceNote.java
View file

@ -30,7 +30,7 @@ public interface PresenceNote {
/**
* Sets the content of a presence note.
* @param content The content of the note.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setContent(String content);
@ -43,7 +43,7 @@ public interface PresenceNote {
/**
* Sets the language of a presence note.
* @param lang The language of the note.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setLang(String lang);

14
java/common/org/linphone/core/PresencePerson.java
View file

@ -30,7 +30,7 @@ public interface PresencePerson {
/**
* Sets the id of a presence person.
* @param id The id string to set. Can be null to generate it automatically.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setId(String id);
@ -50,13 +50,13 @@ public interface PresencePerson {
/**
* Adds an activity to a presence person.
* @param activity The #PresenceActivity object to add to the person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addActivity(PresenceActivity activity);
/**
* Clears the activities of a presence person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearActivities();
@ -76,13 +76,13 @@ public interface PresencePerson {
/**
* Adds a note to a presence person.
* @param note The #PresenceNote object to add to the person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addNote(PresenceNote note);
/**
* Clears the notes of a presence person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearNotes();
@ -102,13 +102,13 @@ public interface PresencePerson {
/**
* Adds an activities note to a presence person.
* @param note The #PresenceNote object to add to the person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addActivitiesNote(PresenceNote note);
/**
* Clears the activities notes of a presence person.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearActivitesNotes();

10
java/common/org/linphone/core/PresenceService.java
View file

@ -30,7 +30,7 @@ public interface PresenceService {
/**
* Sets the id of a presence service.
* @param id The id string to set. Can be null to generate it automatically.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setId(String id);
@ -43,7 +43,7 @@ public interface PresenceService {
/**
* Sets the basic status of a presence service.
* @param status The #PresenceBasicStatus to set for the #PresenceService object.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setBasicStatus(PresenceBasicStatus status);
@ -56,7 +56,7 @@ public interface PresenceService {
/**
* Sets the contact of a presence service.
* @param contact The contact string to set.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int setContact(String contact);
@ -76,13 +76,13 @@ public interface PresenceService {
/**
* Adds a note to a presence service.
* @param note The #PresenceNote object to add to the service.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int addNote(PresenceNote note);
/**
* Clears the notes of a presence service.
* @return 0 if successful, a value < 0 in case of error.
* @return 0 if successful, a value &lt; 0 in case of error.
*/
int clearNotes();

8
java/common/org/linphone/core/PublishState.java
View file

@ -14,12 +14,14 @@ public enum PublishState {
*/
Ok(2),
/**
* Publish encountered an error. {@link LinphoneEvent.getReason()} gives more information about failure.
* Publish encountered an error.
* {@link LinphoneEvent#getReason()} gives more information about failure.
*/
Error(3),
/**
* Publish is about to expire. Application can trigger a refresh by calling {@link LinphoneCore.updatePublish()}
* [sip]->refresh_generic_subscribe property is set to 0.
* Publish is about to expire.
* Application can trigger a refresh by calling {@link LinphoneEvent#updatePublish(LinphoneContent)}
* [sip]-&gt;refresh_generic_subscribe property is set to 0.
*/
Expiring(4),
/**

4
java/common/org/linphone/core/SubscriptionState.java
View file

@ -26,12 +26,12 @@ public enum SubscriptionState {
*/
Terminated(5),
/**
* Subscription encountered an error, indicated by { @link LinphoneEvent.getReason() }
* Subscription encountered an error, indicated by {@link LinphoneEvent#getReason()}
*/
Error(6),
/**
* Subscription is about to expire, only notified if [sip]->refresh_generic_subscribe property is set to 0
* Subscription is about to expire, only notified if [sip]-&lt;refresh_generic_subscribe property is set to 0
*/
Expiring(7);
protected final int mValue;