as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
AWS
ドキュメント
Support
Contact Us
My Cases
開発
設計と開発
公開
リファレンス
サポート

LiveEvent

LiveEvent

LiveEventBuilderを使用してビルドされるLiveEventオブジェクトのクラスオブジェクト表現。

index.tsからはエクスポートされません

実装

コンストラクタ

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

説明

string = ''

ratings

string[] = []

genres

string[] = []

logoUrl

string = ''

posterArtUrl

string = ''

attributes

string[] = []

sortRank

number = MAX_INT32_VALUE

startTimeMs?

number

endTimeMs?

number

戻り値

LiveEvent

アクセサ

attributes

getのシグネチャ

get attributes(): string[]

ライブイベントの属性リストを取得します。

詳細

属性はライブイベントのプロパティです。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。

戻り値

string[]

ライブイベントの属性のリスト。

実装元

ILiveEvent.attributes


説明

getのシグネチャ

get description(): string

ライブイベントの簡単な説明を取得します。

戻り値

string

特定のライブイベントの簡単な説明。このライブイベントに説明が関連付けられていない場合は、空の文字列が返されます。

実装元

ILiveEvent.description


endTimeMs

getのシグネチャ

get endTimeMs(): undefined | number

指定されている場合、ライブイベントの終了時刻を取得します。

戻り値

undefined | number

ライブイベントの終了時刻(エポックミリ秒単位)。

実装元

ILiveEvent.endTimeMs


eventType

getのシグネチャ

get eventType(): EventType

ライブイベントのタイプを取得します。

戻り値

EventType

ライブイベントのタイプ。

実装元

ILiveEvent.eventType


genres

getのシグネチャ

get genres(): string[]

ライブイベントのジャンルリストを取得します。

戻り値

string[]

ライブイベントに適用されるジャンルのリスト。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。

実装元

ILiveEvent.genres


identifier

getのシグネチャ

get identifier(): string

ライブイベントの一意の識別子を取得します。

戻り値

string

ライブイベントの一意の識別子。この識別子は、アプリケーションパッケージ内のすべてのライブイベントで一意です。

実装元

ILiveEvent.identifier


logoUrl

getのシグネチャ

get logoUrl(): string

ライブイベントのロゴURLを取得します。

戻り値

string

ロゴ画像が表示されるURL。イベントロゴのレンダリングに使用されます。このライブイベントにサムネイルURLが関連付けられていない場合は、空の文字列が返されます。

実装元

ILiveEvent.logoUrl


playbackReference

getのシグネチャ

get playbackReference(): IPlaybackReference

ライブイベントに関連する再生リファレンスを取得します。再生を開始する方法が記述されています。

戻り値

IPlaybackReference

ライブイベントの再生リファレンス。

実装元

ILiveEvent.playbackReference


posterArtUrl

getのシグネチャ

get posterArtUrl(): string

ライブイベントのポスターアートURLを取得します。

戻り値

string

ポスターアート画像が表示されるURL。ライブプレビューが利用できない場合に、イベントタイルと背景をレンダリングするために使用されます。このライブイベントにポスターアートのURLが関連付けられていない場合は、空の文字列が返されます。

実装元

ILiveEvent.posterArtUrl


ratings

getのシグネチャ

get ratings(): string[]

ライブイベントのレーティングリストを取得します。

戻り値

string[]

特定のライブイベントで推奨される保護者による指導レベルを示すために使用される文字列のリスト。ライブイベントが放送される国や地域で使用されている任意のレーティングシステムに従うことができます。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。

実装元

ILiveEvent.ratings


sortRank

getのシグネチャ

get sortRank(): number

ライブイベントの並べ替えランクを取得します。

詳細

このアプリの行では、並べ替えランクの整数値が小さいライブイベントが、並べ替えランクの値が大きいライブイベントよりも前に表示されます。何も指定されていない場合、デフォルトでMAX Int32に設定されます。並べ替えランクが同じライブイベントが複数ある場合は、タイトルのアルファベット順に並べられます。

戻り値

number

このライブイベントを他のライブイベントと比較した場合の並べ替えランク。

実装元

ILiveEvent.sortRank


startTimeMs

getのシグネチャ

get startTimeMs(): undefined | number

指定されている場合、ライブイベントの開始時刻を取得します。

戻り値

undefined | number

ライブイベントの開始時刻(エポックミリ秒単位)。

実装元

ILiveEvent.startTimeMs


title

getのシグネチャ

get title(): string

ライブイベントのタイトルを取得します。

戻り値

string

特定のライブイベントのタイトルまたは名前。

実装元

ILiveEvent.title


Last updated: 2025年9月30日