Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id CE9E9200CE0 for ; Thu, 6 Jul 2017 04:20:00 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id CD69B161364; Thu, 6 Jul 2017 02:20:00 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 522F81650C5 for ; Thu, 6 Jul 2017 04:19:58 +0200 (CEST) Received: (qmail 51683 invoked by uid 500); 6 Jul 2017 02:19:57 -0000 Mailing-List: contact commits-help@guacamole.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@guacamole.incubator.apache.org Delivered-To: mailing list commits@guacamole.incubator.apache.org Received: (qmail 51620 invoked by uid 99); 6 Jul 2017 02:19:57 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:19:57 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 7D14BC0F74 for ; Thu, 6 Jul 2017 02:19:56 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -2.031 X-Spam-Level: X-Spam-Status: No, score=-2.031 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LINEPADDING=1.2, MANY_SPAN_IN_TEXT=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id dMuG8FfU-hOK for ; Thu, 6 Jul 2017 02:19:51 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 7A76661F37 for ; Thu, 6 Jul 2017 02:19:36 +0000 (UTC) Received: (qmail 50332 invoked by uid 99); 6 Jul 2017 02:19:32 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:19:32 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4DC41F3254; Thu, 6 Jul 2017 02:19:29 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jmuehlner@apache.org To: commits@guacamole.incubator.apache.org Date: Thu, 06 Jul 2017 02:20:04 -0000 Message-Id: In-Reply-To: <7f1987d79c9843f9805d91c717c6901a@git.apache.org> References: <7f1987d79c9843f9805d91c717c6901a@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [37/64] [partial] incubator-guacamole-website git commit: Add documentation for 0.9.13-incubating. archived-at: Thu, 06 Jul 2017 02:20:00 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/fd9055f3/doc/0.9.13-incubating/guacamole-common-js/Guacamole.OutputStream.html ---------------------------------------------------------------------- diff --git a/doc/0.9.13-incubating/guacamole-common-js/Guacamole.OutputStream.html b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.OutputStream.html new file mode 100644 index 0000000..ba18f15 --- /dev/null +++ b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.OutputStream.html @@ -0,0 +1,664 @@ + + + + + JSDoc: Class: OutputStream + + + + + + + + + + +
+ +

Class: OutputStream

+ + + + + + +
+ +
+ +

+ Guacamole.OutputStream

+ + +
+ +
+
+ + + + + +

new OutputStream(client, index)

+ + + + + +
+ Abstract stream which can receive data. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +Guacamole.Client + + + + The client owning this stream.
index + + +Number + + + + The index of this stream.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +

Members

+ + + +

index :Number

+ + + + +
+ The index of this stream. +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

sendBlob(data)

+ + + + + +
+ Writes the given base64-encoded data to this stream as a blob. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +String + + + + The base64-encoded data to send.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

sendEnd()

+ + + + + +
+ Closes this stream. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +

Events

+ + + + + + +

onack

+ + + + + +
+ Fired whenever an acknowledgement is received from the server, indicating +that a stream operation has completed, or an error has occurred. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
status + + +Guacamole.Status + + + + The status of the operation.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/fd9055f3/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Parser.html ---------------------------------------------------------------------- diff --git a/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Parser.html b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Parser.html new file mode 100644 index 0000000..c6c4f3d --- /dev/null +++ b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Parser.html @@ -0,0 +1,460 @@ + + + + + JSDoc: Class: Parser + + + + + + + + + + +
+ +

Class: Parser

+ + + + + + +
+ +
+ +

+ Guacamole.Parser

+ + +
+ +
+
+ + + + + +

new Parser()

+ + + + + +
+ Simple Guacamole protocol parser that invokes an oninstruction event when +full instructions are available from data received via receive(). +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

receive(packet)

+ + + + + +
+ Appends the given instruction data packet to the internal buffer of +this Guacamole.Parser, executing all completed instructions at +the beginning of this buffer, if any. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
packet + + +String + + + + The instruction data to receive.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +

Events

+ + + + + + +

oninstruction

+ + + + + +
+ Fired once for every complete Guacamole instruction received, in order. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
opcode + + +String + + + + The Guacamole instruction opcode.
parameters + + +Array + + + + The parameters provided for the instruction, + if any.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/fd9055f3/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioFormat.html ---------------------------------------------------------------------- diff --git a/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioFormat.html b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioFormat.html new file mode 100644 index 0000000..baa9e61 --- /dev/null +++ b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioFormat.html @@ -0,0 +1,601 @@ + + + + + JSDoc: Class: RawAudioFormat + + + + + + + + + + +
+ +

Class: RawAudioFormat

+ + + + + + +
+ +
+ +

+ Guacamole.RawAudioFormat

+ + +
+ +
+
+ + + + + +

new RawAudioFormat(template)

+ + + + + +
+ A description of the format of raw PCM audio, such as that used by +Guacamole.RawAudioPlayer and Guacamole.RawAudioRecorder. This object +describes the number of bytes per sample, the number of channels, and the +overall sample rate. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
template + + +Guacamole.RawAudioFormat +| + +Object + + + + The object whose properties should be copied into the corresponding + properties of the new Guacamole.RawAudioFormat.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +

Members

+ + + +

bytesPerSample :Number

+ + + + +
+ The number of bytes in each sample of audio data. This value is +independent of the number of channels. +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

channels :Number

+ + + + +
+ The number of audio channels (ie: 1 for mono, 2 for stereo). +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

rate :Number

+ + + + +
+ The number of samples per second, per channel. +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) parse(mimetype) → {Guacamole.RawAudioFormat}

+ + + + + +
+ Parses the given mimetype, returning a new Guacamole.RawAudioFormat +which describes the type of raw audio data represented by that mimetype. If +the mimetype is not a supported raw audio data mimetype, null is returned. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mimetype + + +String + + + + The audio mimetype to parse.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ A new Guacamole.RawAudioFormat which describes the type of raw + audio data represented by the given mimetype, or null if the given + mimetype is not supported. +
+ + + +
+
+ Type +
+
+ +Guacamole.RawAudioFormat + + +
+
+ + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/fd9055f3/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioPlayer.html ---------------------------------------------------------------------- diff --git a/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioPlayer.html b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioPlayer.html new file mode 100644 index 0000000..4baaec3 --- /dev/null +++ b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioPlayer.html @@ -0,0 +1,610 @@ + + + + + JSDoc: Class: RawAudioPlayer + + + + + + + + + + +
+ +

Class: RawAudioPlayer

+ + + + + + +
+ +
+ +

+ Guacamole.RawAudioPlayer

+ + +
+ +
+
+ + + + + +

new RawAudioPlayer(stream, mimetype)

+ + + + + +
+ Implementation of Guacamole.AudioPlayer providing support for raw PCM format +audio. This player relies only on the Web Audio API and does not require any +browser-level support for its audio formats. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
stream + + +Guacamole.InputStream + + + + The Guacamole.InputStream to read audio data from.
mimetype + + +String + + + + The mimetype of the audio data in the provided stream, which must be a + "audio/L8" or "audio/L16" mimetype with necessary parameters, such as: + "audio/L16;rate=44100,channels=2".
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

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

+ + + + + +
+ Returns a list of all mimetypes supported by Guacamole.RawAudioPlayer. Only +the core mimetypes themselves will be listed. Any mimetype parameters, even +required ones, will not be included in the list. For example, "audio/L8" is +a raw audio mimetype that may be supported, but it is invalid without +additional parameters. Something like "audio/L8;rate=44100" would be valid, +however (see https://tools.ietf.org/html/rfc4856). +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ A list of all mimetypes supported by Guacamole.RawAudioPlayer, excluding + any parameters. If the necessary JavaScript APIs for playing raw audio + are absent, this list will be empty. +
+ + + +
+
+ Type +
+
+ +Array.<String> + + +
+
+ + + + + + + + + + +

(static) isSupportedType(mimetype) → {Boolean}

+ + + + + +
+ Determines whether the given mimetype is supported by +Guacamole.RawAudioPlayer. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mimetype + + +String + + + + The mimetype to check.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ true if the given mimetype is supported by Guacamole.RawAudioPlayer, + false otherwise. +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + +

sync()

+ + + + + +
+ Notifies this Guacamole.AudioPlayer that all audio up to the current +point in time has been given via the underlying stream, and that any +difference in time between queued audio data and the current time can be +considered latency. +
+ + + + + + + + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/fd9055f3/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioRecorder.html ---------------------------------------------------------------------- diff --git a/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioRecorder.html b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioRecorder.html new file mode 100644 index 0000000..76a3d66 --- /dev/null +++ b/doc/0.9.13-incubating/guacamole-common-js/Guacamole.RawAudioRecorder.html @@ -0,0 +1,855 @@ + + + + + JSDoc: Class: RawAudioRecorder + + + + + + + + + + +
+ +

Class: RawAudioRecorder

+ + + + + + +
+ +
+ +

+ Guacamole.RawAudioRecorder

+ + +
+ +
+
+ + + + + +

new RawAudioRecorder(stream, mimetype)

+ + + + + +
+ Implementation of Guacamole.AudioRecorder providing support for raw PCM +format audio. This recorder relies only on the Web Audio API and does not +require any browser-level support for its audio formats. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
stream + + +Guacamole.OutputStream + + + + The Guacamole.OutputStream to write audio data to.
mimetype + + +String + + + + The mimetype of the audio data to send along the provided stream, which + must be a "audio/L8" or "audio/L16" mimetype with necessary parameters, + such as: "audio/L16;rate=44100,channels=2".
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ + + +

(inner) getUserMedia :function

+ + + + +
+ A function which directly invokes the browser's implementation of +navigator.getUserMedia() with all provided parameters. +
+ + + +
Type:
+
    +
  • + +function + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

(inner) mediaStream :MediaStream

+ + + + +
+ The audio stream provided by the browser, if allowed. If no stream has +yet been received, this will be null. +
+ + + +
Type:
+
    +
  • + +MediaStream + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

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

+ + + + + +
+ Returns a list of all mimetypes supported by Guacamole.RawAudioRecorder. Only +the core mimetypes themselves will be listed. Any mimetype parameters, even +required ones, will not be included in the list. For example, "audio/L8" is +a raw audio mimetype that may be supported, but it is invalid without +additional parameters. Something like "audio/L8;rate=44100" would be valid, +however (see https://tools.ietf.org/html/rfc4856). +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ A list of all mimetypes supported by Guacamole.RawAudioRecorder, + excluding any parameters. If the necessary JavaScript APIs for recording + raw audio are absent, this list will be empty. +
+ + + +
+
+ Type +
+
+ +Array.<String> + + +
+
+ + + + + + + + + + +

(static) isSupportedType(mimetype) → {Boolean}

+ + + + + +
+ Determines whether the given mimetype is supported by +Guacamole.RawAudioRecorder. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mimetype + + +String + + + + The mimetype to check.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ true if the given mimetype is supported by Guacamole.RawAudioRecorder, + false otherwise. +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + +

Events

+ + + + + + +

onclose

+ + + + + +
+ Callback which is invoked when the audio recording process has stopped +and the underlying Guacamole stream has been closed normally. Audio will +only resume recording if a new Guacamole.AudioRecorder is started. This +Guacamole.AudioRecorder instance MAY NOT be reused. +
+ + + + + + + + + + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

onerror

+ + + + + +
+ Callback which is invoked when the audio recording process cannot +continue due to an error, if it has started at all. The underlying +Guacamole stream is automatically closed. Future attempts to record +audio should not be made, and this Guacamole.AudioRecorder instance +MAY NOT be reused. +
+ + + + + + + + + + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + \ No newline at end of file