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

TCMediaEvent

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

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

Constructors

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

Properties

Link copied to clipboard
Link copied to clipboard
val assets: Map<String, String>

A map representing additional data associated with the event.

Link copied to clipboard
var audioTrackHasAudioDescription: Boolean

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

Link copied to clipboard
var audioTrackLanguage: String?

Represents the language of the currently selected audio track.

Link copied to clipboard
var deviceVolume: Float?

Represents the device's volume level as a percentage.

Link copied to clipboard
val eventType: MediaEventType

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

Link copied to clipboard
var isSubtitlesOn: Boolean

Indicates whether subtitles are enabled.

Link copied to clipboard
open override val jsonObject: JSONObject
Link copied to clipboard
var mediaPosition: Duration

Represents the current playback position.

Link copied to clipboard
open val name: String?
Link copied to clipboard
open var pageName: String?
Link copied to clipboard
open var pageType: String?
Link copied to clipboard
val sourceId: String?

An optional identifier for the source of the event.

Link copied to clipboard
var subtitleSelectionLanguage: String?

Represents the language of the currently selected subtitle track.

Link copied to clipboard
var timeShift: Duration?

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

Functions

Link copied to clipboard
open fun addAdditionalParameter(p0: TCDynamicStore?)
open fun addAdditionalParameter(p0: String?, p1: String?)
open fun addAdditionalParameter(p0: String?, p1: JSONObject?)
Link copied to clipboard
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: List<JSONObject?>?)
open fun addAdditionalProperty(p0: String?, p1: JSONObject?)
Link copied to clipboard
Link copied to clipboard
open fun getItemListAsJson(p0: List<TCItem?>?): JSONArray?
Link copied to clipboard
open override fun getJsonObject(): JSONObject
Link copied to clipboard
open fun getListAsJson(p0: List<String?>?): JSONArray?
Link copied to clipboard
Link copied to clipboard
open fun testString(p0: String?): Boolean
Link copied to clipboard
open fun verifyEvent(): Boolean