Class: InputStream

Guacamole.InputStream(clientnon-null, indexnon-null)

new InputStream(clientnon-null, indexnon-null)

An input stream abstraction used by the Guacamole client to facilitate transfer of files or other binary data.
Parameters:
Name Type Description
client Guacamole.Client The client owning this stream.
index number The index of this stream.
Source:

Members

(non-null) index :number

The index of this stream.
Type:
  • number
Source:

Methods

sendAck(messagenon-null, codenon-null)

Acknowledges the receipt of a blob.
Parameters:
Name Type Description
message string A human-readable message describing the error or status.
code number The error code, if any, or 0 for success.
Source:

toReadableStream() → (non-null) {ReadableStream}

Creates a new ReadableStream that receives the data sent to this stream by the Guacamole server. This function may be invoked at most once per stream, and invoking this function will overwrite any installed event handlers on this stream. A ReadableStream is a JavaScript object defined by the "Streams" standard. It is supported by most browsers, but not necessarily all browsers. The caller should verify this support is present before invoking this function. The behavior of this function when the browser does not support ReadableStream is not defined.
Source:
See:
Returns:
A new ReadableStream that receives the bytes sent along this stream by the Guacamole server.
Type
ReadableStream

Events

onblob

Called when a blob of data is received.
Parameters:
Name Type Description
data string The received base64 data.
Source:

onend

Called when this stream is closed.
Source: