cast. frameworks. breaks. BreakManager
休憩を管理するクラス。
Methods
addBreak
addBreak(breakData, breakClips, broadCastMediaStatus) は boolean を返します。
動的なブレーク クリップとブレーク クリップを追加します。 ブレーク クリップはブレークに関連付けられます(break.breakClipIds と break.duration はクリップに応じて更新されます)。
パラメータ |
|
---|---|
breakData |
値を null にすることはできません。 |
breakClips |
null ではない cast.framework.messages.BreakClip の配列 値を null にすることはできません。 |
broadCastMediaStatus |
任意 boolean 現在のブレーク ステータスが変化したかどうかを CAF がチェックする必要があるかどうか。レシーバーが休憩を追加する必要が生じる場合があるため(読み込み完了時など)、再生が開始される前に行うのは望ましくない場合があります。 |
- 戻り値
-
boolean
広告ブレークが正常に追加された場合は「正」。
getBreakById
getBreakById(id) が cast.framework.messages.Break を返す
現在のメディア ブレークを ID ごとに取得します。
パラメータ |
|
---|---|
id |
string ブレーク ID。 |
- 戻り値
-
nullable cast.framework.messages.Break
getBreakClipById
getBreakClipById(id) returns cast.framework.messages.BreakClip
ID で現在のメディア ブレーク クリップを取得します。
パラメータ |
|
---|---|
id |
string クリップ ID。 |
- 戻り値
-
nullable cast.framework.messages.BreakClip
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() が数値を返す
現在再生中のブレーク クリップの現在の時刻を秒単位で返します。
- 戻り値
-
nullable number
現在のブレーク クリップ内の現在の時間(秒)。プレーヤーがブレーク クリップを再生していない場合は null。
getBreakClipDurationSec
getBreakClipDurationSec() が number を返す
現在再生中のブレーク クリップの時間を秒単位で返します。
- 戻り値
-
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。 |
- 戻り値
getPlayWatchedBreak
getPlayWatchedBreak() がブール値を返す
視聴されたブレークを再生する場合は true を返します。
- 戻り値
-
boolean
removeBreakById
RemoveBreakById(breakId) は、ブール値を返す
休憩と、関連する休憩クリップを削除します。
パラメータ |
|
---|---|
breakId |
string Break Id(ブレーク ID) |
- 戻り値
-
boolean
広告ブレークが正常に削除された場合は「正」。
setBreakClipLoadInterceptor
setBreakClipLoadInterceptor(interceptor)
ブレークを開始する前に、デベロッパーがブレーク クリップをさらに挿入したり、現在のブレーク クリップを変更したりできるようにするインターセプタを提供します。
インターセプタが null の場合、インターセプタはデフォルトのものにリセットされます。デフォルトでは、デフォルトのインターセプタに VAST の取得と解析のロジックが使用されます。 そのため、デベロッパーがカスタマイズしたインターセプタを設定した場合、VAST ロジックはオーバーライドされるため、デベロッパーは指定されたインターセプタに独自の VAST 取得および解析ロジックを実装する必要があります。
パラメータ |
|
---|---|
インターセプター |
function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) デフォルトのブレーク クリップの読み込み インターセプタは、入力と同じブレーク クリップを返します。 値を null にすることもできます。 |
setBreakSeekInterceptor
setBreakSeekInterceptor(seekInterceptor)
シーク後に再生する中断をデベロッパーが指定するためのインターセプタを提供します。
パラメータ |
|
---|---|
seekInterceptor |
function(non-null cast.framework.breaks.BreakSeekData) Interceptor、またはデベロッパーがデフォルトにリセットする場合は null。 デフォルトのブレークシーク インターセプタは、seekeTo の値から最も近いブレークを返します。 値を null にすることもできます。 |
setPlayWatchedBreak
setPlayWatchedBreak(playWatchedBreak)
監視対象のクライアントの合成ブレークを再生するかどうかを制御するフラグを設定します。
パラメータ |
|
---|---|
playWatchedBreak |
boolean |
setVastTrackingInterceptor
setVastTrackingInterceptor(interceptor)
VAST トラッキング URL がサーバーに送信される前に変更するためのインターセプタを提供します。 インターセプタの入力はトラッキング URL の文字列です。インターセプタは、変更された URL 文字列の文字列か、変更された URL の文字列の Promise を返すことができます。また、CAF ではなく独自のコードでトラッキング URL を送信したい場合、インターセプタは null を返すことができます。
パラメータ |
|
---|---|
インターセプター |
関数(文字列) 送信前に URL を変更するインターセプタ。 値を null にすることもできます。 |