MediaSession

Class: Media

The MediaSession class provides methods for tracking streaming media in apps through the use of custom events. Learn more about media tracking.

The following summarizes the commonly used methods of the MediaSession class for Tealium iOS (Swift).

bitrate()

Sets the quality of experience bitrate value (Int) in kilobits per second (kbps) of the current session.

mediaSession.bitrate = BITRATE_VALUE

clickAd()

The user clicked on a ad that is currently playing.

mediaSession.clickAd()

custom()

Sends a custom event status to the data layer.

mediaSession.custom(name)

endAd()

The ad ended.

mediaSession.endAd()

endAdBreak()

The ad break ended.

mediaSession.endAdBreak()

endBuffer()

The buffer ended.

mediaSession.endBuffer()

endChapter()

The chapter ended.

mediaSession.endChapter()

endSeek()

The user ended seeking. Records seek ended at given position.

mediaSession.endSeek(at position: Int)

Example:

mediaSession.endSeek(at position: 10)

endSession()

The session ended, including ads and content.

mediaSession.endSession()

pause()

The user paused the media.

mediaSession.pause()

ping()

Sends an interval event to the data layer. This method is called automatically every 10 seconds if the tracking type for the MediaContent object is set to interval or intervalMilestone.

mediaSession.ping()

Learn more about media tracking types.

play()

The media content started playing.

mediaSession.play()

playerstate

The start or end of the player state.

mediaSession.playerState = PLAYER_STATE

The following State constants are available:

Example:

mediaSession.playerState = .mute

Learn more about the player state.

resumeSession()

The session resumed.

mediaSession.resumeSession()

sendMilestone()

Sends a milestone event to the data layer. This method is called automatically, based on the percent of content played, the tracking type for the MediaContent object is set to milestone or intervalMilestone.

mediaSession.sendMilestone(_ milestone: Milestone)

Milestone values:

Learn more about media tracking types.

sendSummary()

Sends summary data to the data layer. This method is called automatically on endSession() if the tracking type for the MediaContent object is set to summary.

mediaSession.sendSummary()

Learn more about media tracking types.

skipAd()

The user skipped the current ad.

mediaSession.skipAd()

skipChapter()

The user skipped the chapter.

mediaSession.skipChapter()

startAd()

The ad started. Call the endAd() method when the ad completes.

mediaSession.startAd(_ ad: Ad)

Example:

let ad = Ad(name = "Ad 1")
session.startAd(ad)

startAdBreak()

The ad break started. Call the endAdBreak() method when the ad break completes.

mediaSession.startAdBreak(_ break: AdBreak)

Example:

let adBreak = AdBreak(name = "Ad Break 1")
mediaSession.startAdBreak(adBreak)

startBuffer()

The buffer started. Call the endBuffer() method when the buffering completes.

mediaSession.startBuffer()

startChapter()

The chapter started. Call the endChapter() method when the chapter completes.

mediaSession.startChapter(_ chapter: Chapter)

Example:

let chapterOne = Chapter(name = "Chapter 1")
mediaSession.startChapter(chapterOne)

startSeek()

The user started seeking. Call the endSeek() method when seeking completes.

mediaSession.startSeek(at position: Int)

Example:

mediaSession.startSeek(at position: 10)

startSession()

The session started. Call the endSession() method when session completes.

mediaSession.startSession()

Class: MediaContent

The MediaContent class creates an media content object.

let media = MediaContent(
  uuid: MEDIA_UUID,
  name: MEDIA_NAME,
  streamType: MEDIA_STREAM_TYPE,
  mediaType: MEDIA_TYPE,   
  qoe: MEDIA_QOE,
  trackingType: MEDIA_TRACKING_TYPE,
  milestoneInterval: MEDIA_MILESTONE,
  contentCompletePercentage: MEDIA_CONTENT_COMPLETE_PERCENTAGE,
  startTime = MEDIA_START_TIME,
  state = MEDIA_STATE,
  customID = MEDIA_CUSTOM_ID,
  duration: MEDIA_DURATION,
  playerName: MEDIA_PLAYER_NAME,
  channelName: MEDIA_CHANNEL_NAME,
  metadata: MEDIA_METADATA,
  milestone: MEDIA_MILESTONE,
  summary: MEDIA_SUMMARY,
  adBreaks: MEDIA_AD_BREAKS,
  ads: MEDIA_ADS,
  chapters: MEDIA_CHAPTERS
)

Struct: Ad

The Ad struct creates an ad object.

let ad = Ad(
  uuid: MEDIA_AD_UUID,
  name: MEDIA_AD_NAME,
  id: MEDIA_AD_ID,
  duration: MEDIA_AD_DURATION,
  position: MEDIA_AD_POSITION,
  advertiser: MEDIA_AD_ADVERTISER,
  creativeId: MEDIA_AD_CREATIVE_ID,
  campaignId: MEDIA_AD_CAMPAIGN_ID,
  placementId: MEDIA_AD_PLACEMENT_ID,
  siteId: MEDIA_AD_SITE_ID,
  creativeUrl: MEDIA_AD_CREATIVE_URL,
  numberOfLoads: MEDIA_AD_LOAD,
  pod: MEDIA_AD_POD,
  playerName: MEDIA_AD_PLAYER_NAME
)

Struct: AdBreak

The AdBreak struct creates an ad break object.

let adBreak = AdBreak(
  uuid: MEDIA_AD_BREAK_UUID,
  name: MEDIA_AD_BREAK_NAME,
  id: MEDIA_AD_BREAK_ID,
  duration: MEDIA_AD_BREAK_DURATION,
  position: MEDIA_AD_BREAK_POSITION,
  startTime: MEDIA_AD_BREAK_START_TIME
)

Struct: Chapter

The Chapter struct creates a chapter object.

let chapterObject = Chapter(
  name: MEDIA_CHAPTER_NAME,
  duration: MEDIA_CHAPTER_DURATION,
  position: MEDIA_CHAPTER_POSITION,
  startTime: MEDIA_CHAPTER_START_TIME,
  metadata: MEDIA_CHAPTER_METADATA
)

The following are the Chapter object parameters. Parameters must be in order if you are not using parameter names, such as duration:, when creating the object.