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