LiveEvent

Class object representation of LiveEvent object which will be built using LiveEventBuilder.

Not exported from index.ts

Implements

• ILiveEvent

Constructors

new LiveEvent()

new LiveEvent(identifier, eventType, playbackReference, title, description, ratings, genres, logoUrl, posterArtUrl, attributes, sortRank, startTimeMs?, endTimeMs?): LiveEvent

Constructor function called for initialization of a LiveEvent.

Parameters

identifier

string

eventType

EventType

playbackReference

IPlaybackReference

title

string

description

string = ''

ratings

string[] = []

genres

string[] = []

logoUrl

string = ''

posterArtUrl

string = ''

attributes

string[] = []

sortRank

number = MAX_INT32_VALUE

startTimeMs?

number

endTimeMs?

number

Returns

LiveEvent

Accessors

attributes

Get Signature

get attributes(): string[]

Gets the list of attributes for the live event.

Details

Attributes are properties of the live event. Please refer to the developer guide for a recommended list of canonical values for this field.

Returns

string[]

The list of attributes of the live event.

Implementation of

ILiveEvent.attributes

---

description

Get Signature

get description(): string

Gets the brief description of the live event.

Returns

string

The brief description for the specific live event. Empty string is returned if there is no description associated with this live event.

Implementation of

ILiveEvent.description

---

endTimeMs

Get Signature

get endTimeMs(): undefined | number

Gets the end time of the live event, if one is specified.

Returns

undefined | number

End time of the live event in milliseconds since epoch.

Implementation of

ILiveEvent.endTimeMs

---

eventType

Get Signature

get eventType(): EventType

Gets the type of the live event.

Returns

EventType

The type of the live event.

Implementation of

ILiveEvent.eventType

---

genres

Get Signature

get genres(): string[]

Gets the list of genres for the live event.

Returns

string[]

The list of genres that apply to the live event. Please refer to the developer guide for a recommended list of canonical values for this field.

Implementation of

ILiveEvent.genres

---

identifier

Get Signature

get identifier(): string

Gets the unique identifier of the live event.

Returns

string

The unique identifier for the live event. The identifier is unique across all live events within the application package.

Implementation of

ILiveEvent.identifier

---

logoUrl

Get Signature

get logoUrl(): string

Gets the logo url for the live event.

Returns

string

The url where the logo image can be found. Used to render the event logo. Empty string is returned if there is no thumbnail url associated with this live event.

Implementation of

ILiveEvent.logoUrl

---

playbackReference

Get Signature

get playbackReference(): IPlaybackReference

Gets the playback reference associated with the live event, which describes how to start playback.

Returns

IPlaybackReference

The playback reference of the live event.

Implementation of

ILiveEvent.playbackReference

---

posterArtUrl

Get Signature

get posterArtUrl(): string

Gets the poster art url for the live event.

Returns

string

The url where the poster art image can be found. Used to render the event tile and background when live preview is not available. Empty string is returned if there is no poster art url associated with this live event.

Implementation of

ILiveEvent.posterArtUrl

---

ratings

Get Signature

get ratings(): string[]

Gets the list of ratings for the live event.

Returns

string[]

The list of strings used to indicate the level of parental guidance recommended for a particular live event. This can be any rating system used in the country or region where the live event is broadcasted. Please refer to the developer guide for a recommended list of canonical values for this field.

Implementation of

ILiveEvent.ratings

---

sortRank

Get Signature

get sortRank(): number

Gets the sort rank of the live event.

Details

Live events with lower integer values for the sort rank will be displayed before live events with higher sort rank values in the row for this app. This is set to MAX Int32 by default if none was provided. If two or more live events have the same sort rank, they will be sorted alphabetically by their titles.

Returns

number

The sort rank of this live event relative to other live events.

Implementation of

ILiveEvent.sortRank

---

startTimeMs

Get Signature

get startTimeMs(): undefined | number

Gets the start time of the live event, if one is specified.

Returns

undefined | number

Start time of the live event in milliseconds since epoch.

Implementation of

ILiveEvent.startTimeMs

---

title

Get Signature

get title(): string

Gets the title of the live event.

Returns

string

The title or name for the specific live event.

Implementation of

ILiveEvent.title

---

Last updated: Sep 30, 2025