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

