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

TCMediaEvent

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

Represents a media event to be sent to Commanders Act. This class extends TCCustomEvent and adds specific properties for media tracking.

Constructors

TCMediaEvent

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

Properties

assets

val assets: Map<String, String>

A map representing additional data associated with the event.

audioTrackHasAudioDescription

var audioTrackHasAudioDescription: Boolean

Indicates whether the current audio track has an associated audio description.

audioTrackLanguage

var audioTrackLanguage: String?

Represents the language of the currently selected audio track.

deviceVolume

var deviceVolume: Float?

Represents the device's volume level as a percentage.

eventType

val eventType: MediaEventType

The type of media event, defined by the Analytics team using the MediaEventType enum.

googleCast

var googleCast: Boolean

Tell if the player is considered as a GoogleCast receiver. GoogleCast senders should not update this value.

isSubtitlesOn

var isSubtitlesOn: Boolean

Indicates whether subtitles are enabled.

jsonObject

open override val jsonObject: JSONObject

mediaPosition

var mediaPosition: Duration

Represents the current playback position.

source

val source: CommandersActSource?

the CommandersActSource of the event.

subtitleSelectionLanguage

var subtitleSelectionLanguage: String?

Represents the language of the currently selected subtitle track.

timeShift

var timeShift: Duration?

Represents the time shift applied if it is a live stream, null otherwise.

Inherited properties

additionalProperties

open val additionalProperties: ConcurrentHashMap<String?, Any?>?

name

open val name: String?

pageName

var pageName: String?

pageType

var pageType: String?

Functions

getJsonObject

open override fun getJsonObject(): JSONObject

Inherited functions

addAdditionalParameter

open fun ~~addAdditionalParameter~~(store: TCDynamicStore?)

open fun ~~addAdditionalParameter~~(key: String?, value: String?)

open fun ~~addAdditionalParameter~~(key: String?, value: JSONObject?)

addAdditionalProperty

open fun addAdditionalProperty(store: TCDynamicStore?)

open fun addAdditionalProperty(key: String?, value: BigDecimal?)

open fun addAdditionalProperty(key: String?, value: Boolean?)

open fun addAdditionalProperty(key: String?, value: Float?)

open fun addAdditionalProperty(key: String?, value: Int?)

open fun addAdditionalProperty(key: String?, value: String?)

open fun addAdditionalProperty(key: String?, value: List<JSONObject?>?)

open fun addAdditionalProperty(key: String?, value: JSONObject?)

clearAdditionalProperties

open fun clearAdditionalProperties()

getItemListAsJson

open fun getItemListAsJson(items: List<TCItem?>?): JSONArray?

getListAsJson

open fun getListAsJson(stringList: List<String?>?): JSONArray?

removeAdditionalProperty

open fun removeAdditionalProperty(key: String?)

testString

open fun testString(var: String?): Boolean

verifyEvent

open fun verifyEvent(): Boolean