IPlayerClient - Amazon Vega Docs

An interface that represents a PlayerClient.

Properties

clearTextView()

clearTextView: (sessionId?) => Promise<void> Request the media session in PlayerServer to clear the KeplerCaptionsView rendering the captions content.

Parameters

sessionId?

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

Returns

Promise<void> A Promise that resolves when the request is successfully handled, or rejects with an error if the request fails.

Example

const sessionId: IPlayerSessionId = {id: 1};
try {
  await playerClientRef.current?.clearTextView(sessionId);
} catch (error) {
  console.error('Error while calling clearTextView: ', error);
  // Perform error handling.
}

clearVideoView()

clearVideoView: (sessionId?) => Promise<void> Request the media session in PlayerServer to clear the KeplerVideoSurfaceView rendering the video content.

Parameters

sessionId?

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

Returns

Promise<void> A Promise that resolves when the request is successfully handled, or rejects with an error if the request fails.

Example

const sessionId: IPlayerSessionId = {id: 1};
try {
  await playerClientRef.current?.clearVideoView(sessionId);
} catch (error) {
  console.error('Error while calling clearVideoView: ', error);
  // Perform error handling.
}

​Properties

​clearTextView()

​Parameters

sessionId?

​Returns

​Example

​clearVideoView()

​Parameters

sessionId?

​Returns

​Example

Properties

clearTextView()

Parameters

Returns

Example

clearVideoView()

Parameters

Returns

Example