Collector

@objc(BMACollector)
public protocol Collector

  • The impressionId of the current playback session

    Declaration

    Swift

    var impressionId: String? { get }

  • The userId that is sent with each analytics sample.

    Used for session tracking in the Analytics Dashboard The value for this field is either a random uuid or a constant uuid See code>.<code>randomizeUserId for more information

    Declaration

    Swift

    var userId: String { get }

  • Offers methods to provide ad metadata when using server side ad insertion

    Declaration

    Swift

    var ssai: SsaiApi { get }

  • Detaches the collector from the Player.

    This should always be called before releasing/destroying the player and before loading a new Source for the player, followed by attaching the collector again.

    Declaration

    Swift

    func detach()

  • Sends CustomData to the analytics backend

    The provided CustomData will be merged with previously set CustomData

    This method does not have an effect until a player is attached using attach(to:)

    Declaration

    Swift

    func sendCustomDataEvent(with customData: CustomData)

    Parameters

    customData

    The CustomData object which will be used for the Event

  • Declaration

    Swift

    func getUserId() -> String

  • Declaration

    Swift

    func setCustomDataOnce(customData: CustomData)

  • Declaration

    Swift

    func detachPlayer()