SMConfiguration Class Reference
Inherits from | NSObject |
---|---|
Declared in | SMConfiguration.h |
userName
Name value of the user.
@property (nonatomic, strong) NSString *userName
Availability
2.0.0
Discussion
Name value of the user.
Declared In
SMConfiguration.h
authorizationName
“Authorization Name” value of the user. It must be set when username and authorizationName are different Default value is nil
@property (nonatomic, strong) NSString *authorizationName
Availability
4.5.6
Discussion
“Authorization Name” value of the user. It must be set when username and authorizationName are different Default value is nil
Declared In
SMConfiguration.h
password
Password value of the user.
@property (nonatomic, strong) NSString *password
Availability
2.0.0
Discussion
Password value of the user.
Declared In
SMConfiguration.h
restServerPort
server port information of the baseUrl used for REST request.
@property (nonatomic, strong) NSString *restServerPort
Availability
2.0.0
Discussion
server port information of the baseUrl used for REST request.
Default value is 443.
Declared In
SMConfiguration.h
restServerIP
server ip information of the baseUrl used for REST request.
@property (nonatomic, strong) NSString *restServerIP
Availability
2.0.0
Discussion
server ip information of the baseUrl used for REST request.
Declared In
SMConfiguration.h
pushServerURL
Sets the push server URL.
@property (nonatomic, strong) NSURL *pushServerURL
Availability
4.6.0
Discussion
Sets the push server URL.
Declared In
SMConfiguration.h
webSocketServerPort
port information used in web socket connection creation.
@property (nonatomic, strong) NSString *webSocketServerPort
Availability
2.0.0
Discussion
port information used in web socket connection creation.
Default value is 443.
Declared In
SMConfiguration.h
webSocketServerIP
ip information used in web socket connection creation.
@property (nonatomic, strong) NSString *webSocketServerIP
Availability
2.0.0
Discussion
ip information used in web socket connection creation.
Declared In
SMConfiguration.h
webSocketCertificate
Web socket Self signed certificate file data. Can be fetched from a file or string @code NSString *cerPath = [[NSBundle mainBundle\ pathForResource:@“myOwnCertificate” ofType:@“der”\; [[Configuration getInstance] setWebSocketCertificate:[[NSData alloc\ initWithContentsOfFile:cerPath\\; @endcode
@property (nonatomic, strong) NSData *webSocketCertificate
Availability
3.0.3
Discussion
Web socket Self signed certificate file data. Can be fetched from a file or string @code NSString *cerPath = [[NSBundle mainBundle\ pathForResource:@“myOwnCertificate” ofType:@“der”\; [[Configuration getInstance] setWebSocketCertificate:[[NSData alloc\ initWithContentsOfFile:cerPath\\; @endcode
Declared In
SMConfiguration.h
logger
LoggingDelegate reference used by LogManager.
@property (nonatomic, strong) id<SMLoggingDelegate> _Nonnull logger
Availability
2.0.0
Discussion
LoggingDelegate reference used by LogManager.
Declared In
SMConfiguration.h
iceOption
Sets the ice options as ICE_VANILLA or ICE_TRICKLE. Default value is ICE_VANILLA MobileSDK will have same behavior in older versions, if “iceOption” is selected as Vanilla ICE or used default value.
@property (nonatomic) SMICEOptions iceOption
Availability
4.1.0
Discussion
Sets the ice options as ICE_VANILLA or ICE_TRICKLE. Default value is ICE_VANILLA MobileSDK will have same behavior in older versions, if “iceOption” is selected as Vanilla ICE or used default value.
Declared In
SMConfiguration.h
ICEServers
ICEServers stores ICE servers array (including stun & turn).
@property (nonatomic, strong) SMICEServers *ICEServers
Availability
3.0.3
Discussion
ICEServers stores ICE servers array (including stun & turn).
Declared In
SMConfiguration.h
defaultICEUsername
Default username of ICEServers.
@property (nonatomic, strong) NSString *defaultICEUsername
Availability
3.0.3
Discussion
Default username of ICEServers.
Declared In
SMConfiguration.h
defaultICEPassword
Default password of ICEServers.
@property (nonatomic, strong) NSString *defaultICEPassword
Availability
3.0.3
Discussion
Default password of ICEServers.
Declared In
SMConfiguration.h
videoResolution
Sets initial video resolution for video Value should be one of the AVCaptureSessionPreset strings.
If videoResolution value is to nil high resolution (720p) will be used by default.
@property (nonatomic, strong) NSString *videoResolution
Availability
2.0.0 @modified 4.0.2
Declared In
SMConfiguration.h
httpPersistentConnection
Configuration to set HTTP Connection header in rest request Default value is true true for Connection: keep alive false for Connection: close
@property (nonatomic) BOOL httpPersistentConnection
Availability
5.4.0
Discussion
Configuration to set HTTP Connection header in rest request Default value is true true for Connection: keep alive false for Connection: close
Declared In
SMConfiguration.h
subscriptionExpires
Subscription expire time
@property (nonatomic, strong) NSNumber *subscriptionExpires
Availability
2.0.0
Discussion
Subscription expire time
Declared In
SMConfiguration.h
serverCertificate
Server certificate to be used in HTTPS connection.Certificate must be .DER format @code NSString *cerPath = [[NSBundle mainBundle\ pathForResource:@“myOwnCertificate” ofType:@“der”\; [[Configuration getInstance] setWebSocketCertificate:[[NSData alloc\ initWithContentsOfFile:cerPath\\; @endcode
@property (nonatomic, strong) NSData *serverCertificate
Availability
2.0.0
Discussion
Server certificate to be used in HTTPS connection.Certificate must be .DER format @code NSString *cerPath = [[NSBundle mainBundle\ pathForResource:@“myOwnCertificate” ofType:@“der”\; [[Configuration getInstance] setWebSocketCertificate:[[NSData alloc\ initWithContentsOfFile:cerPath\\; @endcode
Declared In
SMConfiguration.h
auditFrequency
Sending audit message frequency (seconds)
@property (nonatomic) NSInteger auditFrequency
Availability
2.0.0
Discussion
Sending audit message frequency (seconds)
Default value is 30.
Declared In
SMConfiguration.h
forceDisableMediaOnHold
Forces to disable media transfer when media on hold is active. It helps to fix some MOH issues on PSTN calls
@property (nonatomic) BOOL forceDisableMediaOnHold
Availability
4.5.5
Discussion
Forces to disable media transfer when media on hold is active. It helps to fix some MOH issues on PSTN calls
Declared In
SMConfiguration.h
preferredCodecSet
codecSet stores available codecs for audio and video.
@property (nonatomic, strong) SMCodecSet *preferredCodecSet
Availability
3.0.5
Discussion
codecSet stores available codecs for audio and video.
Declared In
SMConfiguration.h
codecPayloadTypeSet
Sets codecPayloadTypeSet to modify payload numbers of audio and video codecs
@property (nonatomic, strong) NSArray<SMCodecToReplace*> *codecPayloadTypeSet
Availability
4.5.8
Discussion
Sets codecPayloadTypeSet to modify payload numbers of audio and video codecs
Declared In
SMConfiguration.h
orientationMode
Sets the camera orientation type of video capturer. Video orientation can be changed according to application status bar orientation or device orientation. Camera can be bind to this notifications or not to be bind anything.
@property (nonatomic) SMCameraOrientationMode orientationMode
Availability
2.0.0
Discussion
Sets the camera orientation type of video capturer. Video orientation can be changed according to application status bar orientation or device orientation. Camera can be bind to this notifications or not to be bind anything.
Declared In
SMConfiguration.h
scalingType
Scaling type parameter for local and remote video views.
@property (nonatomic) SMScalingType scalingType
Availability
5.20.0
Discussion
Scaling type parameter for local and remote video views.
Declared In
SMConfiguration.h
cameraPosition
Sets the default camera position mode
@property (nonatomic) AVCaptureDevicePosition cameraPosition
Availability
3.0.1
Discussion
Sets the default camera position mode
Declared In
SMConfiguration.h
fps
Sets fps value of the video source If invalid value is set, it will cause no video on call Default value is 30.
@property (nonatomic) NSUInteger fps
Availability
4.5.1.2
Discussion
Sets fps value of the video source If invalid value is set, it will cause no video on call Default value is 30.
Declared In
SMConfiguration.h
dtmfToneDuration
Sets duration value of DTMF tones im ms Default value is 600 and can be between 40 and 6000
@property (nonatomic) NSUInteger dtmfToneDuration
Availability
5.0.0
Discussion
Sets duration value of DTMF tones im ms Default value is 600 and can be between 40 and 6000
Declared In
SMConfiguration.h
logLevel
Sets log level of Mobile SDK
@property (nonatomic) SMLogLevel logLevel
Availability
3.0.2
Discussion
Sets log level of Mobile SDK
If not set, TRACE level is used as default.
See Also
Declared In
SMConfiguration.h
ICECollectionTimeout
Specifies timeout value of ICE Collection Default value is 10 and it means that waits 10 seconds for ice gathering. if it is set as 0, it means that waits until ice gathering completion.
@property (nonatomic) NSTimeInterval ICECollectionTimeout
Availability
3.1.3 @modified 5.6.0
Discussion
Specifies timeout value of ICE Collection Default value is 10 and it means that waits 10 seconds for ice gathering. if it is set as 0, it means that waits until ice gathering completion.
Declared In
SMConfiguration.h
audioSessionConfiguration
Sets audio session configuration
@property (nonatomic, strong) SMAudioSessionConfiguration *audioSessionConfiguration
Availability
4.2.0
Discussion
Sets audio session configuration
Declared In
SMConfiguration.h
audioCodecConfigurations
Sets the audio codec configurations. If parameter is null WebRTC defaults will be use. Warning: This is advance usage if you don’t have expertise on audio codecs, especially opus, don’t use it.
@property (nonatomic, strong) SMAudioCodecConfiguration *audioCodecConfigurations
Parameters
audioCodecConfigurations |
SMAudioCodecConfiguration object which will contains all audio codec configurations. |
---|
Availability
4.2.0
Discussion
Sets the audio codec configurations. If parameter is null WebRTC defaults will be use. Warning: This is advance usage if you don’t have expertise on audio codecs, especially opus, don’t use it.
Declared In
SMConfiguration.h
slowStartCallPolicy
Specifies accept type for Slow Start Incoming Calls. Default value will be AudioSupported that means Slow Start Incoming Calls will be initiated by supporting only audio.
@property (nonatomic) SMSlowStartCallPolicy slowStartCallPolicy
Availability
4.5.4
Discussion
Specifies accept type for Slow Start Incoming Calls. Default value will be AudioSupported that means Slow Start Incoming Calls will be initiated by supporting only audio.
Declared In
SMConfiguration.h
receiveBandwidthLimit
Bandwidth limit of receiving media
@property (nonatomic, strong) SMCallReceiveBandwidthLimit *receiveBandwidthLimit
Availability
4.6.1
Discussion
Bandwidth limit of receiving media
Declared In
SMConfiguration.h
isPushEnabled
Push Notification Configuration Parameter
@property (nonatomic) BOOL isPushEnabled
Availability
5.0.0
Discussion
Push Notification Configuration Parameter
Declared In
SMConfiguration.h
bearerToken
Bearer Token Configuration Parameter
@property (nonatomic) NSString *bearerToken
Availability
5.7.0
Discussion
Bearer Token Configuration Parameter
Declared In
SMConfiguration.h
websocketWithTokenAuthentication
Websocket Token Authentication Configuration Parameter
@property (nonatomic) BOOL websocketWithTokenAuthentication
Availability
5.7.0
Discussion
Websocket Token Authentication Configuration Parameter
Declared In
SMConfiguration.h
ringingFeedbackOption
Ringing feedback configuration parameter. Default value is AUTO.
@property (nonatomic) SMRingingFeedbackOptions ringingFeedbackOption
Availability
5.15.0 @updated 2022-06-20
Discussion
Ringing feedback configuration parameter. Default value is AUTO.
Declared In
SMConfiguration.h
webSocketConnectionRetryLimit
Websocket reconnecting limit parameter
@property (nonatomic) NSInteger webSocketConnectionRetryLimit
Availability
6.8.0
Discussion
Websocket reconnecting limit parameter
Declared In
SMConfiguration.h
+ getInstance
This method returns (creates if necessary) singleton instance of Configuration class
+ (nonnull SMConfiguration *)getInstance
Return Value
shared Configuration instance
Availability
2.0.0
Discussion
This method returns (creates if necessary) singleton instance of Configuration class
Declared In
SMConfiguration.h