IPlayerServerHandler
PlayerServerのサービスロジックを提供するハンドラーのインターフェイス。
プロパティ
handleLoad
handleLoad:
(mediaInfo:IPlayerSessionMediaInfo, loadParams?:IPlayerSessionLoadParams, sessionId?:IPlayerSessionId) => void
URLを使用してコンテンツを読み込むリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.loadを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するプレーヤーセッションのmediaInfoとloadParamsで提供されるフィールド値を使用してMediaPlayerインスタンスを初期化できるようになります。
handleUnload
handleUnload:
(sessionId?:IPlayerSessionId) => void
対話型コンポーネントからのIPlayerClient.unloadの呼び出しに応じて、メディアセッションのコンテンツの読み込みを解除します。
この関数を実装することで、アプリは、指定したsessionIdに関連付けられているプレーヤーセッションのMediaPlayerリソースとMedia Source Extensions(MSE)リソースを解放できるようになります。
handleUnloadSync?
optionalhandleUnloadSync:((timeoutMsec: number, sessionId?:IPlayerSessionId) =>IUnloadSyncStatus)
対話型コンポーネントからのIPlayerClient.unloadSyncの呼び出しに応じて、メディアセッションのコンテンツの読み込みを解除します。
この関数を実装することで、アプリは、指定したsessionIdに関連付けられているプレーヤーセッションのMediaPlayerリソースとMedia Source Extensions(MSE)リソースを同期的に解放できるようになります。W3CMedia MediaPlayerインスタンスの場合、deinitializeSync APIを使用してください。
handleSetVideoView
handleSetVideoView:
(handle:IViewHandle, sessionId?:IPlayerSessionId) => void
ビデオビューを設定するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setVideoViewを呼び出したときに、これが呼び出されます。
handleClearVideoView
handleClearVideoView:
(sessionId?:IPlayerSessionId) => void
テキストビューをクリアするリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.clearVideoViewを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerインスタンスに対してclearSurfaceHandleを呼び出すことができるようになります。
handleSetTextView
handleSetTextView:
(handle:IViewHandle, sessionId?:IPlayerSessionId) => void
テキストビューを設定するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setTextViewを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerインスタンスに対してsetCaptionViewHandleを呼び出すことができるようになります。
handleClearTextView
handleClearTextView:
(sessionId?:IPlayerSessionId) => void
テキストビューをクリアするリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.clearTextViewを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerインスタンスに対してclearCaptionViewHandleを呼び出すことができるようになります。
handlePlay
handlePlay:
(sessionId?:IPlayerSessionId) => void
再生を再開または開始するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.playを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスに対してplayを呼び出すことができるようになります。
アプリが既に再生中で、再生速度が通常の速度(1.0)ではない場合、これによって再生速度が通常の速度に戻ります。既に再生中の状態にあるときに複数の再生リクエストを受け取ってもエラーにはならず、成功として処理します。メディアサーバーは、対応するIISessionStatusを更新して、新しい再生ステータスを反映する必要があります。
handlePause
handlePause:
(sessionId?:IPlayerSessionId) => void
再生を一時停止するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.pauseを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスに対してpauseを呼び出すことができるようになります。
既に一時停止状態にあるときに複数の一時停止リクエストを受け取ってもエラーにはならず、成功として処理します。メディアサーバーは、対応するIISessionStatusを更新して、新しい再生ステータスを反映する必要があります。
handleSeek
handleSeek:
(position: number, isRelative?: boolean, sessionId?:IPlayerSessionId) => void
指定した再生位置にシークするリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.seekを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスのcurrentTimeを変更できるようになります。
メディアサーバーは、対応するIISessionStatusを更新して、新しい再生位置を反映する必要があります。
handleSetMute
handleSetMute:
(isMuted: boolean, sessionId?:IPlayerSessionId) => void
再生をミュートするリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setMuteを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスに対してmutedを設定できるようになります。
メディアサーバーは、対応するIISessionStatusを更新して、新しい再生ステータスを反映する必要があります。
handleSetPlaybackRate
handleSetPlaybackRate:
(playbackRate: number, sessionId?:IPlayerSessionId) => void
メディア再生の再生速度を設定するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setPlaybackRateを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスに対してplaybackRateを設定できるようになります。
新しい再生ステータスを反映するには、メディアセッションでIISessionStatusを更新する必要があります。
handleSetVolume
handleSetVolume:
(volume: number, sessionId?:IPlayerSessionId) => void
メディア再生の音量を設定するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setVolumeを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するVideoPlayerまたはAudioPlayerインスタンスに対してvolumeを設定できるようになります。
新しい再生ステータスを反映するには、メディアセッションでIISessionStatusを更新する必要があります。
handleSetActiveTrack
handleSetActiveTrack:
(trackType:ITrackType, trackId: string, sessionId?:IPlayerSessionId) => void
メディア再生のアクティブトラックを設定するリクエストを処理します。アプリが対話型コンポーネントからIPlayerClient.setActiveTrackを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、MSEプレーヤーインスタンスに対して、IDを使用してオーディオ、ビデオ、テキストトラックを設定できるようになります。
新しい再生ステータスを反映するには、メディアセッションでIISessionStatusを更新する必要があります。
handleGetCurrentPosition
handleGetCurrentPosition:
(sessionId?:IPlayerSessionId) => number
対話型コンポーネントのリクエストを処理して、メディア再生の現在の再生位置を取得します。アプリが対話型コンポーネントからIPlayerClient.getCurrentPositionを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、sessionIdに対応するAudioPlayerまたはVideoPlayerインスタンスからcurrentTimeを取得できるようになります。アプリは、その後で、現在の再生位置(秒)を示すnumberを使用してPromiseを解決することができます。
handleMessage
handleMessage:
(message: any, sessionId?:IPlayerSessionId) => void
対話型コンポーネントからカスタムメッセージを受信するリクエストを処理します。アプリはmessageオブジェクトを使用してカスタム操作を実行できます。アプリが対話型コンポーネントからIPlayerClient.sendMessageを呼び出したときに、これが呼び出されます。
この関数を実装することで、アプリは、サービスコンポーネントのカスタム操作を処理できます。
handleStartBufferedRangesUpdates
handleStartBufferedRangesUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdに対してIPlayerClient.registerBufferedRangesListenerを1回以上呼び出したときに、これが呼び出されます。
アプリは、サービスコンポーネントからIPlayerServer.updateBufferedRanges APIを呼び出して、sessionIdに対応するバッファ範囲の更新の送信を開始する必要があります。
handleStopBufferedRangesUpdates
handleStopBufferedRangesUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdのすべてのIPlayerSessionBufferedRangesListenerインスタンスをサブスクライブ解除したときに、これが呼び出されます。
アプリは、サービスコンポーネントからsessionIdに対応するバッファ範囲の更新の送信を停止する必要があります。
handleStartStatusUpdates
handleStartStatusUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdに対してIPlayerClient.registerStatusListenerを1回以上呼び出したときに、これが呼び出されます。
アプリは、サービスコンポーネントからIPlayerServer.updateStatus APIを呼び出して、sessionIdに対応するプレーヤーセッションのステータス更新の送信を開始する必要があります。
handleStopStatusUpdates
handleStopStatusUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdのすべてのIPlayerSessionStatusListenerインスタンスをサブスクライブ解除したときに、これが呼び出されます。
アプリは、サービスコンポーネントからsessionIdに対応するプレーヤーセッションのステータス更新の送信を停止する必要があります。
handleStartTrackUpdates
handleStartTrackUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdに対してIPlayerClient.registerTrackListenerを1回以上呼び出したときに、これが呼び出されます。
アプリは、サービスコンポーネントからIPlayerServer.addTrackまたはIPlayerServer.removeTrack APIを呼び出して、sessionIdに対応するプレーヤーセッションのトラック更新の送信を開始する必要があります。
handleStopTrackUpdates
handleStopTrackUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdのすべてのIPlayerSessionTrackListenerインスタンスをサブスクライブ解除したときに、これが呼び出されます。
アプリは、サービスコンポーネントからsessionIdに対応するプレーヤーセッションのトラック更新の送信を停止する必要があります。
handleStartMessageUpdates
handleStartMessageUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdに対してIPlayerClient.registerMessageListenerを1回以上呼び出したときに、これが呼び出されます。
アプリは、サービスコンポーネントからsessionIdに対応するIPlayerServer.sendMessage APIを呼び出すことで、JSONオブジェクトとしてカスタムメッセージの送信を開始できます。
handleStopMessageUpdates
handleStopMessageUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdのすべてのIPlayerSessionTrackListenerインスタンスをサブスクライブ解除したときに、これが呼び出されます。その場合、メッセージの受信側が存在しないため、サービスコンポーネントからsessionIdに対応するメッセージを送信することはできません。
handleStartErrorUpdates
handleStartErrorUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdに対してIPlayerClient.registerErrorListenerを1回以上呼び出したときに、これが呼び出されます。
アプリは、サービスコンポーネントからsessionIdに対応するIPlayerServer.sendError APIを呼び出すことで、JSONオブジェクトとしてIPlayerSessionErrorの送信を開始できます。
handleStopErrorUpdates
handleStopErrorUpdates:
(sessionId?:IPlayerSessionId) => void
アプリが対話型コンポーネントからsessionIdのすべてのIPlayerSessionErrorListenerインスタンスをサブスクライブ解除したときに、これが呼び出されます。その場合、エラーの受信側が存在しないため、サービスコンポーネントからsessionIdに対応するエラーを送信することはできません。
Last updated: 2026年7月22日

