Articles in this section

See more

Akamai Adaptive Media Player tvOS

Avatar
Tony Gentile
  • Updated
Follow

Datazoom’s framework facilitates tvOS applications using the Akamai Adaptive Media Player tvOS player to send video playback events based on the configuration created in data pipes.


  1. Login to Datazoom here:  https://app.datazoom.io
  2. Add a Collector as indicated here:  How to add a Collector

  3. Copy the config key that was created at the end of the process
    Click the icon indicated below to copy the Configuration Key

    You will see this message:

     4. Replace the <configuration id from Datazoom>in Datazoom's DZAkamai.framework file with the Key you copied above.

     5. Replace the <url given by Datazoom> with <https://platform.datazoom.io/beacon/v1/>

     6. Replace the <AMPPlayer object> with your playerInstance identifier 

Prerequisites

Installation

  • Open the terminal and check if Cocoapods is installed in your machine.

    pod --version

  • If the above command returns no version number, then you'll need to install CocoaPods. 

    sudo gem install cocoapods

  • After installation, navigate to the Xcode project directory and create a Podfile configuration file if not present.

    pod init

  • Run the command:

    open Podfile

  • Add the DZAkamaiTvOS framework after use_frameworks! in the Podfile

     pod 'DZAkamaiTvOS', '1.12.0', :source => 'https://gitlab.com/datazoom/pod-specs.git'

  • Add the AmpCore framework in the Podfile

    pod 'AmpCore'

  • Pull and update the latest Cocoapods pod specs

    pod repo update

  • Install the pods

    pod install
  • Be sure to close any current Xcode sessions and use `your_project_name.xcworkspace` for this project from now on.

Implementation Steps for Swift Language-based Applications

  • Open the ViewController/View file, where the AMPPlayer(Akamai Player) is included.

  • Import the framework using the following command:

    import DZAkamaiTVOSCollector

  • Initialize the framework by passing along the env (any one of DEV, STAGING, PROD) "Configuration ID", and player instance:

     DZAkamaiTvOsCollectorInstance.shared.initialize(dzEnv.PROD, <configuration id from Datazoom>, <AMPPlayer object>, onCompletion: {})

Custom Metadata

Datazoom allows customers to collect custom events and metadata that aren't emitted from the video player.

Custom Metadata

  • The customer should add the following snippet just after calling the DZAkamaiTvOsCollectorInstance.shared.initialize

    DZAkamaiTvOsCollectorInstance.shared.setCustomMetaData(["customMetadataName": "customMetadataValue"])


    Example:

    func setupCustomMetadata(){
	 DZAkamaiTvOsCollectorInstance.shared.setCustomMetaData([
				"customPlayerName" : "Akamai tvOS Player",
					 "customDomain": "https://datazoom.io"
			])
}


Custom Events

  • Send  Events like below:

    DZAkamaiTvOsCollectorInstance.shared.sendCustomEvent("Custom_Event_Name", ["customMetadataName": "customMetadataValue"])


    Example:

    func buttonTouched() {       
  DZAkamaiTvOsCollectorInstance.shared.sendCustomEvent("buttonClick", ["buttonLabel": "ViewCredits"])        
}

Demo Application


Related articles

Comments

0 comments

Article is closed for comments.