Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
Ring
AWS
ドキュメント
Support
Contact Us
My Cases
開発
設計と開発
公開
リファレンス
サポート
ネイティブ
Skip to main content
Keplerプレーヤーサーバーの操作を表します。このインターフェイスは、Keplerプレーヤーサーバーのハンドラーを管理し、Keplerプレーヤーのセッションステータスを更新するためのメソッドを提供します。 ランタイムエラーの場合、アプリはErrorオブジェクトでプロミスを拒否し、可能な場合はメディアプレーヤーから受信したエラーコードとメッセージをIPlayerSessionErrorを使用して送信する必要があります。

プロパティ

setHandler

setHandler: (handler: IPlayerServerHandler, componentId: string) => void
指定されたコンポーネントIDに関連付けられたKeplerプレーヤーのアクションに関するリクエストを処理するハンドラーを割り当てます。 Keplerプレーヤーのリクエストを処理し、Keplerプレーヤーのカスタムロジックを実装するには、ハンドラーの割り当てが不可欠です。この呼び出しでは、コンポーネントごとに1つのハンドラーを使用できます。アクティブなハンドラーは、setHandlerの前回の呼び出しで設定されたハンドラーです。

パラメーター

handler
IPlayerServerHandler
componentId
string

例


updateBufferedRanges

updateBufferedRanges: (bufferedRanges: Array<ITimeRange>, sessionId?: IPlayerSessionId) => Promise<void>
通知を希望するクライアントにKeplerプレーヤーのバッファ範囲について通知します。 サーバーセッションの再生バッファ範囲に関する更新は、メディアの再生ステータス、現在選択されているメディア、その他の関連情報の変更を反映するために不可欠です。

パラメーター

bufferedRanges
ITimeRange[]
sessionId?
IPlayerSessionId

戻り値

Promise<void> 更新が完了したときに解決されるプロミスです。

updateStatus

updateStatus: (status: Array<IPlayerSessionStatus>) => Promise<void>
通知を希望するクライアントにKeplerプレーヤーのセッションステータスが更新されたことを通知します。 Keplerプレーヤーサーバーのセッションステータスに関する更新は、メディアの再生ステータス、現在選択されているメディア、その他の関連情報の変更を反映するために不可欠です。たとえばアプリでは、AudioPlayerまたはVideoPlayer(https://html.spec.whatwg.org/#event-handlers-on-elements,-document-objects,-and-window-objects)にメディア関連のEventListenerを登録して、それに応じて`IPlayerSessionStatus`のパラメーターを更新し、updateStatusを呼び出します。該当する場合、Keplerプレーヤーサーバーは、インストールされている`IPlayerServerHandler`インスタンスを通じて受け取ったKeplerプレーヤーのリクエストに対して処理を実行したときに、セッションステータスの更新を発行する必要があります。

パラメーター

status
IPlayerSessionStatus[]

戻り値

Promise<void> 更新が完了したときに解決されるプロミスです。

例


addTrack

addTrack: (newTrack: ITrackInfo, sessionId?: IPlayerSessionId) => Promise<void>
通知を希望するクライアントにKeplerプレーヤーの新しいトラックが追加されたこと通知します。AudioPlayerまたはVideoPlayerは、AudioTrackList、VideoTrackList、TextTrackListのいずれかに”addtrack”のEventListenerを登録してから、このAPIを呼び出す必要があります。 サーバーセッションの新しいトラックに関する更新は、メディアの再生ステータス、現在選択されているメディア、その他の関連情報の変更を反映するために不可欠です。アプリでは、HtmlMediaElement.{audioTracks,videoTracks,textTracks}属性に”addtrack”のEventListenerを登録し、イベントが発生した場合にIPlayerServer.addTrackを呼び出すことができます。 例:

パラメーター

newTrack
ITrackInfo
sessionId?
IPlayerSessionId

戻り値

Promise<void> 更新が完了したときに解決されるプロミスです。

removeTrack

removeTrack: (removedTrack: ITrackInfo, sessionId?: IPlayerSessionId) => Promise<void>
通知を希望するクライアントにKeplerプレーヤーの既存のトラックが削除されたことを通知します。AudioPlayerまたはVideoPlayerは、AudioTrackList、VideoTrackList、TextTrackListのいずれかに”removetrack”のEventListenerを登録してから、このAPIを呼び出す必要があります。 サーバーセッションの削除されたトラックに関する更新は、メディアの再生ステータス、現在選択されているメディア、その他の関連情報の変更を反映するために不可欠です。アプリでは、HtmlMediaElement.{audioTracks,videoTracks,textTracks}属性に”removetrack”のEventListenerを登録し、イベントが発生した場合にIPlayerServer.removeTrackを呼び出すことができます。 例:

パラメーター

removedTrack
ITrackInfo
sessionId?
IPlayerSessionId

戻り値

Promise<void> 更新が完了したときに解決されるプロミスです。

sendMessage

sendMessage: (message: any, sessionId?: IPlayerSessionId) => Promise<void>
対話型コンポーネントにカスタムメッセージを送信する方法を提供します。任意のJSON型をメッセージとして送信できます(undefinedを除く)。 これは、UIの更新に使用できるカスタムメッセージをクライアントに提供する場合に特に役立ちます。

パラメーター

message
any
sessionId?
IPlayerSessionId

戻り値

Promise<void> メッセージが送信されたときに解決されるプロミスです。リクエストが失敗した場合やmessageがundefinedの場合は、エラーで拒否されます。

例


sendError

sendError: (error: IPlayerSessionError, sessionId?: IPlayerSessionId) => Promise<void>
サービスコンポーネントから対話型コンポーネントにエラーを送信する方法を提供します。 アプリでは、HtmlMediaElementインスタンスに”error”のEventListenerを登録し、イベントが発生した場合にIPlayerServer.addTrackを呼び出すことができます。

パラメーター

error
IPlayerSessionError
sessionId?
IPlayerSessionId

戻り値

Promise<void> エラーが送信されたときに解決されるプロミスです。

例

最終更新日 2026年8月25日