LiveEvent

一个类对象，表示LiveEvent对象，使用LiveEventBuilder构建。

未从index.ts导出

实现

• ILiveEvent

构造函数

new LiveEvent()

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

一个构造函数，用来初始化LiveEvent。

参数

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

返回值

LiveEvent

访问器

attributes

获取签名

get attributes(): string[]

获取直播活动的属性列表。

详情

属性指直播活动的属性。请参阅开发者指南，了解该字段的推荐规范值列表。

返回值

string[]

直播活动的属性列表。

实现

ILiveEvent.attributes

---

description

获取签名

get description(): string

获取直播活动的简要描述。

返回值

string

特定直播活动的简要描述。如果没有与此直播活动相关的描述，则返回空字符串。

实现

ILiveEvent.description

---

endTimeMs

获取签名

get endTimeMs(): undefined | number

获取直播活动的结束时间（如果已指定）。

返回值

undefined | number

直播活动的结束时间，从纪元开始以毫秒为单位。

实现

ILiveEvent.endTimeMs

---

eventType

获取签名

get eventType(): EventType

获取直播活动的类型。

返回值

EventType

直播活动的类型。

实现

ILiveEvent.eventType

---

genres

获取签名

get genres(): string[]

获取直播活动的类型列表。

返回值

string[]

适用于直播活动的类型清单。请参阅开发者指南，了解该字段的推荐规范值列表。

实现

ILiveEvent.genres

---

identifier

获取签名

get identifier(): string

获取直播活动的唯一标识符。

返回值

string

直播活动的唯一标识符。标识符在应用程序包内的所有直播活动中是唯一的。

实现

ILiveEvent.identifier

---

logoUrl

获取签名

get logoUrl(): string

获取直播活动的标志URL。

返回值

string

可供找到标志图片的URL。用于渲染活动标志。如果没有与此直播活动相关的缩略图URL，则返回空字符串。

实现

ILiveEvent.logoUrl

---

playbackReference

获取签名

get playbackReference(): IPlaybackReference

获取与直播活动相关的播放参考，用于描述如何开始播放。

返回值

IPlaybackReference

直播活动的播放参考。

实现

ILiveEvent.playbackReference

---

posterArtUrl

获取签名

get posterArtUrl(): string

获取直播活动的海报图URL。

返回值

string

可供找到海报图片的URL。用于在实时预览不可用时渲染事件图块和背景。如果没有与此直播活动相关的海报图URL，则返回空字符串。

实现

ILiveEvent.posterArtUrl

---

ratings

获取签名

get ratings(): string[]

获取直播活动的评级列表。

返回值

string[]

字符串列表，用于表示针对特定直播活动而提供的家长指导级别建议。这可以是播出直播活动的国家或地区使用的任何评级系统。请参阅开发者指南，了解该字段的推荐规范值列表。

实现

ILiveEvent.ratings

---

sortRank

获取签名

get sortRank(): number

获取直播活动的排名。

详情

在此应用的行中，排名值（整数）越小的直播活动越靠前显示。如果未提供，则默认设置为MAX Int32。如果两个或更多直播活动的排名相同，则按标题的字母顺序进行排序。

返回值

number

此直播活动相对于其他直播活动的排名。

实现

ILiveEvent.sortRank

---

startTimeMs

获取签名

get startTimeMs(): undefined | number

获取直播活动的开始时间（如果已指定）。

返回值

undefined | number

直播活动的开始时间，从纪元开始以毫秒为单位。

实现

ILiveEvent.startTimeMs

---

title

获取签名

get title(): string

获取直播活动的标题。

返回值

string

特定直播活动的标题或名称。

实现

ILiveEvent.title

---

Last updated: 2025年9月30日