pillarbox-analytics/ch.srgssr.pillarbox.analytics.commandersact/TCMediaEvent

TCMediaEvent

class TCMediaEvent(val eventType: MediaEventType, val assets: Map<String, String>, val sourceId: String? = null) : TCCustomEvent

CommandersAct media event

Constructors

constructor(eventType: MediaEventType, assets: Map<String, String>, sourceId: String? = null)

Properties

additionalProperties

val additionalProperties: ConcurrentHashMap<String, Any>

val assets: Map<String, String>

Assets to populate with key,values.

audioTrackHasAudioDescription

var audioTrackHasAudioDescription: Boolean

Audio track has audio description

audioTrackLanguage

var audioTrackLanguage: String?

Selected audio language if any

var deviceVolume: Float?

Device volume in percentage

val eventType: MediaEventType

Media event type defined by Analytics team.

var isSubtitlesOn: Boolean

Is subtitles on

var mediaPosition: Duration

Current Media position

var pageName: String

var pageType: String

val sourceId: String? = null

an optional sourceId.

subtitleSelectionLanguage

var subtitleSelectionLanguage: String?

Selected subtitle language if any

var timeShift: Duration?

Time shift if applicable

Functions

addAdditionalParameter

open fun ~~addAdditionalParameter~~(p0: TCDynamicStore)

open fun ~~addAdditionalParameter~~(p0: String, p1: String)

open fun ~~addAdditionalParameter~~(p0: String, p1: JSONObject)

addAdditionalParameterIfNotBlank

fun TCEvent.addAdditionalParameterIfNotBlank(key: String, data: String?)

Add additional parameter if not blank

addAdditionalProperty

open fun addAdditionalProperty(p0: TCDynamicStore)

open fun addAdditionalProperty(p0: String, p1: BigDecimal)

open fun addAdditionalProperty(p0: String, p1: Boolean)

open fun addAdditionalProperty(p0: String, p1: Float)

open fun addAdditionalProperty(p0: String, p1: Int)

open fun addAdditionalProperty(p0: String, p1: String)

open fun addAdditionalProperty(p0: String, p1: MutableList<JSONObject>)

open fun addAdditionalProperty(p0: String, p1: JSONObject)

clearAdditionalProperties

open fun clearAdditionalProperties()

getItemListAsJson

open fun getItemListAsJson(p0: MutableList<TCItem>): JSONArray

open override fun getJsonObject(): JSONObject

open fun getListAsJson(p0: MutableList<String>): JSONArray

open fun getName(): String

removeAdditionalProperty

open fun removeAdditionalProperty(p0: String)

open fun testString(p0: String): Boolean

open override fun verifyEvent(): Boolean