Constants
The following constants are available globally.
-
Internal do not use
Declaration
Objective-C
extern NSString *const CWS_TRUE
Swift
let CWS_TRUE: String
-
Internal do not use
Declaration
Objective-C
extern NSString *const CWS_FALSE
Swift
let CWS_FALSE: String
-
A default sessionKey to use for the Client.sendCustomEvent API if you do not yet have a Conviva session.
Declaration
Objective-C
extern const int NO_SESSION_KEY
Swift
let NO_SESSION_KEY: Int32
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT int const CIS_SIGNAL_STRENGTH_INVALID_VALUE
Swift
let CIS_SIGNAL_STRENGTH_INVALID_VALUE: Int32
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_BITRATE
Swift
let CIS_SSDK_PLAYBACK_METRIC_BITRATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_AVERAGE_BITRATE
Swift
let CIS_SSDK_PLAYBACK_METRIC_AVERAGE_BITRATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_BUFFER_LENGTH
Swift
let CIS_SSDK_PLAYBACK_METRIC_BUFFER_LENGTH: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_CDN_IP
Swift
let CIS_SSDK_PLAYBACK_METRIC_CDN_IP: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_ENCODED_FRAMERATE
Swift
let CIS_SSDK_PLAYBACK_METRIC_ENCODED_FRAMERATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_PLAYER_STATE
Swift
let CIS_SSDK_PLAYBACK_METRIC_PLAYER_STATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_PLAY_HEAD_TIME
Swift
let CIS_SSDK_PLAYBACK_METRIC_PLAY_HEAD_TIME: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_RENDERED_FRAMERATE
Swift
let CIS_SSDK_PLAYBACK_METRIC_RENDERED_FRAMERATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_RESOLUTION
Swift
let CIS_SSDK_PLAYBACK_METRIC_RESOLUTION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_SEEK_STARTED
Swift
let CIS_SSDK_PLAYBACK_METRIC_SEEK_STARTED: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_SEEK_ENDED
Swift
let CIS_SSDK_PLAYBACK_METRIC_SEEK_ENDED: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_SIGNAL_STRENGTH
Swift
let CIS_SSDK_PLAYBACK_METRIC_SIGNAL_STRENGTH: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_LINK_ENCRYPTION
Swift
let CIS_SSDK_PLAYBACK_METRIC_LINK_ENCRYPTION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYBACK_METRIC_CONN_TYPE
Swift
let CIS_SSDK_PLAYBACK_METRIC_CONN_TYPE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_ASSET_NAME
Swift
let CIS_SSDK_METADATA_ASSET_NAME: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_PLAYER_NAME
Swift
let CIS_SSDK_METADATA_PLAYER_NAME: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_IS_LIVE
Swift
let CIS_SSDK_METADATA_IS_LIVE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_ENCODED_FRAMERATE
Swift
let CIS_SSDK_METADATA_ENCODED_FRAMERATE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_DEFAULT_RESOURCE
Swift
let CIS_SSDK_METADATA_DEFAULT_RESOURCE: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_STREAM_URL
Swift
let CIS_SSDK_METADATA_STREAM_URL: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_VIEWER_ID
Swift
let CIS_SSDK_METADATA_VIEWER_ID: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_DURATION
Swift
let CIS_SSDK_METADATA_DURATION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_METADATA_IS_OFFLINE_PLAYBACK
Swift
let CIS_SSDK_METADATA_IS_OFFLINE_PLAYBACK: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYER_MODULE_NAME
Swift
let CIS_SSDK_PLAYER_MODULE_NAME: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYER_MODULE_VERSION
Swift
let CIS_SSDK_PLAYER_MODULE_VERSION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYER_FRAMEWORK_NAME
Swift
let CIS_SSDK_PLAYER_FRAMEWORK_NAME: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_PLAYER_FRAMEWORK_VERSION
Swift
let CIS_SSDK_PLAYER_FRAMEWORK_VERSION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_AD_BREAK_POD_INDEX
Swift
let CIS_SSDK_AD_BREAK_POD_INDEX: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_AD_BREAK_POD_POSITION
Swift
let CIS_SSDK_AD_BREAK_POD_POSITION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_AD_BREAK_POD_DURATION
Swift
let CIS_SSDK_AD_BREAK_POD_DURATION: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_AD_BREAK_AD_PLAYER
Swift
let CIS_SSDK_AD_BREAK_AD_PLAYER: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_APP_FOREGROUND_EVENT
Swift
let CIS_SSDK_APP_FOREGROUND_EVENT: String
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT NSString *const CIS_SSDK_APP_BACKGROUND_EVENT
Swift
let CIS_SSDK_APP_BACKGROUND_EVENT: String
-
The URL of the Conviva platform to report data to. The default value is highly recommended in production environments. Expected value: NSString
Declaration
Objective-C
extern NSString *const CIS_SSDK_SETTINGS_GATEWAY_URL
Swift
let CIS_SSDK_SETTINGS_GATEWAY_URL: String
-
The level of log messages to print in the console log and report to conviva backend. We recommend using log level warning during development and lowering to debug when more information is required to troubleshoot specific issues. Expected value: [NSNumber numberWithUnsignedInteger]
Declaration
Objective-C
extern NSString *const CIS_SSDK_SETTINGS_LOG_LEVEL
Swift
let CIS_SSDK_SETTINGS_LOG_LEVEL: String
-
Enable/Disable console logs.Useful during development. Set true to enable console logs else false. Expected value: [NSNumber numberWithBool]
Declaration
Objective-C
extern NSString *const CIS_SSDK_SETTINGS_ENABLE_CONSOLE_LOGS
Swift
let CIS_SSDK_SETTINGS_ENABLE_CONSOLE_LOGS: String
-
How long the Conviva client will wait for a response when attempting to send/receive data over network before considering that attempt a failure in seconds.The default value will work for the overwhelming majority of devices. Expected value: [NSNumber numberWithDouble]
Declaration
Objective-C
extern NSString *const CIS_SSDK_SETTINGS_HTTP_TIMEOUT
Swift
let CIS_SSDK_SETTINGS_HTTP_TIMEOUT: String
-
How long the Conviva client will wait for a response when attempting to access device storage before considering that attempt a failure in seconds. The default value will work for the overwhelming majority of devices. Expected value: [NSNumber numberWithDouble]
Declaration
Objective-C
extern NSString *const CIS_SSDK_SETTINGS_STORAGE_TIMEOUT
Swift
let CIS_SSDK_SETTINGS_STORAGE_TIMEOUT: String
-
Pass true to disable auto detection. Expected value: [NSNumber numberWithBool]
Declaration
Objective-C
extern NSString *const CIS_SDK_OPTION_EXTERNAL_BITRATE_REPORTING
Swift
let CIS_SDK_OPTION_EXTERNAL_BITRATE_REPORTING: String
-
Pass true to disable auto detection. Expected value: [NSNumber numberWithBool]
Declaration
Objective-C
extern NSString *const CIS_SDK_OPTION_EXTERNAL_STREAMURL_REPORTING
Swift
let CIS_SDK_OPTION_EXTERNAL_STREAMURL_REPORTING: String
-
Undocumented
Declaration
Objective-C
extern const int CIS_STOPPED
Swift
let CIS_STOPPED: Int32
-
Undocumented
Declaration
Objective-C
extern const int CIS_PLAYING
Swift
let CIS_PLAYING: Int32
-
Undocumented
Declaration
Objective-C
extern const int CIS_BUFFERING
Swift
let CIS_BUFFERING: Int32
-
Undocumented
Declaration
Objective-C
extern const int CIS_PAUSED
Swift
let CIS_PAUSED: Int32
-
Undocumented
Declaration
Objective-C
extern const int CIS_NOTMONITORED
Swift
let CIS_NOTMONITORED: Int32
-
Undocumented
Declaration
Objective-C
extern const int CIS_UNKNOWN
Swift
let CIS_UNKNOWN: Int32
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT double ConvivaSDKVersionNumber
Swift
var ConvivaSDKVersionNumber: Double
-
Undocumented
Declaration
Objective-C
FOUNDATION_EXPORT const unsigned char ConvivaSDKVersionString[]