RichMedia

public class RichMedia : BusinessObject

Abstract class to manage rich media tracking

  • Rich media broadcast type

    • clip: clip
    • live: live
    See more

    Declaration

    Swift

    public enum BroadcastMode : String

  • Actions types

    • play: play
    • pause: pause
    • stop: stop
    • move: move
    • refresh: refresh
    See more

    Declaration

    Swift

    @objc
public enum RichMediaAction : Int

  • true if media is buffering

    Declaration

    Swift

    open var isBuffering: Bool { get set }

  • true if media is embedded in app

    Declaration

    Swift

    open var isEmbedded: Bool { get set }

  • Media name

    Declaration

    Swift

    @available(*, deprecated, renamed: "mediaLabel")
@objc
public var name: String { get set }

  • Media name

    Declaration

    Swift

    @objc
public var mediaLabel: String

  • First chapter

    Declaration

    Swift

    @available(*, deprecated, renamed: "mediaTheme1")
@objc
public var chapter1: String? { get set }

  • First chapter

    Declaration

    Swift

    @objc
public var mediaTheme1: String?

  • Second chapter

    Declaration

    Swift

    @available(*, deprecated, renamed: "mediaTheme2")
@objc
public var chapter2: String? { get set }

  • Second chapter

    Declaration

    Swift

    @objc
public var mediaTheme2: String?

  • Third chapter

    Declaration

    Swift

    @available(*, deprecated, renamed: "mediaTheme3")
@objc
public var chapter3: String? { get set }

  • Third chapter

    Declaration

    Swift

    @objc
public var mediaTheme3: String?

  • Level 2

    Declaration

    Swift

    @available(*, deprecated, renamed: "mediaLevel2")
@objc
public var level2: Int { get set }

  • Level 2

    Declaration

    Swift

    @objc
public var mediaLevel2: Int

  • Action. see RichMediaAction

    Declaration

    Swift

    @objc
public var action: RichMedia.RichMediaAction

  • Web domain

    Declaration

    Swift

    @objc
public var webdomain: String?

  • Send a play action tracking. Refresh is enabled with default refresh configuration. See doc for more details

    Declaration

    Swift

    @objc
public func sendPlay()

  • Send a play action tracking. Refresh is enabled with custom duration

    Declaration

    Swift

    @available(*, deprecated, message: "Static values are not recomanded anymore. Use sendPlay(﹚ or sendPlay(dynamicRefreshConfiguration﹚")
@objc
public func sendPlay(_ refreshDuration: Int)

    Parameters

    refreshDuration

    duration in second, must be >= 5

  • Send a play action. No refresh hits will be sent after the action.

    Declaration

    Swift

    @objc
public func sendPlayWithoutRefresh()

  • Send a Play action then send several Resfresh action based on the configuration provided

    Declaration

    Swift

    @objc
public func sendPlay(dynamicRefreshConfiguration: [Int : Int])

    Parameters

    dynamicRefreshConfiguration

    Describe the refresh send rate: [0:5, 1:10] : from 0 to 1 minute, send one refresh every 5s, then refresh every 10s after 1min. See documentation for more details.

  • Resume a previous pause() call

    Declaration

    Swift

    @objc
public func sendResume()

  • Send a pause action tracking

    Declaration

    Swift

    @objc
public func sendPause()

  • Send a stop action tracking

    Declaration

    Swift

    @objc
public func sendStop()

  • Send a move action tracking

    Declaration

    Swift

    @objc
public func sendMove()