This is a client library specifically designed for communication with the Sofie Quantel Gateway, an integral component of the open-source Sofie TV Automation System. It acts as an abstraction layer, allowing Node.js applications to interact with Quantel ISA (Integrated Production Archive) systems. The library facilitates discovery of clips, management of playout control on Quantel servers, and handles the underlying HTTP REST API communication with the Quantel Gateway, which itself bridges to the complex Quantel ISA System's CORBA API. Currently at version 4.0.0, the package primarily supports modern Node.js environments (>=18.0) and ships with TypeScript type definitions, providing a robust and type-safe interface for broadcast automation workflows. It focuses on simplifying interaction with professional broadcast hardware within the Sofie ecosystem, abstracting away low-level network and protocol complexities.
npm install tv-automation-quantel-gateway-clientVerified import paths — ran on the pinned version, not inferred.
This example demonstrates how to initialize the `QuantelGateway` client, connect to a specified gateway and ISA system, and then properly dispose of the client. It uses environment variables for configuration for easy setup.
Upgrade your Node.js environment to version 18.0 or newer. Use `nvm` or your package manager to manage Node.js versions effectively.
Ensure the Quantel Gateway application is running and its network address/port are correctly configured. Verify network connectivity between your application, the Gateway, and the ISA system. Refer to the Sofie Quantel Gateway documentation for setup.
Implement a discovery mechanism: `await quantelClient.connectToISA(isaUrl); const servers = await quantelClient.getServers(zoneId);` before calling `init` if `serverID` is dynamic or unknown.
Double-check `quantel.gateway.url:port` and `quantel.isa.url` values. Ensure they are reachable from the host running the client application and that no firewalls are blocking the necessary ports.
Change `const { Symbol } = require('pkg');` to `import { Symbol } from 'pkg';` or use a dynamic import `const { Symbol } = await import('pkg');` within an `async` function.Ensure you are using named imports: `import { QuantelGateway } from 'tv-automation-quantel-gateway-client';` instead of `import QuantelGateway from 'tv-automation-quantel-gateway-client';`.Verify that the Quantel Gateway application is running and listening on the specified host and port (`QUANTEL_GATEWAY_URL`). Check local and remote firewalls. Ensure the URL is correct.
Confirm the `QUANTEL_ISA_URL` is correct and that the Quantel ISA system is operational and reachable from the machine hosting the Quantel Gateway.
No dependency data recorded yet.