@capturebridge/sdk 0.7.0 → 0.7.1

package/StreamingCapturePlugin.js

@@ -1,121 +1,121 @@
-import CapturePlugin from './CapturePlugin.js'
-import { BASE_URL, DATAURL_JPEG, blobToBuffer } from './Common.js'
-
-class StreamingCapturePlugin extends CapturePlugin {
-  constructor (plugin, baseUrl = BASE_URL) {
-    super(plugin, baseUrl)
-  }
-
-  /**
-   * Get the CapturePlugin's stream endpoint URL.
-   *
-   * @description The URL returned from this endpoint can be attached to an
-   * img tag's src attribute. The camera's live stream will be started and
-   * begin streaming to the img tag as a
-   * {@link https://en.wikipedia.org/wiki/Motion_JPEG|Motion JPEG} stream.
-   * If the src is changed, the img removed from the DOM, or client disconnected
-   * for any reason, the live feed will automatically be stopped.
-   *
-   * @param {string|object} [deviceOpt] - Get the stream URL from either a
-   * specific Device ID or a Device Object. The default is the first available
-   * device.
-   *
-   * @async
-   * @method
-   * @returns {string} stream endpoint URL
-   * @example
-   * const img = document.createElement('img')
-   * img.src = await camera.streamUrl()
-   * document.body.appendChild(img)
-   */
-  async streamUrl (deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    return device.streamUrl()
-  }
-
-  /**
-   * Get the most recent frame from a device's live feed.
-   *
-   * @description This method will startup the device's live
-   * feed if necessary and wait for it to initialize before returning a frame.
-   * Subsequent calls will return the next available frame.
-   * You must manually stop the live feed if you are using this method.
-   *
-   * If implementing a real-time preview, it is highly recommended to use the
-   * stream endpoint which will stream a Motion JPEG.
-   *
-   * @see {@link CapturePlugin#streamUrl}
-   * @see {@link CapturePlugin#stopFeed}
-   *
-   * @param {string} [kind=buffer] - Specify how to return the captured image. Valid
-   * values are 'blob', 'buffer', 'base64', or 'dataurl'.
-   *
-   * The default value of 'buffer' will load the image into an
-   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer|ArrayBuffer}
-   * that can be set directly on an img tag's src attribute.
-   *
-   * The value of 'blob' will return a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob} that can
-   * be used with a
-   * {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader|FileReader}.
-   *
-   * The value of 'base64' will return the image contents as a
-   * {@link https://en.wikipedia.org/wiki/Base64|Base64} encoded string that is
-   * suitable for use with JSON serialization.
-   *
-   * The value of 'dataurl' will return a JPEG
-   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
-   * that can be set on an img tag's src attribute or loaded as a document
-   * location.
-   *
-   * @param {string|object} [deviceOpt] - Return the frame from either a
-   * specific Device ID or a Device Object. The default, if not supplied, is the
-   * first available device.
-   *
-   * @async
-   * @method
-   * @example
-   * // Get the most recent frame from the camera's live feed as an ArrayBuffer
-   * // and add it to an img tag appended to the document's body.
-   * const img = document.createElement('img')
-   * img.src = await camera.getMostRecentFrame()
-   * document.body.appendChild(img)
-   *
-   * // Stop the live feed when done getting frames
-   * await camera.stopFeed()
-   */
-  async getMostRecentFrame (kind = 'buffer', deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    switch (kind) {
-      case 'blob':
-        return await device.frameAsBlob()
-      case 'buffer':
-        return await blobToBuffer(await device.frameAsBlob())
-      case 'base64':
-        return await device.frameAsBase64()
-      case 'dataurl':
-        return DATAURL_JPEG + (await device.frameAsBase64())
-    }
-    throw new Error(`Unknown image response type: ${kind}`)
-  }
-
-  /**
-   * Stop the camera's live feed if it is running.
-   *
-   * @method
-   * @async
-   * @returns {object} Status of the stop operation
-   * @example
-   * // CapturePlugin is now running it's live feed in a background thread
-   * const frame = await camera.getMostRecentFrame()
-   * // Do some stuff with frame...
-   * // Stop the live feed
-   * console.log(await camera.stopFeed())
-   */
-  async stopFeed (deviceOpt) {
-    const device = await this.setupDevice(deviceOpt)
-    return await device.stopFeed()
-  }
-}
-
-export default StreamingCapturePlugin
+import CapturePlugin from './CapturePlugin.js'
+import { BASE_URL, DATAURL_JPEG, blobToBuffer } from './Common.js'
+
+class StreamingCapturePlugin extends CapturePlugin {
+  constructor (plugin, baseUrl = BASE_URL) {
+    super(plugin, baseUrl)
+  }
+
+  /**
+   * Get the CapturePlugin's stream endpoint URL.
+   *
+   * @description The URL returned from this endpoint can be attached to an
+   * img tag's src attribute. The camera's live stream will be started and
+   * begin streaming to the img tag as a
+   * {@link https://en.wikipedia.org/wiki/Motion_JPEG|Motion JPEG} stream.
+   * If the src is changed, the img removed from the DOM, or client disconnected
+   * for any reason, the live feed will automatically be stopped.
+   *
+   * @param {string|object} [deviceOpt] - Get the stream URL from either a
+   * specific Device ID or a Device Object. The default is the first available
+   * device.
+   *
+   * @async
+   * @method
+   * @returns {string} stream endpoint URL
+   * @example
+   * const img = document.createElement('img')
+   * img.src = await camera.streamUrl()
+   * document.body.appendChild(img)
+   */
+  async streamUrl (deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return device.streamUrl()
+  }
+
+  /**
+   * Get the most recent frame from a device's live feed.
+   *
+   * @description This method will startup the device's live
+   * feed if necessary and wait for it to initialize before returning a frame.
+   * Subsequent calls will return the next available frame.
+   * You must manually stop the live feed if you are using this method.
+   *
+   * If implementing a real-time preview, it is highly recommended to use the
+   * stream endpoint which will stream a Motion JPEG.
+   *
+   * @see {@link CapturePlugin#streamUrl}
+   * @see {@link CapturePlugin#stopFeed}
+   *
+   * @param {string} [kind=buffer] - Specify how to return the captured image. Valid
+   * values are 'blob', 'buffer', 'base64', or 'dataurl'.
+   *
+   * The default value of 'buffer' will load the image into an
+   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer|ArrayBuffer}
+   * that can be set directly on an img tag's src attribute.
+   *
+   * The value of 'blob' will return a
+   * {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob|Blob} that can
+   * be used with a
+   * {@link https://developer.mozilla.org/en-US/docs/Web/API/FileReader|FileReader}.
+   *
+   * The value of 'base64' will return the image contents as a
+   * {@link https://en.wikipedia.org/wiki/Base64|Base64} encoded string that is
+   * suitable for use with JSON serialization.
+   *
+   * The value of 'dataurl' will return a JPEG
+   * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URL}
+   * that can be set on an img tag's src attribute or loaded as a document
+   * location.
+   *
+   * @param {string|object} [deviceOpt] - Return the frame from either a
+   * specific Device ID or a Device Object. The default, if not supplied, is the
+   * first available device.
+   *
+   * @async
+   * @method
+   * @example
+   * // Get the most recent frame from the camera's live feed as an ArrayBuffer
+   * // and add it to an img tag appended to the document's body.
+   * const img = document.createElement('img')
+   * img.src = await camera.getMostRecentFrame()
+   * document.body.appendChild(img)
+   *
+   * // Stop the live feed when done getting frames
+   * await camera.stopFeed()
+   */
+  async getMostRecentFrame (kind = 'buffer', deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    switch (kind) {
+      case 'blob':
+        return await device.frameAsBlob()
+      case 'buffer':
+        return await blobToBuffer(await device.frameAsBlob())
+      case 'base64':
+        return await device.frameAsBase64()
+      case 'dataurl':
+        return DATAURL_JPEG + (await device.frameAsBase64())
+    }
+    throw new Error(`Unknown image response type: ${kind}`)
+  }
+
+  /**
+   * Stop the camera's live feed if it is running.
+   *
+   * @method
+   * @async
+   * @returns {object} Status of the stop operation
+   * @example
+   * // CapturePlugin is now running it's live feed in a background thread
+   * const frame = await camera.getMostRecentFrame()
+   * // Do some stuff with frame...
+   * // Stop the live feed
+   * console.log(await camera.stopFeed())
+   */
+  async stopFeed (deviceOpt) {
+    const device = await this.setupDevice(deviceOpt)
+    return await device.stopFeed()
+  }
+}
+
+export default StreamingCapturePlugin

package/TopazSigGem.js

@@ -1,25 +1,25 @@
-import SignatureTablet from './SignatureTablet.js'
-import { BASE_URL } from './Common.js'
-
-/**
- * TopazSigGem
- * @classdesc Convience class for instantiating a Topaz SigGem Signature Tablet
- * Inherits all methods on the {@link SignatureTablet} class.
- *
- * @see {@link SignatureTablet}
- */
-class TopazSigGem extends SignatureTablet {
-  /**
-   * Instantiate a Topaz SigGem Signature Tablet
-   * @constructor
-   * @param {string} [baseURL] - Protocol, domain, and port for the service.
-   * @example
-   * const camera = new TopazSigGem()
-   *
-   */
-  constructor (baseUrl = BASE_URL) {
-    super('capture_signature_topaz', baseUrl)
-  }
-}
-
-export default TopazSigGem
+import SignatureTablet from './SignatureTablet.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * TopazSigGem
+ * @classdesc Convience class for instantiating a Topaz SigGem Signature Tablet
+ * Inherits all methods on the {@link SignatureTablet} class.
+ *
+ * @see {@link SignatureTablet}
+ */
+class TopazSigGem extends SignatureTablet {
+  /**
+   * Instantiate a Topaz SigGem Signature Tablet
+   * @constructor
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const camera = new TopazSigGem()
+   *
+   */
+  constructor (baseUrl = BASE_URL) {
+    super('capture_signature_topaz', baseUrl)
+  }
+}
+
+export default TopazSigGem

package/package.json

@@ -3,5 +3,5 @@
   "description": "Capture Bridge JavaScript SDK for web applications",
   "type": "module",
   "license": "Apache-2.0",
-  "version": "0.7.0"
+  "version": "0.7.1"
 }