remoting/webapp/base/js/client_plugin.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * Interface abstracting the ClientPlugin functionality.
   8  */
   9
  10 'use strict';
  11
  12 /** @suppress {duplicate} */
  13 var remoting = remoting || {};
  14
  15 /**
  16  * @interface
  17  * @extends {base.Disposable}
  18  */
  19 remoting.ClientPlugin = function() {};
  20
  21 /**
  22  * @return {remoting.HostDesktop}
  23  */
  24 remoting.ClientPlugin.prototype.hostDesktop = function() {};
  25
  26 /**
  27  * @return {remoting.ProtocolExtensionManager}
  28  */
  29 remoting.ClientPlugin.prototype.extensions = function() {};
  30
  31 /**
  32  * @return {HTMLElement} The DOM element representing the remote session.
  33  */
  34 remoting.ClientPlugin.prototype.element = function() {};
  35
  36 /**
  37  * @param {function(boolean):void} onDone Completion callback.
  38  */
  39 remoting.ClientPlugin.prototype.initialize = function(onDone) {};
  40
  41 /**
  42  * @param {remoting.Host} host The host to connect to.
  43  * @param {string} localJid Local jid.
  44  * @param {remoting.CredentialsProvider} credentialsProvider
  45  */
  46 remoting.ClientPlugin.prototype.connect =
  47     function(host, localJid, credentialsProvider) {};
  48
  49 /**
  50  * @param {number} key The keycode to inject.
  51  * @param {boolean} down True for press; false for a release.
  52  */
  53 remoting.ClientPlugin.prototype.injectKeyEvent =
  54     function(key, down) {};
  55
  56 /**
  57  * Sends a key combination to the host, by sending down events for
  58  * the given keys, followed by up events in reverse order.
  59  *
  60  * @param {Array<number>} keys Key codes to be sent.
  61  * @return {void} Nothing.
  62  */
  63 remoting.ClientPlugin.prototype.injectKeyCombination = function(keys) {};
  64
  65 /**
  66  * Sets and stores the key remapping setting for the current host.
  67  *
  68  * @param {!Object} remappings Key mappings, specified as {from: to}, where
  69  *     |from| and |to| are both USB keycodes, |from| is a decimal representation
  70  *     (because object keys must be strings) and |to| is a number.
  71  */
  72 remoting.ClientPlugin.prototype.setRemapKeys = function(remappings) {};
  73
  74 /**
  75  * @param {number} from
  76  * @param {number} to
  77  */
  78 remoting.ClientPlugin.prototype.remapKey = function(from, to) {};
  79
  80 /**
  81  * Release all keys currently being pressed.
  82  */
  83 remoting.ClientPlugin.prototype.releaseAllKeys = function() {};
  84
  85 /**
  86  * @param {string} iq
  87  */
  88 remoting.ClientPlugin.prototype.onIncomingIq = function(iq) {};
  89
  90 /**
  91  * @param {remoting.ClientSession.Capability} capability
  92  * @return {boolean} True if the capability has been negotiated between
  93  *     the client and host.
  94  */
  95 remoting.ClientPlugin.prototype.hasCapability = function(capability) {};
  96
  97 /**
  98  * Sends a clipboard item to the host.
  99  *
 100  * @param {string} mimeType The MIME type of the clipboard item.
 101  * @param {string} item The clipboard item.
 102  */
 103 remoting.ClientPlugin.prototype.sendClipboardItem =
 104     function(mimeType, item) {};
 105
 106 /**
 107  * Notifies the plugin whether to send touch events to the host.
 108  *
 109  * @param {boolean} enable True if touch events should be sent.
 110  */
 111 remoting.ClientPlugin.prototype.enableTouchEvents = function(enable) {};
 112
 113 /**
 114  * Request that this client be paired with the current host.
 115  *
 116  * @param {string} clientName The human-readable name of the client.
 117  * @param {function(string, string):void} onDone Callback to receive the
 118  *     client id and shared secret when they are available.
 119  */
 120 remoting.ClientPlugin.prototype.requestPairing =
 121     function(clientName, onDone) {};
 122
 123 /**
 124  * Allows automatic mouse-lock.
 125  */
 126 remoting.ClientPlugin.prototype.allowMouseLock = function() {};
 127
 128 /**
 129  * @param {boolean} pause True to pause the audio stream; false to resume it.
 130  */
 131 remoting.ClientPlugin.prototype.pauseAudio = function(pause) {};
 132
 133 /**
 134  * @param {boolean} pause True to pause the video stream; false to resume it.
 135  */
 136 remoting.ClientPlugin.prototype.pauseVideo = function(pause) {};
 137
 138 /**
 139  * @return {remoting.ClientSession.PerfStats} A summary of the connection
 140  *     performance.
 141  */
 142 remoting.ClientPlugin.prototype.getPerfStats = function() {};
 143
 144 /**
 145  * @param {remoting.ClientPlugin.ConnectionEventHandler} handler
 146  */
 147 remoting.ClientPlugin.prototype.setConnectionEventHandler =
 148     function(handler) {};
 149
 150 /**
 151  * @param {function(string, number, number):void} handler Callback for
 152  *     processing large mouse cursor images. The first parameter is a data:
 153  *     URL encoding the mouse cursor; the second and third parameters are
 154  *     the cursor hotspot's x- and y-coordinates, respectively.
 155  */
 156 remoting.ClientPlugin.prototype.setMouseCursorHandler = function(handler) {};
 157
 158 /**
 159  * @param {function(string, string):void} handler Callback for processing
 160  *    clipboard data injected from the host. The first parameter is the mime
 161  *    type and the second parameter is the actual data.
 162  */
 163 remoting.ClientPlugin.prototype.setClipboardHandler = function(handler) {};
 164
 165 /**
 166  * @param {function({rects:Array<Array<number>>}):void|null} handler Callback
 167  *     to receive dirty region information for each video frame, for debugging.
 168  */
 169 remoting.ClientPlugin.prototype.setDebugDirtyRegionHandler =
 170     function(handler) {};
 171
 172 /**
 173  * @interface
 174  */
 175 remoting.ClientPlugin.ConnectionEventHandler = function() {};
 176
 177 /**
 178  * @param {string} iq
 179  */
 180 remoting.ClientPlugin.ConnectionEventHandler.prototype.onOutgoingIq =
 181     function(iq) {};
 182
 183 /**
 184  * @param {string} msg
 185  */
 186 remoting.ClientPlugin.ConnectionEventHandler.prototype.onDebugMessage =
 187     function(msg) {};
 188
 189 /**
 190  * @param {remoting.ClientSession.State} status The plugin's status.
 191  * @param {remoting.ClientSession.ConnectionError} error The plugin's error
 192  *        state, if any.
 193  */
 194 remoting.ClientPlugin.ConnectionEventHandler.prototype.
 195     onConnectionStatusUpdate = function(status, error) {};
 196
 197 /**
 198  * @param {string} channel The channel name.
 199  * @param {string} connectionType The new connection type.
 200  */
 201 remoting.ClientPlugin.ConnectionEventHandler.prototype.onRouteChanged =
 202     function(channel, connectionType) {};
 203
 204 /**
 205  * @param {boolean} ready True if the connection is ready.
 206  */
 207 remoting.ClientPlugin.ConnectionEventHandler.prototype.onConnectionReady =
 208     function(ready) {};
 209
 210 /** Called when the first video frame is received */
 211 remoting.ClientPlugin.ConnectionEventHandler.prototype.onFirstFrameReceived =
 212     function() {};
 213
 214 /**
 215  * @interface
 216  */
 217 remoting.ClientPluginFactory = function() {};
 218
 219 /**
 220  * @param {Element} container The container for the embed element.
 221  * @param {Array<string>} requiredCapabilities
 222  * @return {remoting.ClientPlugin} A new client plugin instance.
 223  */
 224 remoting.ClientPluginFactory.prototype.createPlugin =
 225     function(container, requiredCapabilities) {};
 226
 227 /**
 228  * Preload the plugin to make instantiation faster when the user tries
 229  * to connect.
 230  */
 231 remoting.ClientPluginFactory.prototype.preloadPlugin = function() {};
 232
 233 /**
 234  * @type {remoting.ClientPluginFactory}
 235  */
 236 remoting.ClientPlugin.factory = null;