doc/1.1.0/guacamole-common-js/Guacamole.SessionRecording.html - guacamole-website - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Class: SessionRecording</title>

     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->
     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
 </head>

 <body>

 <div id="main">

     <h1 class="page-title">Class: SessionRecording</h1>


 <section>

 <header>

         <h2><span class="attribs"><span class="type-signature"></span></span>
             <span class="ancestors"><a href="Guacamole.html">Guacamole</a>.</span>SessionRecording<span class="signature">(tunnel)</span><span class="type-signature"></span></h2>


 </header>

 <article>
     <div class="container-overview">


     <h4 class="name" id="SessionRecording"><span class="type-signature"></span>new SessionRecording<span class="signature">(tunnel)</span><span class="type-signature"></span></h4>


 <div class="description">
     A recording of a Guacamole session. Given a <a href="Guacamole.Tunnel.html">Guacamole.Tunnel</a>, the
 Guacamole.SessionRecording automatically handles incoming Guacamole
 instructions, storing them for playback. Playback of the recording may be
 controlled through function calls to the Guacamole.SessionRecording, even
 while the recording has not yet finished being created or downloaded.
 </div>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>tunnel</code></td>


             <td class="type">


 <span class="param-type"><a href="Guacamole.Tunnel.html">Guacamole.Tunnel</a></span>


             </td>


             <td class="description last">The Guacamole.Tunnel from which the instructions of the recording should
     be read.</td>
         </tr>


     </tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line34">line 34</a>
     </li></ul></dd>


 </dl>


     </div>


         <h3 class="subsection-title">Methods</h3>


     <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(data)</span><span class="type-signature"></span></h4>


 <div class="description">
     Connects the underlying tunnel, beginning download of the Guacamole
 session. Playback of the Guacamole session cannot occur until at least
 one frame worth of instructions has been downloaded.
 </div>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>data</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">The data to send to the tunnel when connecting.</td>
         </tr>


     </tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line480">line 480</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"></span></h4>


 <div class="description">
     Disconnects the underlying tunnel, stopping further download of the
 Guacamole session.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line488">line 488</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="getDisplay"><span class="type-signature"></span>getDisplay<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Guacamole.Display.html">Guacamole.Display</a>}</span></h4>


 <div class="description">
     Returns the underlying display of the Guacamole.Client used by this
 Guacamole.SessionRecording for playback. The display contains an Element
 which can be added to the DOM, causing the display (and thus playback of
 the recording) to become visible.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line502">line 502</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     The underlying display of the Guacamole.Client used by this
     Guacamole.SessionRecording for playback.
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type"><a href="Guacamole.Display.html">Guacamole.Display</a></span>


     </dd>
 </dl>


     <h4 class="name" id="getDuration"><span class="type-signature"></span>getDuration<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>


 <div class="description">
     Returns the duration of this recording, in milliseconds. If the
 recording is still being downloaded, this value will gradually increase.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line542">line 542</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     The duration of this recording, in milliseconds.
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Number</span>


     </dd>
 </dl>


     <h4 class="name" id="getPosition"><span class="type-signature"></span>getPosition<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>


 <div class="description">
     Returns the current playback position within the recording, in
 milliseconds, where zero is the start of the recording.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line523">line 523</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     The current playback position within the recording, in milliseconds.
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Number</span>


     </dd>
 </dl>


     <h4 class="name" id="isPlaying"><span class="type-signature"></span>isPlaying<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>


 <div class="description">
     Returns whether playback is currently in progress.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line512">line 512</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     true if playback is currently in progress, false otherwise.
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Boolean</span>


     </dd>
 </dl>


     <h4 class="name" id="pause"><span class="type-signature"></span>pause<span class="signature">()</span><span class="type-signature"></span></h4>


 <div class="description">
     Pauses playback of the recording, if playback is currently in progress.
 If playback is not in progress, this function has no effect. If a seek
 operation is in progress, the seek is aborted. Playback is initially
 paused when a Guacamole.SessionRecording is created, and must be
 explicitly started through a call to play().
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line632">line 632</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">()</span><span class="type-signature"></span></h4>


 <div class="description">
     Begins continuous playback of the recording downloaded thus far.
 Playback of the recording will continue until pause() is invoked or
 until no further frames exist. Playback is initially paused when a
 Guacamole.SessionRecording is created, and must be explicitly started
 through a call to this function. If playback is already in progress,
 this function has no effect. If a seek operation is in progress,
 playback resumes at the current position, and the seek is aborted as if
 completed.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line563">line 563</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="seek"><span class="type-signature"></span>seek<span class="signature">(position, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>


 <div class="description">
     Seeks to the given position within the recording. If the recording is
 currently being played back, playback will continue after the seek is
 performed. If the recording is currently paused, playback will be
 paused after the seek is performed. If a seek operation is already in
 progress, that seek is first aborted. The seek operation will proceed
 asynchronously.
 </div>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th>Attributes</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>position</code></td>


             <td class="type">


 <span class="param-type">Number</span>


             </td>


                 <td class="attributes">


                 </td>


             <td class="description last">The position within the recording to seek to, in milliseconds.</td>
         </tr>


         <tr>

                 <td class="name"><code>callback</code></td>


             <td class="type">


 <span class="param-type">function</span>


             </td>


                 <td class="attributes">

                     &lt;optional><br>


                 </td>


             <td class="description last">The callback to invoke once the seek operation has completed.</td>
         </tr>


     </tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line600">line 600</a>
     </li></ul></dd>


 </dl>


         <h3 class="subsection-title">Events</h3>


     <h4 class="name" id="event:onpause">onpause</h4>


 <div class="description">
     Fired whenever playback of the recording has been paused. This may
 happen when playback is explicitly paused with a call to pause(), or
 when playback is implicitly paused due to reaching the end of the
 recording.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line461">line 461</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="event:onplay">onplay</h4>


 <div class="description">
     Fired whenever playback of the recording has started.
 </div>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line451">line 451</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="event:onprogress">onprogress</h4>


 <div class="description">
     Fired when new frames have become available while the recording is
 being downloaded.
 </div>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>duration</code></td>


             <td class="type">


 <span class="param-type">Number</span>


             </td>


             <td class="description last">The new duration of the recording, in milliseconds.</td>
         </tr>


     </tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line444">line 444</a>
     </li></ul></dd>


 </dl>


     <h4 class="name" id="event:onseek">onseek</h4>


 <div class="description">
     Fired whenever the playback position within the recording changes.
 </div>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>position</code></td>


             <td class="type">


 <span class="param-type">Number</span>


             </td>


             <td class="description last">The new position within the recording, in milliseconds.</td>
         </tr>


     </tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="SessionRecording.js.html">SessionRecording.js</a>, <a href="SessionRecording.js.html#line470">line 470</a>
     </li></ul></dd>


 </dl>


 </article>

 </section>


 </div>

 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a href="Guacamole.BlobReader.html">BlobReader</a></li><li><a href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a href="Guacamole.Client.html">Client</a></li><li><a href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a href="Guacamole.Display.html">Display</a></li><li><a href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a href="Guacamole.InputSink.html">InputSink</a></li><li><a href="Guacamole.InputStream.html">InputStream</a></li><li><a href="Guacamole.IntegerPool.html">IntegerPool</a></li><li><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a href="Guacamole.Keyboard.html">Keyboard</a></li><li><a href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a href="Guacamole.Layer.html">Layer</a></li><li><a href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a href="Guacamole.Mouse.html">Mouse</a></li><li><a href="Guacamole.Mouse.State.html">State</a></li><li><a href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a href="Guacamole.Object.html">Object</a></li><li><a href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a href="Guacamole.OutputStream.html">OutputStream</a></li><li><a href="Guacamole.Parser.html">Parser</a></li><li><a href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a href="Guacamole.RawAudioPlayer.html">RawAudioPlayer</a></li><li><a href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a href="Guacamole.Status.html">Status</a></li><li><a href="Guacamole.StringReader.html">StringReader</a></li><li><a href="Guacamole.StringWriter.html">StringWriter</a></li><li><a href="Guacamole.Tunnel.html">Tunnel</a></li><li><a href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a href="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.Client.html#event:onargv">onargv</a></li><li><a href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a href="Guacamole.Client.html#event:onfilesystem">onfilesystem</a></li><li><a href="Guacamole.Client.html#event:onname">onname</a></li><li><a href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Object.html#event:onbody">onbody</a></li><li><a href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a href="Guacamole.SessionRecording.html#event:onplay">onplay</a></li><li><a href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a href="Guacamole.html">Guacamole</a></li><li><a href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul>
 </nav>

 <br class="clear">

 <footer>
     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 26 2020 10:17:42 GMT-0800 (PST)
 </footer>

 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>
 </body>
 </html>