実装
IMediaControlHandlerAsync
コンストラクタ
new PlayerClientMediaControlHandler()
new PlayerClientMediaControlHandler(): PlayerClientMediaControlHandler戻り値
PlayerClientMediaControlHandlerメソッド
clearSession()
clearSession(sessionId:IPlayerSessionId): void
セッションがアンロードされたときにセッションデータを消去します。
パラメーター
sessionId
IPlayerSessionId
destroy()
destroy():void
handleCustomAction()
handleCustomAction(action:Action, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「customAction」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
action
Action
sessionId?
any
戻り値
Promise<void>
handleDisableTextTrack()
handleDisableTextTrack(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「disableTextTrack」を実行します。w3cmediaは、デフォルトモードとして、disableTextTrackコマンドを開始することでこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handleEnableShuffle()
handleEnableShuffle(enable:boolean, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「shuffle」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
enable
boolean
sessionId?
any
戻り値
Promise<void>
handleEnableTextTrack()
handleEnableTextTrack(textTrack:ITrack, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「enableTextTrack」を実行します。w3cmediaは、デフォルトモードとして、enableTextTrackコマンドを開始することでこれを内部的に処理します。
パラメーター
textTrack
ITrack
sessionId?
any
戻り値
Promise<void>
handleFastForward()
handleFastForward(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「fastforward」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対する前方シークのコマンドによりこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handleGetMetadataInfo()
handleGetMetadataInfo(id:MediaId): Promise<IMediaMetadata>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「getMetaInfo」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
id
MediaId
戻り値
Promise<IMediaMetadata>
handleGetSessionState()
handleGetSessionState(sessionId?:any): Promise<MediaSessionState[]>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「getSessionState」を実行します。w3cmediaは、デフォルトでセッション状態を更新することによりこれを内部的に処理します。または、アプリクライアントでOverrideMediaControlHandlerを使用してコールバック関数をオーバーライドすることを選択してその選択どおりに実装することもできます。
パラメーター
sessionId?
any
戻り値
Promise<MediaSessionState[]>
handleNext()
handleNext(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「next」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
sessionId?
any
戻り値
Promise<void>
handlePause()
handlePause(sessionId?:any, context?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「pause」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対してpauseコマンドを開始することでこれを内部的に処理します。
パラメーター
sessionId?
any
context?
any
戻り値
Promise<void>
handlePlay()
handlePlay(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「play」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対してplayコマンドを開始することでこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handlePrevious()
handlePrevious():Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「previous」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
戻り値
Promise<void>
handleRewind()
handleRewind(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「rewind」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対する後方シークのコマンドによりこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handleSeek()
handleSeek(position:ITimeValue, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「seek」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対する前方／後方シークのコマンドによりこれを内部的に処理します。
パラメーター
position
ITimeValue
sessionId?
any
戻り値
Promise<void>
handleSetAudioTrack()
handleSetAudioTrack(audioTrack:ITrack, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「setAudioTrack」を実行します。w3cmediaは、デフォルトモードとして、setAudioTrackコマンドを開始することでこれを内部的に処理します。
パラメーター
audioTrack
ITrack
sessionId?
any
戻り値
Promise<void>
handleSetAudioVolume()
handleSetAudioVolume(volume:number, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「setVolume」を実行します。w3cmediaは、デフォルトモードとして、setvolumeコマンドを開始することでこれを内部的に処理します。
パラメーター
volume
number
sessionId?
any
戻り値
Promise<void>
handleSetPlaybackSpeed()
handleSetPlaybackSpeed(speed:number, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「setplaybackspeed」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対してplaybackspeedコマンドを構成することでこれを内部的に処理します。
パラメーター
speed
number
sessionId?
any
戻り値
Promise<void>
handleSetRating()
handleSetRating(id:MediaId, rating: number, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「setRating」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
id
MediaId
rating
number
sessionId?
any
戻り値
Promise<void>
handleSetRepeatMode()
handleSetRepeatMode(mode:RepeatMode, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「previous」を実行します。これはプレイリスト管理機能であるため、w3cmediaの再生処理に対してはNOPです。
パラメーター
mode
RepeatMode
sessionId?
any
戻り値
Promise<void>
handleSkipBackward()
handleSkipBackward(delta:ITimeValue, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「skipbackward」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対するデルタ位置を指定したシークコマンドによりこれを内部的に処理します。
パラメーター
delta
ITimeValue
sessionId?
any
戻り値
Promise<void>
handleSkipForward()
handleSkipForward(delta:ITimeValue, sessionId?: any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「skipforward」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対するデルタ位置を指定したシークコマンドによりこれを内部的に処理します。
パラメーター
delta
ITimeValue
sessionId?
any
戻り値
Promise<void>
handleStartOver()
handleStartOver(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「startover」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対して開始位置までシークし、再生コマンドを開始することによりこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handleStop()
handleStop(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「stop」を実行します。w3cmediaは、デフォルトモードとして、パイプラインに対してpauseコマンドを開始することでこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
handleTogglePlayPause()
handleTogglePlayPause(sessionId?:any): Promise<void>
KMCサーバーからのコールバックであり、現在のメディアプレーヤーインスタンスに対してメディアコントロールコマンド「toggleplaypause」を実行します。w3cmediaは、デフォルトモードとして、パイプラインの現在の状態に応じてplay／pauseを開始することでこれを内部的に処理します。
パラメーター
sessionId?
any
戻り値
Promise<void>
setMediaControlServer()
setMediaControlServer(mediaControlServer:IMediaControlServerAsync): void
メディアコントロール処理用のメディアコントロールサーバーを設定します。
パラメーター
mediaControlServer
IMediaControlServerAsync
setPlayerClient()
setPlayerClient(playerClient: IPlayerClient):void
メディアコントロール処理用のプレーヤークライアントインスタンスを設定します。
