クラス: BreakManager

cast.framework.breaks.BreakManager

class   static

休憩を管理するためのクラス。

Methods

addBreak

addBreak（breakData、breakClips、broadCastMediaStatus）はブール値を返す

動的ブレーク クリップとブレーク クリップを追加しました。 ブレーク クリップはブレークに関連付けられます（break.breakClipIds と break.duration はクリップに応じて更新されます）。

パラメータ

breakData

cast.framework.messages.Break

値を null にすることはできません。

ブレーククリップ

null 以外の cast.framework.messages.BreakClip の配列

値を null にすることはできません。

部分一致のメディアステータス

省略可

ブール値

現在の中断ステータスが変更されているかどうかを CAF が確認する必要があるかどうか。これは、再生開始前（受信完了時など）にレシーバーによる追加処理が必要になる可能性があるため、好ましくない場合があります。
戻り値

boolean 広告ブレークが正常に追加された場合は true。

getBreakById

getBreakById(id) は cast.framework.messages.Break を返します。

ID で現在のメディア ブレークを取得します。

パラメータ

id

string

広告ブレーク ID
戻り値

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) は cast.framework.messages.BreakClip を返します。

現在のメディア ブレーク クリップを ID で取得します。

パラメータ

id

string

クリップ ID。
戻り値

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() は数値を返す

現在再生中のブレーククリップ内の現在時間を秒単位で返します。

戻り値

nullable number 現在の区切りクリップ内の現在時刻（秒）。プレーヤーがブレーククリップを再生していない場合は null。

getBreakClipDurationSec

getBreakClipDurationSec() は数値を返す

現在再生中のブレーククリップの再生時間（秒）を返します。

戻り値

nullable number 現在のブレーク クリップの長さ。プレーヤーがブレーククリップを再生していない場合は null。

getBreakClips

getBreakClips() は、null 以外の cast.framework.messages.BreakClip の配列を返します。

現在のメディア ブレーク クリップを取得します。

戻り値

non-null Array of non-null cast.framework.messages.BreakClip 

getBreaks

getBreaks() は、null 以外の cast.framework.messages.Break の配列を返します

現在のメディアブレークを取得します。

戻り値

non-null Array of non-null cast.framework.messages.Break 

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) は cast.framework.breaks.CreativeInformation を返す

ID により、ブレーククリップに関連付けられているクリエイティブ情報を取得します。

パラメータ

breakClipId

string

クリップ ID。
戻り値

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() はブール値を返す

監視対象ブレークを再生する必要がある場合は true を返します。

戻り値

boolean 

removeBreakById

removeBreakById(breakId) はブール値を返します

休憩や関連する中断のクリップを削除します。

パラメータ

BreakId

string

広告ブレーク ID
戻り値

boolean 広告ブレークが正常に削除された場合は true。

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor（インターセプタ）

デベロッパーがブレーク開始前にブレーククリップの挿入や現在のブレーク クリップの変更を行えるように、インターセプタを提供します。

インターセプタが null の場合、インターセプタはデフォルトにリセットされます。デフォルトでは、VAST のフェッチと解析のロジックがデフォルトのインターセプタで行われます。カスタマイズしたインターセプタがデベロッパーによって設定されている場合、VAST ロジックはオーバーライドされます。デベロッパーは、指定のインターセプタに独自の VAST 取得および解析ロジックを実装する必要があります。

パラメータ

インターセプター

functions（非 null cast.framework.messages.BreakClip、オプションで null 以外の cast.framework.breaks.BreakClipLoadInterceptorContext）

デフォルトのブレーク クリップ読み込みインターセプタは、入力と同じブレーク クリップを返します。

値を null にすることもできます。

setBreakSeekInterceptor

setBreakSeekInterceptor（seekInterceptor）

デベロッパーがシーク後に再生するブレークを指定するインターセプタを提供します。

パラメータ

SeeInterceptor

function（null 以外の cast.framework.breaks.BreakSeekData）

インターセプタまたはデベロッパーが null にリセットする場合は null にします。デフォルトのブレーク シーク インターセプタは、seeTo 値から最も近いブレークを返します。

値を null にすることもできます。

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

監視されているクライアント スティッチ ブレークをプレイするかどうかを制御するフラグを設定します。

パラメータ

playWatchedBreak

ブール値

setVastTrackingInterceptor

setVastTrackingInterceptor（インターセプタ）

サーバーに送信される前に VAST トラッキング URL を変更するためのインターセプタを提供します。インターセプターの入力はトラッキング URL の文字列です。インターセプタは、URL の変更された文字列または変更された URL の Promise を返すことができます。トラッキング URL を CAF ではなく独自のコードで送信したい場合、インターセプタは null を返すこともできます。

パラメータ

インターセプター

関数（文字列）

送信前に URL を変更するインターセプタ。

値を null にすることもできます。