Class: VideoPlayer

Guacamole.VideoPlayer()

new VideoPlayer()

Abstract video player which accepts, queues and plays back arbitrary video data. It is up to implementations of this class to provide some means of handling a provided Guacamole.InputStream and rendering the received data to the provided Guacamole.Display.VisibleLayer. Data received along the provided stream is to be played back immediately.
Source:

Methods

(static) getInstance(stream, layer, mimetype) → {Guacamole.VideoPlayer}

Returns an instance of Guacamole.VideoPlayer providing support for the given video format. If support for the given video format is not available, null is returned.
Parameters:
Name Type Description
stream Guacamole.InputStream The Guacamole.InputStream to read video data from.
layer Guacamole.Display.VisibleLayer The destination layer in which this Guacamole.VideoPlayer should play the received video data.
mimetype String The mimetype of the video data in the provided stream.
Source:
Returns:
A Guacamole.VideoPlayer instance supporting the given mimetype and reading from the given stream, or null if support for the given mimetype is absent.
Type
Guacamole.VideoPlayer

(static) getSupportedTypes() → {Array.<String>}

Returns a list of all mimetypes supported by any built-in Guacamole.VideoPlayer, in rough order of priority. Beware that only the core mimetypes themselves will be listed. Any mimetype parameters, even required ones, will not be included in the list.
Source:
Returns:
A list of all mimetypes supported by any built-in Guacamole.VideoPlayer, excluding any parameters.
Type
Array.<String>

(static) isSupportedType(mimetype) → {Boolean}

Determines whether the given mimetype is supported by any built-in implementation of Guacamole.VideoPlayer, and thus will be properly handled by Guacamole.VideoPlayer.getInstance().
Parameters:
Name Type Description
mimetype String The mimetype to check.
Source:
Returns:
true if the given mimetype is supported by any built-in Guacamole.VideoPlayer, false otherwise.
Type
Boolean

sync()

Notifies this Guacamole.VideoPlayer that all video up to the current point in time has been given via the underlying stream, and that any difference in time between queued video data and the current time can be considered latency.
Source: