ConvivaContentMetadata

@available(*, deprecated, message: "This class will be removed with the next major release.")
@objc(THEOplayerConvivaContentMetadata)
public class ConvivaContentMetadata : NSObject, Codable

The Conviva content metadata.

  • The name of the asset.

    Declaration

    Swift

    @objc
public private(set) var assetName: String { get }

  • Whether a live asset is being tracked.

    Remark

    False refers to a VOD stream.

    Declaration

    Swift

    public private(set) var live: Bool? { get }

  • The default bitrate of the asset, in kbps.

    Declaration

    Swift

    public private(set) var defaultBitrateKbps: Int? { get }

  • The default resource.

    Declaration

    Swift

    @objc
public private(set) var defaultResource: String? { get }

  • The duration of the asset, in seconds.

    Declaration

    Swift

    public private(set) var duration: Int? { get }

  • The encoded frame rate of the asset, in frames per second.

    Declaration

    Swift

    public private(set) var encodedFrameRate: Int? { get }

  • The application name.

    Declaration

    Swift

    @objc
public private(set) var applicationName: String? { get }

  • The identifier of the viewer.

    Declaration

    Swift

    @objc
public private(set) var viewerId: String? { get }

  • A Map of custom Conviva tags.

    Declaration

    Swift

    @objc
public private(set) var custom: [String : String]? { get }

  • Conviva Metadata

    Declaration

    Swift

    public init(assetName: String, live: Bool? = nil, defaultBitrateKbps: Int? = nil, defaultResource: String? = nil, duration: Int? = nil, encodedFrameRate: Int? = nil, applicationName: String? = nil, viewerId: String? = nil, custom: [String : String]? = nil)

    Parameters

    assetName

    The name of the asset to pass to Conviva.
    live

    Whether it is a live asset.
    defaultBitrateKbps

    Use this property to set a default Bitrate, in kbps.
    defaultResource

    Use this property to set a default resource to be logged to Conviva.
    duration

    Use this property to set the duration of the asset to be logged to Conviva, in seconds.
    encodedFrameRate

    Use this property to set the encoded frame rate, in frames per second.
    applicationName

    Use this property to change the application name logged to Conviva.
    viewerId

    Use this property to set a custom viewer ID over a randomly generated one.
    custom

    Use this property to set custom Conviva tags.