Classes

The following classes are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CISAnalyticsCreator : NSObject

/**
* Initialize Conviva Analytics SDK with the required settings.
* @param customerKey Customer Key.
* @return CISAnalytics instance.
*/
+ (CISAnalytics) createWithCustomerKey:(NSString *)customerKey;

/**
* Initialize Conviva Analytics SDK with the required settings.
* @param customerKey Customer Key.
* @param settings dictionary. Please refer "Settings" section decfined in CSSConstants.h for possible values.
* @return CISAnalytics instance.
*/
+ (CISAnalytics) createWithCustomerKey:(NSString *)customerKey
                              settings:(NSDictionary*)settings;

/**
* Initialize Conviva Analytics SDK with the required settings.
* @param customerKey Customer Key.
* @param systemInterface Object complies to CISSystemInterfaceProtocol .
* @return CISAnalytics instance.
*/
+ (CISAnalytics) createWithCustomerKey:(NSString *)customerKey
                         systemInterface:(id<CISSystemInterfaceProtocol>)systemInterface;

/**
* Initialize Conviva Analytics SDK with the required settings.
* @param customerKey Customer Key.
* @param settings dictionary. Please refer "Settings" section decfined in CSSConstants.h for possible values.
* @param systemInterface Object complies to CISSystemInterfaceProtocol.
* @return CISAnalytics instance.
*/
+ (CISAnalytics) createWithCustomerKey:(NSString *)customerKey
                              settings:(NSDictionary*)settings
                         systemInterface:(id<CISSystemInterfaceProtocol>)systemInterface;

/**
* Initialize Conviva Analytics SDK with the client object. This method is useful for backward compatability. Customer who already integrated EI and wanted to
* integrate AI using this new api, shall use this api.
* @param client Object conforms to CISClientProtocol.
* @return CISAnalytics instance.
*/
+ (CISAnalytics) createWithExistingClient:(id<CISClientProtocol>)client;

@end

    Swift

    class CISAnalyticsCreator : NSObject

  • Helper class required for creating a class instance conforming to protocol CISClientProtocol.
    Generally, every application will have a class instance conforming to protocol CISClientProtocol, which can manage multiple sessions.

    See more

    Declaration

    Objective-C

    @interface CISClientCreator : NSObject

    Swift

    class CISClientCreator : NSObject

  • Helper class required for creating a class instance conforming to protocol CISClientSettingProtocol.
    This is required while creating a client instance.

    See more

    Declaration

    Objective-C

    @interface CISClientSettingCreator : NSObject

    Swift

    class CISClientSettingCreator : NSObject

  • Declares Conviva constants required for a client and video sessions for Conviva SDK.

    See more

    Declaration

    Objective-C

    @interface CISConstants : NSObject

    Swift

    class CISConstants : NSObject

  • Encapsulates all content metadata for a particular video asset. This class instance is required while creating a video session.
    The instance of CISContentMetadata will be used while updating content metadata for a video session.

    See more

    Declaration

    Objective-C

    @interface CISContentMetadata : NSObject <NSCopying>

    Swift

    class CISContentMetadata : NSObject, NSCopying

  • Provides access to system information and utilities according to chosen settings.
    Returns the CISSystemFactoryProtocol conforming class instance, required while creating a client instance.

    See more

    Declaration

    Objective-C

    @interface CISSystemFactoryCreator : NSObject

    Swift

    class CISSystemFactoryCreator : NSObject

  • Used by the Conviva library to access system information and utilities.
    This class helps in creating a CISSystemInterfaceProtocol conforming class instance.
    This class contains instance of classes implementing CISHTTPProtocol, CISTimeProtocol, CISTimerProtocol, CISLoggingProtocol, CISMetadataProtocol, CISStorageProtocol protocols required by the Conviva iOS SDK.

    See more

    Declaration

    Objective-C

    @interface CISSystemInterfaceCreator : NSObject

    Swift

    class CISSystemInterfaceCreator : NSObject

  • Encapsulates all Conviva system settings.
    This is required while creating a client instance and helpful in setting logLevel, storageTimeout & httpTimeout.

    See more

    Declaration

    Objective-C

    @interface CISSystemSettings : NSObject

    Swift

    class CISSystemSettings : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CISUtility : NSObject

+(int) NumberToUnsignedInt:(NSNumber *)number result:(int)defaultResult;
+(BOOL) isValidString:(NSString *)string;
+(double)timeBetweenTimeEarlier:(double)timeEarlier andTimeLater:(double)timeLater;
+ (dispatch_queue_t)cisSharedQueue;
+ (BOOL)isCISSharedQueue;
+ (void)dispatchAsyncToCISSharedQueue:(dispatch_block_t)block;
+ (void)optionalDispatchAsyncToCISSharedQueue:(dispatch_block_t)block;
+ (void)sanitiseTag:(NSMutableDictionary *)custom;
+ (NSString *)describeError:(NSError *)error;

+ (id)getClientId;
+ (void)setClientId:(NSString *)newClientId;
@end

    Swift

    class CISUtility : NSObject

cdnNames

  • @}

    See more

    Declaration

    Objective-C

    @interface ConvivaContentInfo : NSObject <NSCopying>

    Swift

    class ConvivaContentInfo : NSObject, NSCopying

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface ConvivaLightSession : NSObject

/// @brief Cleanup session. Should be called when a video session is over.
///
/// Releases the reference to monitored streamer. Session can be safely released
/// after this call
- (void)cleanup;

/// Send an custom event pertaining to the session
- (void)sendEvent:(NSString *)name withAttributes:(NSDictionary *)attributes;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)setContentLength:(NSInteger)contentLength DEPRECATED_ATTRIBUTE;

/// Notify that ad has started
- (void)adStart;

/// Notify that ad has started with type of ad stream and player type etc.
- (void)adStart:(AdStream)adStream adPlayer:(AdPlayer)adPlayer adPosition:(AdPosition)adPosition;

/// Notify that ad has ended
- (void)adEnd;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)setCdnNameOrResource:(NSString *)cdnNameOrResource DEPRECATED_ATTRIBUTE;

/// Report a fatal error and use specified error message
- (void)reportError:(NSString *)errorMsg DEPRECATED_ATTRIBUTE;

/// Report a fatal and non fatal error and use specified error message
- (void)reportError:(NSString *)errorMessage errorType:(ErrorSeverity)severity;

/// Attach streamer to specified streamer */
- (void)attachStreamer:(id)streamer;

/// @brief Pause session monitoring such that it can be resumed later
/// @note The existing streamer is detached from the session.
/// @see attachStreamer()
- (void)pauseMonitor;

/// @brief Set the current bitrate
- (void)setBitrate:(int)bitrateKbps;

/// @brief Set the CDN Server IP
- (void)setCDNServerIP:(NSString *)cdnServerIP;

/// @brief Set the Link Encryption
- (void)setLinkEncryption:(NSString*)newLinkEncryption;

/// @brief Set the Signal Strength
- (void)setSignalStrength:(double)newSignalStrength;

/// @brief Set the Connection Type
- (void)setConnectionType:(NSString *)newConnectionType;

/// @brief Set Player seek Start
- (void)setSeekStart:(NSInteger)seekToPosition;

/// @brief Set Player seek End
- (void)setSeekEnd:(NSInteger)seekPosition;

/// This API is depecated
/// use the API updateContentMetadata:(ConvivaContentInfo *)newcontentInfo
- (void)updateStreamUrl:(NSString *)newStreamUrl DEPRECATED_ATTRIBUTE;

/// @brief update content metadata
- (void)updateContentMetadata:(ConvivaContentInfo *)newcontentInfo;

/** Reserved method. Do not use. */
- (int) currentSessionType;

- (int)sessionID;

@end

    Swift

    class ConvivaLightSession : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface ConvivaPlayerState : NSObject

+ (NSString *)stateString:(int)state;

@end

    Swift

    class ConvivaPlayerState : NSObject

  • Conviva provided helper class which implements CISHTTPProtocol required methods.
    The application can implement its own CISHTTPProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSHttpInterface : NSObject <CISHTTPProtocol>

    Swift

    class IOSHttpInterface : NSObject, CISHTTPProtocol

  • Conviva provided helper class which implements CISLoggingProtocol required methods.
    The application can implement its own CISLoggingProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSLoggingInterface : NSObject <CISLoggingProtocol>

    Swift

    class IOSLoggingInterface : NSObject, CISLoggingProtocol

  • Conviva provided helper class which implements CISMetadataProtocol required methods.
    The application can implement its own CISMetadataProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSMetadataInterface : NSObject <CISMetadataProtocol>

    Swift

    class IOSMetadataInterface : NSObject, CISMetadataProtocol

  • Conviva provided helper class which implements CISStorageProtocol required methods.
    The application can implement its own CISStorageProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSStorageInterface : NSObject <CISStorageProtocol>

    Swift

    class IOSStorageInterface : NSObject, CISStorageProtocol

  • Default IOSSystemInterfaceFactory provided by Conviva.
    Use this to get an instance of SystemInterface.
    Alternatively, you can develop your own SystemInterface.

    See more

    Declaration

    Objective-C

    @interface IOSSystemInterfaceFactory : NSObject

    Swift

    class IOSSystemInterfaceFactory : NSObject

  • Conviva provided helper class which manages timers required by Conviva SDK.
    This class is used by Conviva provided iOSTimerInterface to create this class instance for each timer activity.
    As this is conforming to CISCancelProtocol, the timer cancellation activity are also handled here.

    See more

    Declaration

    Objective-C

    @interface IOSSystemTimer : NSObject <CISCancelProtocol>

    Swift

    class IOSSystemTimer : NSObject, CISCancelProtocol

  • Conviva provided helper class which implements CISTimeProtocol required methods.
    The application can implement its own CISTimeProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSTimeInterface : NSObject <CISTimeProtocol>

    Swift

    class IOSTimeInterface : NSObject, CISTimeProtocol

  • Conviva provided helper class which implements CISTimerProtocol required methods.
    The application can implement its own CISTimerProtocol conforming class for creating CISSystemInterfaceCreator while creating a client.

    Declaration

    Objective-C

    @interface IOSTimerInterface : NSObject <CISTimerProtocol>

    Swift

    class IOSTimerInterface : NSObject, CISTimerProtocol

  • @mainpage @author Saiguang Che

    The top level class for customer interaction is LivePass. Additional api is available in ConvivaLightSession.

    See more

    Declaration

    Objective-C

    @interface LivePass : NSObject

    Swift

    class LivePass : NSObject