CanonCamera

const camera = new CanonCamera()
const base64 = await camera.takePhoto({kind: 'base64'})

Extends

• Camera

Members

baseUrl

Source:

• Plugin.js, line 26

Overrides:

• Camera#baseUrl

Properties:

Methods

(async) device(id) → (nullable) {object}

Description:

• Get a device by ID for this plugin

Source:

• Plugin.js, line 90

Overrides:

• Camera#device

See:

• API Endpoint (/plugin/:pluginId/device)

Example

const plugin = await captureBridge.plugin('capture_camera_canon')
const device = await plugin.device('AWOOO56709')

Parameters:

Returns:

Type

object

(async) devices() → {Array.<object>}

Description:

• Get all devices for this plugin

Source:

• Plugin.js, line 71

Overrides:

• Camera#devices

See:

• API Endpoint (/plugin/:pluginId/device)

Example

const plugin = await captureBridge.plugin('capture_camera_canon')
const devices = await plugin.devices()

Returns:

Type

Array.<object>

(async) fullCapture(captureOptopt, deviceOptopt)

Description:

• Take a full capture

Source:

• CapturePlugin.js, line 49

Overrides:

• Camera#fullCapture

Example

// Capture an image as an ArrayBuffer and add it to an img tag appended to
// the document's body.
const img = document.createElement('img')
img.src = await capture.fullCapture()
document.body.appendChild(img)

Parameters:

(async) getMostRecentFrame(captureOptopt, deviceOptopt)

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.

Source:

• StreamingCapturePlugin.js, line 82

Overrides:

• Camera#getMostRecentFrame

See:

• CapturePlugin#streamUrl
• CapturePlugin#stopFeed

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()

Parameters:

(async) hasMethod(method) → {boolean}

Description:

• Check if a plugin has an RPC method

Source:

• Plugin.js, line 191

Overrides:

• Camera#hasMethod

Example

const canCapture = await plugin.hasMethod('capture')

Parameters:

Returns:

Type

boolean

(async) info() → {object}

Description:

• Returns detailed information about a camera.

Source:

• CanonCamera.js, line 35

Example

const info = await device.info()

Returns:

Type

object

(async) shutdown(timeoutopt)

Description:

• Shutdown a plugin

Source:

• Plugin.js, line 147

Overrides:

• Camera#shutdown

See:

• API Endpoint (/plugin/:pluginId)

Example

await plugin.shutdown()

Parameters:

(async) stopFeed(deviceOptopt) → {object}

Description:

• Stop the camera's live feed if it is running.

Source:

• StreamingCapturePlugin.js, line 125

Overrides:

• Camera#stopFeed

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())

Parameters:

Returns:

Type

object

(async) streamUrl(streamOptopt, deviceOptopt) → {string}

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 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.

Source:

• StreamingCapturePlugin.js, line 44

Overrides:

• Camera#streamUrl

Example

const img = document.createElement('img')
img.src = await camera.streamUrl()
document.body.appendChild(img)

Parameters:

Returns:

Type

string

(async) takePhoto(captureOptopt, deviceOptopt)

Description:

• Capture a photo

Source:

• Camera.js, line 44

Overrides:

• Camera#takePhoto

Example

// Capture a photo as an ObjectURL, add it to an img element and append to
// the document's body.
const img = document.createElement('img')
img.src = await camera.takePhoto()
document.body.appendChild(img)

Parameters: