CISMetadataProtocol

@protocol CISMetadataProtocol <NSObject>

Class conforming to this will be responsible for implementing required methods for system information, this is used by the Conviva library to gather system information.

  • Required the build model of iOS/tvOS.

    Declaration

    Objective-C

    - (NSString *)getAppleOSBuildModel;

    Swift

    func getAppleOSBuildModel() -> String!

    Return Value

    DeviceType iOS/tvOS build model.

  • A version of the operating system used by the device. Ex: “9.1”

    Declaration

    Objective-C

    - (NSString *)getOperatingSystemVersion;

    Swift

    func getOperatingSystemVersion() -> String!

    Return Value

    Operating System Version, a version of the operating system used by the device.

  • Required the type of the device. One of Console, Settop, Mobile and PC.

    Declaration

    Objective-C

    - (DeviceType)getDeviceType;

    Swift

    func getDeviceType() -> DeviceType

    Return Value

    DeviceType, type of the device; should be fetched by passing value from DeviceType enum to [CISClient getDeviceType:];

  • A model of the device.

    Declaration

    Objective-C

    - (NSString *)getDeviceModel;

    Swift

    func getDeviceModel() -> String!

    Return Value

    Device Model, a model of the device.

  • A version of the device. Usually, low-level information pertaining to the hardware. Ex: “DTP-BP-0869-34”.

    Declaration

    Objective-C

    - (NSString *)getDeviceVersion;

    Swift

    optional func getDeviceVersion() -> String!

    Return Value

    DeviceVersion, a version of the device.

  • The manufacturer of the device. Ex: “Samsung”, “Apple”.

    Declaration

    Objective-C

    - (NSString *)getDeviceManufacturer;

    Swift

    optional func getDeviceManufacturer() -> String!

    Return Value

    DeviceManufacturer, the manufacturer of the device.

  • The brand of the device. Ex: “iPhone”, “Samsung SmartTV”.

    Declaration

    Objective-C

    - (NSString *)getDeviceBrand;

    Swift

    optional func getDeviceBrand() -> String!

    Return Value

    DeviceBrand, the Brand of the device.

  • The name of the framework used by your application, if applicable. It can be the name of application framework itself, or the name of the player framework used for video playback.
    Ex: “AVFoundation”, “NexPlayer”, “HTML5”, “OSMF”

    Declaration

    Objective-C

    - (NSString *)getFrameworkName;

    Swift

    optional func getFrameworkName() -> String!

    Return Value

    FrameworkName, the name of the framework used by your application.

  • A version of the framework used by your application, if applicable. Ex: “alpha12”, “4.28.4433”.

    Declaration

    Objective-C

    - (NSString *)getFrameworkVersion;

    Swift

    optional func getFrameworkVersion() -> String!

    Return Value

    FrameworkVersion, a version of the framework used by your application.

  • A version of the platform used by the device. Ex: “9.2.1”.

    Declaration

    Objective-C

    - (NSString *)getPlatformVersion;

    Swift

    optional func getPlatformVersion() -> String!

    Return Value

    PlatformVersion, a version of the platform used by your device.

  • A version of the platform name used by the device. Ex: “iOS”, “tvOS”,“watchOS”.

    Declaration

    Objective-C

    - (NSString *)getPlatformName;

    Swift

    optional func getPlatformName() -> String!

    Return Value

    A platform name used by the device.

  • Notification that Conviva no longer needs this MetadataProtocol.

    Declaration

    Objective-C

    - (void)cleanUp;

    Swift

    optional func cleanUp()