プロパティ
load
load: (mediaInfo: IPlayerSessionMediaInfo, loadParams?: IPlayerSessionLoadParams, sessionId?: IPlayerSessionId) => Promise<void>
指定されたURLを使用してコンテンツをロードするようPlayerServerにリクエストします。
パラメーター
mediaInfo
IPlayerSessionMediaInfo
loadParams?
any
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
unload
unload: (sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerのメディアセッションにメディアコンテンツをアンロードするようにリクエストします。たとえば、アプリの状態がバックグラウンドに変わった場合にメディアコンテンツを同期的にアンロードするには、unloadSyncを呼び出します。
パラメーター
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
unloadSync()
unloadSync: (timeoutMsec: number, sessionId?: IPlayerSessionId) => IUnloadSyncStatus
PlayerServerのメディアセッションにメディアコンテンツを同期的にアンロードするようにリクエストします。このAPIを使用して、アプリの状態がバックグラウンドに変わったときにメディアリソースを解放します。
2.2.0
パラメーター
timeoutMsec
number
sessionId?
any
戻り値
IUnloadSyncStatus
PlayerServer IUnloadSyncStatusの列挙値の1つ。
例
setVideoView
setVideoView: (viewHandle: IViewHandle, sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerのメディアセッションに、ロードされたコンテンツでKeplerビデオサーフェスビューを設定するようにリクエストします。
メディアコンテンツがロードされた後に、ロードAPIのいずれかを呼び出してsetVideoViewを呼び出す必要があります。
パラメーター
viewHandle
IViewHandle
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
clearVideoView
clearVideoView: (sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerのメディアセッションに、ビデオコンテンツをレンダリングしているKeplerVideoSurfaceViewをクリアするようにリクエストします。
パラメーター
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setTextView
setTextView: (viewHandle: IViewHandle, sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerのメディアセッションに、ロードされたコンテンツでKeplerキャプションビューを設定するようにリクエストします。
メディアコンテンツがロードされた後に、ロードAPIのいずれかを呼び出してsetTextViewを呼び出す必要があります。
パラメーター
viewHandle
IViewHandle
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
clearTextView
clearTextView: (sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerのメディアセッションに、キャプションコンテンツをレンダリングしているKeplerCaptionsViewをクリアするようにリクエストします。
パラメーター
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
play
play: (sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerに再生を開始または再開するようリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。Keplerプレーヤーサーバーは、再生速度を通常にリセットする場合があります。
パラメーター
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
pause
pause: (sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerに再生を一時停止するようにリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
seek
seek: (position: number, isRelative?: boolean, sessionId?: IPlayerSessionId) => Promise<void>
指定した再生位置(秒単位)までシークするようPlayerServerにリクエストします。
新しい再生位置を反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
position
number
isRelative?
boolean
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setMute
setMute: (isMuted: boolean, sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerに再生のミュートまたはミュート解除をリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
isMuted
boolean
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setPlaybackRate
setPlaybackRate: (playbackRate: number, sessionId?: IPlayerSessionId) => Promise<void>
メディア再生の再生レートを設定するようPlayerServerにリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
playbackRate
number
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setVolume
setVolume: (volume: number, sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerにメディア再生の音量を設定するようにリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
volume
number
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setActiveTrack
setActiveTrack: (trackType: ITrackType, trackId: string, sessionId?: IPlayerSessionId) => Promise<void>
PlayerServerにメディア再生のアクティブトラックを設定するようにリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
trackType
ITrackType
trackId
string
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。
例
setMediaControlFocus
setMediaControlFocus:PlayerClientMediaControlHandlerインスタンスを登録します。 バージョン2.1.0以降で使用できます。(componentInstance: IComponentInstance, mediaControlHandler?:PlayerClientMediaControlHandler) => Promise<void>
パラメーター
componentInstance
IComponentInstance
mediaControlHandler?
PlayerClientMediaControlHandler戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合や対象バージョンが2.1.0未満の場合は、エラーで拒否されます。
例
getCurrentPosition
getCurrentPosition: (sessionId?: IPlayerSessionId) => Promise<number>
PlayerServerに、メディア再生の現在の再生位置(秒単位)を取得するようにリクエストします。
新しい再生ステータスを反映するには、メディアセッションでIPlayerSessionStatusを更新する必要があります。
パラメーター
sessionId?
any
戻り値
Promise<number>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合はエラーで拒否されます。sessionIdに対応する現在の再生位置を示す数値を秒単位で返します。
例
registerBufferedRangesListener
registerBufferedRangesListener:リスナーをサブスクライブして、バッファされた範囲の変化を監視します。(listener:IPlayerSessionBufferedRangesListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionBufferedRangesListenersessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
registerStatusListener
registerStatusListener:リスナーをサブスクライブして、プレーヤーセッションステータスの変化を監視します。(listener:IPlayerSessionStatusListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionStatusListenersessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
registerPositionListener
registerPositionListener:リスナーをサブスクライブして、再生位置の更新を監視します。この位置は秒単位です。(listener:IPlayerSessionPositionListener, interval: number, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionPositionListenerinterval
number
sessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
registerTrackListener
registerTrackListener:リスナーをサブスクライブしてトラック情報の変化を監視します。(listener:IPlayerSessionTrackListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionTrackListenersessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
registerMessageListener
registerMessageListener:サービスコンポーネントからメッセージを受信するようにリスナーをサブスクライブします。(listener:IPlayerSessionMessageListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionMessageListenersessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
registerErrorListener
registerErrorListener:サービスコンポーネントからエラーを受け取るようにリスナーをサブスクライブします。(listener:IPlayerSessionErrorListener, sessionId?: IPlayerSessionId) => Promise<ISubscription>
パラメーター
listener
IPlayerSessionErrorListenersessionId?
any
戻り値
Promise<ISubscription>
ISubscriptionオブジェクトを使用して解決されるプロミス。このオブジェクトを使用して、リスナーが不要になったときにリスナーのサブスクライブを解除できます。
例
sendMessage
sendMessage: (message: any, sessionId?: IPlayerSessionId) => Promise<void>
対話型コンポーネントがカスタムメッセージをサービスコンポーネントに送信する方法を提供します。任意のJSON型をメッセージとして送信できます(undefinedを除く)。
パラメーター
message
any
sessionId?
any
戻り値
Promise<void>
リクエストが正常に処理されたときに解決されるプロミスです。リクエストが失敗した場合やmessageがundefinedの場合は、エラーで拒否されます。
例
destroy
destroy: () => void
Keplerプレーヤークライアントインスタンスを破棄し、Keplerプレーヤーサービスを停止します。クライアントは、対話型コンポーネントが破棄されたときに、メディアリソースをクリーンアップするためにこのAPIを呼び出すことが期待されます。

