IPlayerServerHandler

An interface for a handler that provides the service logic of the PlayerServer.

​

Properties

​

handleLoad

handleLoad: (mediaInfo: IPlayerSessionMediaInfo, loadParams?: IPlayerSessionLoadParams, sessionId?: IPlayerSessionId) => void

Handles a request to load content by URL. This call is received when apps call IPlayerClient.load from interactive component. Apps must implement this function to initialize MediaPlayer instance with the fields values provided in mediaInfo and loadParams for player session corresponding to sessionId.

​

Parameters

mediaInfo

IPlayerSessionMediaInfo The object to describe the necessary URLs and HTTP headers to load media content.

loadParams?

IPlayerSessionLoadParams Params required to load content by URL.

sessionId?

IPlayerSessionId The session ID to target for loading content. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleUnload

handleUnload: (sessionId?: IPlayerSessionId) => void

Unloads content from a media session in response to IPlayerClient.unload calls from the interactive component. Applications must implement this function to release MediaPlayer and Media Source Extensions (MSE) resources for the player session associated with the given sessionId.

​

Parameters

sessionId?

IPlayerSessionId The session ID of the content to unload. If not provided, the PlayerServer determines how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleUnloadSync?

optional handleUnloadSync: ((timeoutMsec: number, sessionId?: IPlayerSessionId) => IUnloadSyncStatus)

Unloads content from a media session in response to IPlayerClient.unloadSync calls from the interactive component. Applications must implement this function to release MediaPlayer and Media Source Extensions (MSE) resources for the player session associated with the given sessionId synchronously. For W3CMedia MediaPlayer instance, use deinitializeSync API.

​

Parameters

timeoutMsec

number Maximum allowed time (in milliseconds) for unloadSync API to execute. Minimum value is 1000, maximum value is 5000.

sessionId?

IPlayerSessionId The session ID of the content to unload. If not provided, the PlayerServer determines how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

​

Returns

IUnloadSyncStatus The status of synchronous deinitialize of mediaplayer instance corresponding to sessionId.

---

​

handleSetVideoView

handleSetVideoView: (handle: IViewHandle, sessionId?: IPlayerSessionId) => void

Handles a request to set the video view. This call is received when apps call IPlayerClient.setVideoView from interactive component.

​

Parameters

handle

IViewHandle The identifier for the shared surface.

sessionId?

IPlayerSessionId The session ID to target for setting the video surface. If not specified, the PlayerServer decides how to handle the request. Apps must implement this function to call setSurfaceHandle on VideoPlayer instance corresponding to sessionId.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleClearVideoView

handleClearVideoView: (sessionId?: IPlayerSessionId) => void

Handles a request to clear the text view. This call is received when apps call IPlayerClient.clearVideoView from interactive component. Apps must implement this function to call clearSurfaceHandle on VideoPlayer instance corresponding to sessionId.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target for clearing the text view. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSetTextView

handleSetTextView: (handle: IViewHandle, sessionId?: IPlayerSessionId) => void

Handles a request to set the text view. This call is received when apps call IPlayerClient.setTextView from interactive component. Apps must implement this function to call setCaptionViewHandle on VideoPlayer instance corresponding to sessionId.

​

Parameters

handle

IViewHandle The identifier for the shared surface.

sessionId?

IPlayerSessionId The session ID to target for setting the captions surface. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleClearTextView

handleClearTextView: (sessionId?: IPlayerSessionId) => void

Handles a request to clear the text view. This call is received when apps call IPlayerClient.clearTextView from interactive component. Apps must implement this function to call clearCaptionViewHandle on VideoPlayer instance corresponding to sessionId.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target for clearing the captions surface. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handlePlay

handlePlay: (sessionId?: IPlayerSessionId) => void

Handles a request to resume or start playback. This call is received when apps call IPlayerClient.play from interactive component. Apps must implement this function to call play on {Video,Audio}Player instance corresponding to sessionId. If the application is already playing and the playback speed is not normal (not 1.0) this may return playback to normal speed. Receiving multiple play requests while already in playing state is not an error and should signal success. The media server should update the corresponding IISessionStatus to reflect the new playback status.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handlePause

handlePause: (sessionId?: IPlayerSessionId) => void

Handles a request to pause playback. This call is received when apps call IPlayerClient.pause from interactive component. Apps must implement this function to call pause on {Video,Audio}Player instance corresponding to sessionId. Receiving multiple pause requests while already in pause state is not an error and should signal success. The media server should update the corresponding IISessionStatus to reflect the new playback status.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSeek

handleSeek: (position: number, isRelative?: boolean, sessionId?: IPlayerSessionId) => void

Handles a request to seek to seek to a given playback position. This call is received when apps call IPlayerClient.seek from interactive component. Apps must implement this function to change currentTime of {Video,Audio}Player instance corresponding to sessionId. The media server should update the corresponding IISessionStatus to reflect the new playback position.

​

Parameters

position

number The playback position to seek to, either relative to the current playback position (isRelative = true); or relative to the start of the media where 0 represents the start of the media (isRelative = false).

isRelative?

boolean If the position provided is relative to the current playback position (isRelative = true) or an absolute position in the media (isRelative = false). Default value is false.

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSetMute

handleSetMute: (isMuted: boolean, sessionId?: IPlayerSessionId) => void

Handles a request to mute playback. This call is received when apps call IPlayerClient.setMute from interactive component. Apps must implement this function to set muted on {Video,Audio}Player instance corresponding to sessionId. The media server should update the corresponding IISessionStatus to reflect the new playback status.

​

Parameters

isMuted

boolean If true, the media should be muted;

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSetPlaybackRate

handleSetPlaybackRate: (playbackRate: number, sessionId?: IPlayerSessionId) => void

Handles a request to set playback speed of media playback. This call is received when apps call IPlayerClient.setPlaybackRate from interactive component. Apps must implement this function to set playbackRate on {Video,Audio}Player instance corresponding to sessionId. The media sesssion should update its IISessionStatus to reflect the new playback status.

​

Parameters

playbackRate

number The playback speed to set, like 0.25, 0.5, 2.0 etc

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSetVolume

handleSetVolume: (volume: number, sessionId?: IPlayerSessionId) => void

Handles a request to set volume of media playback. This call is received when apps call IPlayerClient.setVolume from interactive component. Apps must implement this function to set volume on {Video,Audio}Player instance corresponding to sessionId. The media sesssion should update its IISessionStatus to reflect the new playback status.

​

Parameters

volume

number The volume to set, in the range of 0.0 to 1.0.

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleSetActiveTrack

handleSetActiveTrack: (trackType: ITrackType, trackId: string, sessionId?: IPlayerSessionId) => void

Handles a request to set the active track of media playback. This call is received when apps call IPlayerClient.setActiveTrack from interactive component. Apps must implement this function to set audio, video or text track by ID on MSE player instance. The media sesssion should update its IISessionStatus to reflect the new playback status.

​

Parameters

trackType

ITrackType The type of the track to set as active.

trackId

string The track ID of the track to set as active.

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleGetCurrentPosition

handleGetCurrentPosition: (sessionId?: IPlayerSessionId) => number

Handles request for interactive component to get the current playback position of media playback. This call is received when apps call IPlayerClient.getCurrentPosition from interactive component. Apps must implement this function to get currentTime from {Audio,Video} Player instance corresponding to sessionId and then apps must resolve promise with number indicating current playback position (in seconds).

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

​

Returns

number The current playback position of media playback session corresponding to sessionId.

---

​

handleMessage

handleMessage: (message: any, sessionId?: IPlayerSessionId) => void

Handles a request to receive a custom message from interactive component. Apps can use message object to perform custom operations. This call is received when apps call IPlayerClient.sendMessage from interactive component. Apps may implement this function to handle custom operations in service component.

​

Parameters

message

any The message to be handled. To be sent as JSON object.

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the PlayerServer decides how to handle the request.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStartBufferedRangesUpdates

handleStartBufferedRangesUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps make at least one IPlayerClient.registerBufferedRangesListener call for sessionId from interactive component. Apps must start sending buffered ranges updates corresponding to sessionId by calling IPlayerServer.updateBufferedRanges API from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStopBufferedRangesUpdates

handleStopBufferedRangesUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps unsubscribe all IPlayerSessionBufferedRangesListener instances for sessionId from interactive component. Apps must stop sending buffered ranges updates corresponding to sessionId from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStartStatusUpdates

handleStartStatusUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps make at least one IPlayerClient.registerStatusListener call for sessionId from interactive component. Apps must start sending player session status updates corresponding to sessionId by calling IPlayerServer.updateStatus API from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStopStatusUpdates

handleStopStatusUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps unsubscribe all IPlayerSessionStatusListener instances for sessionId from interactive component. Apps must stop sending player session status updates corresponding to sessionId from service compoenent.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStartTrackUpdates

handleStartTrackUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps make at least one IPlayerClient.registerTrackListener call for sessionId from interactive component. Apps must start sending player session track updates corresponding to sessionId by calling IPlayerServer.addTrack or IPlayerServer.removeTrack APIs from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStopTrackUpdates

handleStopTrackUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps unsubscribe all IPlayerSessionTrackListener instances for sessionId from interactive component. Apps must stop sending player session track updates corresponding to sessionId from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStartMessageUpdates

handleStartMessageUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps make at least one IPlayerClient.registerMessageListener call for sessionId from interactive component. Apps can start sending custom messages as JSON objects by calling IPlayerServer.sendMessage API corresponding to sessionId from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStopMessageUpdates

handleStopMessageUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps unsubscribe all IPlayerSessionTrackListener instances for sessionId from interactive component. So, service component should not send any message corresponding to sessionId as there is no receiver of these messages available.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStartErrorUpdates

handleStartErrorUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps make at least one IPlayerClient.registerErrorListener call for sessionId from interactive component. Apps can start sending IPlayerSessionError as JSON objects by calling IPlayerServer.sendError API corresponding to sessionId from service component.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.

---

​

handleStopErrorUpdates

handleStopErrorUpdates: (sessionId?: IPlayerSessionId) => void

This call is received when apps unsubscribe all IPlayerSessionErrorListener instances for sessionId from interactive component. So, service component should not send any errors corresponding to sessionId as there is no receiver of these messages available.

​

Parameters

sessionId?

IPlayerSessionId The session ID to target with the request. If not specified, the session to target is decided by the server.

​

Throws

• InvalidArgumentError if the given sessionId does not exist.