public class Configuration
extends java.lang.Object
To access any configuration items (for example username attribute):
String username = ConfigurationService.getInstance().getUsername();
ConfigurationService.getInstance().setUsername("username value");
Constructor and Description |
---|
Configuration() |
Modifier and Type | Method and Description |
---|---|
AudioCodecConfiguration |
getAudioOpusCodecConfigurations()
Gets the Opus audio codec configurations.
|
int |
getAuditFrequence()
This method returns the set time interval in seconds.
|
java.lang.String |
getAuthorizationName()
Gets Authorization Name of user.
|
java.lang.String |
getBearerToken()
Gets bearer token of the user
|
Constants.CertificateValues |
getCertificateValues() |
java.util.List<CodecToReplace> |
getCodecPayloadTypeSet()
Returns codecPayloadTypeSet.
|
int |
getDefaultCameraMode()
Returns the default camera mode.
|
java.lang.String |
getDefaultICEPassword()
Gets the default ice server password, this property is read only and set by registration service
|
java.lang.String |
getDefaultICEUsername()
Gets the default ice server username, this property is read only and set by registration service
|
int |
getDtmfToneDuration()
Returns duration value of DTMF tones im ms
|
boolean |
getForceDisableMediaOnHold() |
int |
getFps()
Gets the parameter for frame per second.
|
java.lang.String |
getHmacToken()
Gets hmac token of the user
|
int |
getICECollectionTimeout()
Returns timeout value of ICE Collection
|
ICEOptions |
getIceOption()
Gets ice option
|
ICEServers |
getICEServers()
Gets the user defined ICE servers array (including stun & turn)
|
static Configuration |
getInstance()
This method returns (creates if necessary) singleton instance of
Configuration class
|
LoggingInterface |
getLogger()
Gets LoggingInterface reference used by LogManager.
|
Constants.LogLevel |
getLogLevel()
Returns logLevel value of Mobile SDK
|
java.lang.String |
getNotificationChannelID() |
OrientationMode |
getOrientationMode()
Gets Orientation Mode
|
java.lang.String |
getPassword()
Gets password of user
|
CodecSet |
getPreferredCodecSet()
Returns preferred Codec Set
|
java.net.URL |
getPushServerURL()
Returns the push server URL
|
CallReceiveBandwidthLimit |
getReceiveBandwidthSetting() |
java.lang.String |
getRestServerIp()
Gets server IP information used in REST requests.
|
int |
getRestServerPort()
Gets server port information used in REST requests.
|
RingingFeedbackOptions |
getRingingFeedbackOption()
Gets ringingFeedbackOption
Default value is AUTO,
|
java.security.cert.Certificate |
getServerCertificate()
Gets the serverCertificate for secure HTTP.
|
SlowStartCallPolicy |
getSlowStartCallPolicy() |
int |
getSubscriptionExpireTime()
Gets expire time of registration operation
|
java.lang.String |
getSubscriptionID() |
java.lang.String |
getTokenRealm()
Token used in anonymous calls.
|
java.lang.String |
getUsername()
Gets user name of user
|
android.hardware.Camera.Size |
getVideoResolution()
Gets the defined/used video Resolution.
|
int |
getWebSocketConnectionRetryLimit()
Gets the maximum number of times to retry the WebSocket connection
in case the WebSocket connection fails.
|
int |
getWebSocketConnectionTimeout()
Gets the connection timeout value of WebSocket.
|
java.lang.String |
getWebSocketServerIp()
Gets IP information used in web socket connection creation.
|
int |
getWebSocketServerPort()
Gets port information used in web socket connection creation.
|
boolean |
getWebSocketWithTokenAuthentication()
Gets webSocketConnection mode
If true, it uses token for webSocketConnection.
|
java.lang.String |
getxSessionId()
Gets session id of user
|
boolean |
isHttpPersistentConnectionEnabled()
Indicates whether httpPersistentConnection is enabled or not
|
void |
setAudioOpusCodecConfigurations(AudioCodecConfiguration audioCodecConfiguration)
Sets the Audio Codec configurations.
|
void |
setAuditFrequence(int timeInSeconds)
This method is used for setting time interval for sending control frames.
|
void |
setAuthorizationName(java.lang.String authName)
Sets authName name of user.
|
void |
setBearerToken(java.lang.String bearerToken)
Sets bearer token of the user
|
void |
setCertificateDetails(java.lang.String storeType,
java.lang.String storePassword,
java.io.File keyStoreFile,
java.lang.String keyPassword)
Sets protocol information used in web socket connection creation.
|
void |
setCodecPayloadTypeSet(java.util.List<CodecToReplace> codecSet)
Sets Codec Payload TypeSet for modified sdp creation
|
void |
setDefaultCameraMode(int cameraMode)
Sets default camera mode for every call.
|
void |
setDtmfToneDuration(int dtmfToneDuration)
Sets duration value of DTMF tones im ms
|
void |
setForceDisableMediaOnHold(boolean value)
Forces to disable media transfer when media on hold is active.
|
void |
setFps(int fps)
Sets the parameter for frame per second.
|
void |
setHMACToken(java.lang.String authToken)
Sets hmac token of the user
|
void |
setHttpPersistentConnection(java.lang.Boolean value)
Sets the indicator which shows whether httpPersistentConnection is enabled or not
|
void |
setICECollectionTimeout(int ICECollectionTimeout)
Sets timeout value of ICE Collection
|
void |
setIceOption(ICEOptions iceOption)
Sets ice option.
|
void |
setICEServers(ICEServers ICEServers)
Sets the user's ICE servers that will be used for creating Peer Connection
|
void |
setLogger(LoggingInterface logger)
Sets LoggingInterface reference used by LogManager.
|
void |
setLogLevel(Constants.LogLevel logLevel)
Sets log level of Mobile SDK
If not set, TRACE level is used as default.
|
void |
setNotificationChannelID(java.lang.String notificationChannelID) |
void |
setOrientationMode(OrientationMode mode)
Sets orientation mode
|
void |
setPassword(java.lang.String password)
Sets password of user
|
void |
setPreferredCodecSet(CodecSet codecSet)
Sets preferred CodecSet for modified sdp creation
|
void |
setPushServerURL(java.net.URL pushServerURL)
Sets push server URL
|
void |
setReceiveVideoBandwidth(CallReceiveBandwidthLimit callReceiveBandwidthLimit)
Sets the bandwidth limit for all outgoing calls to be created and incoming calls to be received.
|
void |
setRestServerIp(java.lang.String restServerIp)
Sets server IP information used in REST requests.
|
void |
setRestServerPort(int restServerPort)
Sets server port information used in REST requests.
|
void |
setRingingFeedbackOption(RingingFeedbackOptions ringingFeedbackOption)
APP --> The application side should manage the ringing feedback operations.
|
void |
setServerCertificate(java.security.cert.Certificate serverCertificate)
Sets the server certificate for secure HTTPS.
|
void |
setSlowStartCallPolicy(SlowStartCallPolicy value) |
void |
setSubscriptionID(java.lang.String subscriptionID) |
void |
setTokenRealm(java.lang.String tokenRealm)
Sets the token used in anonymous calls.
|
void |
setUsername(java.lang.String username)
Sets user name of user
|
void |
setVideoResolution(android.hardware.Camera.Size videoResolution)
Sets the desired video Resolution.
|
void |
setWebSocketConnectionRetryLimit(int webSocketConnectionRetryLimit)
Sets the maximum number of times to retry the WebSocket connection
in case the WebSocket connection fails.
|
void |
setWebSocketConnectionTimeout(int timeoutInSeconds)
Sets connection timeout for WebSocket.
|
void |
setWebSocketServerIp(java.lang.String webSocketServerIp)
Sets IP information used in web socket connection creation.
|
void |
setWebSocketServerPort(int webSocketServerPort)
Sets port information used in web socket connection creation.
|
void |
setWebSocketWithTokenAuthentication(boolean tokenAuthentication)
Sets webSocketAuthentication Mode
If true, it uses token for webSocketConnection.
|
void |
setxSessionId(java.lang.String xSessionId)
Sets session id of user
|
public static Configuration getInstance()
Configuration
public java.lang.String getxSessionId()
String
public void setxSessionId(java.lang.String xSessionId)
xSessionId
- the session id information to be used in headerspublic void setUsername(java.lang.String username)
username
- the user name information to be used in credentialspublic java.lang.String getUsername()
String
public void setPassword(java.lang.String password)
password
- the password information to be used in credentialspublic java.lang.String getPassword()
String
public void setBearerToken(java.lang.String bearerToken)
bearerToken
- the token information to be used in credentialspublic java.lang.String getBearerToken()
String
public void setHMACToken(java.lang.String authToken)
authToken
- the hmac token information to be used in credentialspublic java.lang.String getHmacToken()
String
public void setWebSocketWithTokenAuthentication(boolean tokenAuthentication)
tokenAuthentication
- boolean value for webSocketAuthentication modepublic boolean getWebSocketWithTokenAuthentication()
public void setRestServerIp(java.lang.String restServerIp)
restServerIp
- the IP address of rest serverpublic java.lang.String getRestServerIp()
String
public void setPushServerURL(java.net.URL pushServerURL)
pushServerURL
- URL of the push serverpublic java.net.URL getPushServerURL()
public void setRestServerPort(int restServerPort)
restServerPort
- the port value of rest serverpublic int getRestServerPort()
Integer
public void setWebSocketServerIp(java.lang.String webSocketServerIp)
webSocketServerIp
- the IP address of web socket serverpublic java.lang.String getWebSocketServerIp()
String
public void setWebSocketServerPort(int webSocketServerPort)
webSocketServerPort
- the port value of web socket serverpublic int getWebSocketServerPort()
Integer
getRestServerPort()
public void setCertificateDetails(java.lang.String storeType, java.lang.String storePassword, java.io.File keyStoreFile, java.lang.String keyPassword)
storeType
- store type of the certificatestorePassword
- store password of the certificatekeyStoreFile
- key store file of the certificatekeyPassword
- keystore password of the certificatepublic Constants.CertificateValues getCertificateValues()
public java.lang.String getNotificationChannelID()
public void setNotificationChannelID(java.lang.String notificationChannelID)
public java.lang.String getSubscriptionID()
public void setSubscriptionID(java.lang.String subscriptionID)
public void setLogger(LoggingInterface logger)
logger
- the logger to be used by the LogManagerLoggingInterface
,
LogManager
public LoggingInterface getLogger()
LoggingInterface
LogManager
public void setICEServers(ICEServers ICEServers)
ICEServers
- the user defined ice serverspublic ICEServers getICEServers()
public java.lang.String getDefaultICEUsername()
public java.lang.String getDefaultICEPassword()
public void setVideoResolution(android.hardware.Camera.Size videoResolution)
videoResolution
- video resolution settings to be used in video calls
Default value is 720p (1280x720)Camera.Size
public android.hardware.Camera.Size getVideoResolution()
Camera.Size
public void setFps(int fps)
fps
- the frame per second information to be usedpublic int getFps()
int
public int getSubscriptionExpireTime()
Integer
public void setServerCertificate(java.security.cert.Certificate serverCertificate)
serverCertificate
- server certificate to be used in HTTPS connectionpublic java.security.cert.Certificate getServerCertificate()
Certificate
public void setAuditFrequence(int timeInSeconds)
timeInSeconds
- Time interval in secondspublic int getAuditFrequence()
Integer
public void setOrientationMode(OrientationMode mode)
mode
- the Orientation Mode for the applicationpublic OrientationMode getOrientationMode()
OrientationMode
public void setPreferredCodecSet(CodecSet codecSet)
public CodecSet getPreferredCodecSet()
public void setCodecPayloadTypeSet(java.util.List<CodecToReplace> codecSet)
public java.util.List<CodecToReplace> getCodecPayloadTypeSet()
public void setDefaultCameraMode(int cameraMode)
0 CameraInfo.CAMERA_FACING_BACK; 1 CameraInfo.CAMERA_FACING_FRONT;
cameraMode
- public int getDefaultCameraMode()
0 CameraInfo.CAMERA_FACING_BACK; 1 CameraInfo.CAMERA_FACING_FRONT;
public void setDtmfToneDuration(int dtmfToneDuration)
dtmfToneDuration
- duration value for DTMF tone in ms.
Default value is 600 and can be between 40 and 6000public int getICECollectionTimeout()
public void setICECollectionTimeout(int ICECollectionTimeout)
ICECollectionTimeout
- timeout value for ICE Collection in second.
Default value is 10 seconds and it means that it waits 10 seconds for ice gathering. If set to 0, it means that SDK will wait until ice gathering completion.
public int getDtmfToneDuration()
public void setLogLevel(Constants.LogLevel logLevel)
logLevel
- level of logs can be retrieved from SDK.Constants.LogLevel
public Constants.LogLevel getLogLevel()
Constants.LogLevel
public void setIceOption(ICEOptions iceOption)
iceOption
- ICEOptions ICE_VANILLA or ICE_TRICKLEpublic ICEOptions getIceOption()
ICEOptions
public void setAudioOpusCodecConfigurations(AudioCodecConfiguration audioCodecConfiguration)
audioCodecConfiguration
- AudioCodecConfiguration object which will contains all
Opus audio codec configurations.public AudioCodecConfiguration getAudioOpusCodecConfigurations()
AudioCodecConfiguration
public int getWebSocketConnectionTimeout()
Default value is 3.
public void setWebSocketConnectionTimeout(int timeoutInSeconds)
If trying to set a negative value. The default value of 3 will be set.
timeoutInSeconds
- WebSocket connection timeout.public int getWebSocketConnectionRetryLimit()
public void setWebSocketConnectionRetryLimit(int webSocketConnectionRetryLimit)
webSocketConnectionRetryLimit
- WebSocket connection retry limit.public SlowStartCallPolicy getSlowStartCallPolicy()
public void setSlowStartCallPolicy(SlowStartCallPolicy value)
public void setForceDisableMediaOnHold(boolean value)
public boolean getForceDisableMediaOnHold()
public void setAuthorizationName(java.lang.String authName)
authName
- the Authorization Name information to be used in credentials propertypublic java.lang.String getAuthorizationName()
String
public void setReceiveVideoBandwidth(CallReceiveBandwidthLimit callReceiveBandwidthLimit)
callReceiveBandwidthLimit
- set Bandwidth for receiver side of the audio and video callpublic CallReceiveBandwidthLimit getReceiveBandwidthSetting()
public boolean isHttpPersistentConnectionEnabled()
public void setHttpPersistentConnection(java.lang.Boolean value)
value
- true for enabled, Connection: keep-alive HTTP Header; false for disabled, Connection: close HTTP Headerpublic java.lang.String getTokenRealm()
public void setTokenRealm(java.lang.String tokenRealm)
tokenRealm
- public RingingFeedbackOptions getRingingFeedbackOption()
RingingFeedbackOptions
public void setRingingFeedbackOption(RingingFeedbackOptions ringingFeedbackOption)
ringingFeedbackOption
- APP, SERVER or AUTO.