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