PlaybackEventBuilder
PlaybackEventオブジェクトを作成するためのビルダー。
コンストラクタ
new PlaybackEventBuilder()
new PlaybackEventBuilder(): PlaybackEventBuilder
戻り値
メソッド
buildActiveEvent()
buildActiveEvent():
PlaybackEvent
デバイス上で発生した再生イベント用に、ビルダーに設定されたフィールドを使用してPlaybackEventオブジェクトを構築します。EventTimestampを設定していない場合、現在の時刻が設定されます。VODコンテンツの場合、contentIdを設定する必要があります。リニア/ライブコンテンツの場合、liveStationIdまたはchannelDescriptorのいずれかを設定する必要がありますが、contentIDを追加で設定することもできます。
エラー
- 必須フィールドが設定されていない場合、
InvalidArgumentErrorがスローされます。
戻り値
PlaybackEvent
PlaybackEvent：作成されたPlaybackEventオブジェクト。
buildOffDeviceEvent()
buildOffDeviceEvent():
PlaybackEvent
デバイス外で発生した再生イベント用に、ビルダーに設定されたフィールドを使用してPlaybackEventオブジェクトを構築します。VODコンテンツの場合、contentIdを設定する必要があります。リニア/ライブコンテンツの場合、liveStationIdまたはchannelDescriptorのいずれかを設定する必要がありますが、contentIDを追加で設定することもできます。
エラー
- 必須フィールドが設定されていない場合、
InvalidArgumentErrorがスローされます。
戻り値
PlaybackEvent
PlaybackEvent：作成されたPlaybackEventオブジェクト。
channelDescriptor()
channelDescriptor(channelDescriptor:
IChannelDescriptor): PlaybackEventBuilder
コンテンツを再生しているリニアチャンネルのチャンネル記述子を設定します。チャンネル記述子は、アプリパッケージ内のすべてのチャンネルについて、各チャンネルを一意に識別します。このチャンネル記述子は、ライブTV統合に使用するものと一致する必要があります。
このフィールドは、Kepler EPGプロバイダーAPIを使用して統合されたコンテンツがライブTVリニアチャンネルの中で再生される場合にのみ必須です。
パラメーター
channelDescriptor
IChannelDescriptor
コンテンツを再生しているチャンネルを一意に識別する記述子。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
contentId()
contentId(contentId: IContentId): PlaybackEventBuilder
再生される（選択したカタログで解決可能な）コンテンツのIDを設定します。
このフィールドは、VODコンテンツでは必須で、リニア/ライブコンテンツでは任意です。
パラメーター
contentId
選択したカタログで解決できるID。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
creditsPositionMs()
creditsPositionMs(creditsPositionMs:
number): PlaybackEventBuilder
コンテンツ内のクレジットの位置を0からのオフセットで設定します。視聴の完了度を判断するために使用します。
パラメーター
creditsPositionMs
number
クレジットの位置（ミリ秒）。
エラー
- 位置が0より小さい場合、
InvalidArgumentErrorがスローされます。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
durationMs()
durationMs(durationMs:
number): PlaybackEventBuilder
コンテンツの再生時間を設定します。
パラメーター
durationMs
number
コンテンツの再生時間（ミリ秒）。
エラー
- 位置が0より小さい場合、
InvalidArgumentErrorがスローされます。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
eventTimestamp()
eventTimestamp(eventTimestamp:
Date): PlaybackEventBuilder
再生イベントが発生した日付を設定します。再生イベントが同じデバイス上で発生したものではない場合、これは必須フィールドです。このフィールドを設定しない場合、buildOffDeviceEvent()は失敗します。
パラメーター
eventTimestamp
Date
イベントが発生した日付。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
liveStationId()
liveStationId(liveStationId: IContentId): PlaybackEventBuilder
コンテンツが再生されるリニアステーションのIDを設定します。このフィールドは、コンテンツがライブTVリニアチャンネルの中で再生される場合にのみ必要です。1.3.0
パラメーター
liveStationId
コンテンツが再生されるリニアステーションのID。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
playbackEvent()
playbackEvent(playbackEvent: IPlaybackEvent): PlaybackEventBuilder
既存のplaybackEventの値を使用して、PlaybackEventBuilderを初期化します。
パラメーター
playbackEvent
ビルダーの初期化に値が使用される再生イベント。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
playbackPositionMs()
playbackPositionMs(playbackPositionMs:
number): PlaybackEventBuilder
ユーザーが再生しているコンテンツの現在の位置を0からのオフセットで設定します。これは必須フィールドです。このフィールドを設定しない場合、buildActiveEvent()とbuildOffDeviceEvent()は失敗します。
パラメーター
playbackPositionMs
number
現在の位置（ミリ秒）。
エラー
playbackPositionMsが0より小さい場合、InvalidArgumentErrorがスローされます。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
playbackState()
playbackState(playbackState: PlaybackState): PlaybackEventBuilder
コンテンツに対するユーザーの現在の視聴状態を設定します。これは必須フィールドです。このフィールドを設定しない場合、buildActiveEvent()とbuildOffDeviceEvent()は失敗します。
パラメーター
playbackState
現在の視聴状態。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
profileId()
profileId(profileId: IProfileId): PlaybackEventBuilder
コンテンツを視聴しているユーザーに関連付けられたprofileIdを設定します。
パラメーター
profileId
ユーザーに関連付けられたprofileId。
戻り値
PlaybackEventBuilder：現在のPlaybackEventBuilderオブジェクト。
Last updated: 2026年8月2日
