PlayerEventCreator

public class PlayerEventCreator: NSObject

EngageEvent creator for Media Playback events

  • Initializes the event creator using specified content id

    Declaration

    Swift

    public init(contentId : String)

    Parameters

    contentId

    Identifier of the content for which events are created

  • Set the type of the content

    Declaration

    Swift

    public func putContentType(type : String) -> PlayerEventCreator

    Parameters

    type

    Type of the content

    Return Value

    PlayerEventCreator object after updating type of content

  • Set the title of the content

    Declaration

    Swift

    public func putContentTitle(title : String) -> PlayerEventCreator

    Parameters

    title

    Title of the content

    Return Value

    PlayerEventCreator object after updating type of content

  • Set the mode by which content is played

    Declaration

    Swift

    public func putDisplayMode(mode : String) -> PlayerEventCreator

    Parameters

    mode

    Mode ,Example portrait, landscape, chrome cast, picture-in-picture etc.

    Return Value

    PlayerEventCreator object after updating displayMode

  • Set the duration of playback

    Declaration

    Swift

    public func putDuration(duration : Double) -> PlayerEventCreator

    Parameters

    duration

    Duration of playback

    Return Value

    PlayerEventCreator object after updating duration

  • Set the current video quality

    Declaration

    Swift

    public func putContentVideoQuality(videoQuality : String) -> PlayerEventCreator

    Parameters

    videoQuality

    Video quality

    Return Value

    PlayerEventCreator object after updating videoQuality

  • Set the progress of playback

    Declaration

    Swift

    public func putProgress(progress : Double) -> PlayerEventCreator

    Parameters

    progress

    Progress of playback

    Return Value

    PlayerEventCreator object after updating progress of playback

  • Set the playback starting timestamp

    Declaration

    Swift

    public func putStartTime(time : Double) -> PlayerEventCreator

    Parameters

    time

    Playback starting timestamp

    Return Value

    PlayerEventCreator object after updating startTime of playback

  • Set the playback ending timestamp

    Declaration

    Swift

    public func putEndTime(time : Double) -> PlayerEventCreator

    Parameters

    time

    Playback ending timestamp

    Return Value

    PlayerEventCreator object after updating playback endTime

  • Set the subtitle language

    Declaration

    Swift

    public func putSubtitleLanguage(aLangCode : String) -> PlayerEventCreator

    Parameters

    aLangCode

    Subtitle language

    Return Value

    PlayerEventCreator object after updating subtitle language

  • Set the audio language

    Declaration

    Swift

    public func putAudioLanguage(aLangCode : String) -> PlayerEventCreator

    Parameters

    aLangCode

    Audio language

    Return Value

    PlayerEventCreator object after updating Audio language

  • Set the content genre

    Declaration

    Swift

    public func putGenre(genre : String) -> PlayerEventCreator

    Parameters

    genre

    Content genre

    Return Value

    PlayerEventCreator object after updating content genre

  • Creates EngageEvent representing playback start

    Declaration

    Swift

    public func onPlaybackStarted() -> EngageEvent

    Return Value

    EngageEvent representing playback start

  • Creates EngageEvent representing playback resume

    Declaration

    Swift

    public func onPlaybackResumed() -> EngageEvent

    Return Value

    EngageEvent representing playback resume

  • Creates EngageEvent representing playback pause

    Declaration

    Swift

    public func onPlaybackPaused() -> EngageEvent

    Return Value

    EngageEvent representing playback pause

  • Creates EngageEvent representing playback buffering

    Declaration

    Swift

    public func onPlaybackBuffering() -> EngageEvent

    Return Value

    EngageEvent representing playback buffering

  • Creates EngageEvent representing playback seek

    Declaration

    Swift

    public func onPlaybackSeek() -> EngageEvent

    Return Value

    EngageEvent representing playback seek

  • Creates EngageEvent representing playback stop

    Declaration

    Swift

    public func onPlaybackStopped() -> EngageEvent

    Return Value

    EngageEvent representing playback stop

  • Creates EngageEvent representing playback complete

    Declaration

    Swift

    public func onPlaybackCompleted() -> EngageEvent

    Return Value

    EngageEvent representing playback complete

  • Creates EngageEvent representing playback error

    Declaration

    Swift

    public func onPlaybackError() -> EngageEvent

    Return Value

    EngageEvent representing playback error

  • Creates EngageEvent representing audio/video/subtitle track change

    Declaration

    Swift

    public func onTrackChange() -> EngageEvent

    Return Value

    EngageEvent representing audio/video/subtitle track change