Constructor
new CaptureBridge(baseURLopt)
- Description:
Instantiate a client for interacting with the Capture Bridge service.
- Source:
Example
const captureBridge = new CaptureBridge()Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
baseURL |
string |
<optional> |
Protocol, domain, and port for the service. |
Methods
(async) config() → {object}
- Description:
Get instance configuration details
- Source:
- See:
Example
const captureBridge = new CaptureBridge()
const configInfo = await captureBridge.config()
console.log(configInfo)Returns:
Instance configuration information.
- Type
- object
(async) plugin(id) → (nullable) {object}
- Description:
Get a single plugin by ID
- Source:
- See:
Example
const plugin = await captureBridge.plugin('capture_camera_canon')Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | Plugin ID |
Returns:
Plugin object or null
- Type
- object
(async) plugins() → {Array.<object>}
- Description:
Get all installed plugins
- Source:
- See:
Example
const plugins = await captureBridge.plugins()Returns:
Array of Plugin objects.
- Type
- Array.<object>
(async) status() → {object}
- Description:
Get service status information
- Source:
- See:
Example
const captureBridge = new CaptureBridge()
const statusInfo = await captureBridge.status()
console.log(statusInfo)Returns:
Service status information.
- Type
- object
(async) version() → {object}
- Description:
Get service version info
- Source:
- See:
Example
const captureBridge = new CaptureBridge()
const {version} = await captureBridge.version()
console.log(version)Returns:
Service version info.
- Type
- object