DOCSEARCHbyAlgolia
Submit Docs

Sofie Integration Libraries

website·Indexed 29 days ago

https://sofie-automation.github.io/sofie-core/

Technical documentation and TypeDoc API reference for Sofie Integration Libraries, including @sofie-automation/blueprints-integration and @sofie-automation/corelib. Covers interfaces and types for timeline management, MOS (Media Object Server) integration, and scene layer effects.

Tokens
613.7K
Snippets
3.1K
Records
5.1K
Agent score
67%

What's inside Sofie

  1. Overview of Sofie Gateway types and functions

    Sofie uses different Gateways to interface with various production systems:

    Control and Playout Gateways:

    • Playout Gateway: Sends commands to video servers, mixers, LED screens, lighting controllers, and graphics systems.
    • Input Gateway: Supports Human Interface Devices (HID) such as Stream Decks, Skaarhoj panels, and MIDI devices.
    • Live Status Gateway: Provides external services with the current state of a Studio (e.g., playing Parts/Pieces, AdLibs).
    • Package Manager: Handles media verification, proxy production for Rundown View, and quality control.

    Rundown & Newsroom Gateways:

    • Google Spreadsheet Gateway: Creates Rundowns using Google Spreadsheets.
    • iNEWS Gateway: Integrates with Avid iNEWS via FTP.
    • MOS Gateway: Integrates with MOS-compatible NRCS systems (e.g., AP ENPS, CGI OpenMedia, Octopus Newsroom, Saga).
    • Rundown Editor: A minimal, self-contained utility for creating Rundowns.

  3. Overview of Sofie Gateway JSON Schema configuration

    Sofie gateways use JSON Schemas to provide a manifest describing their configuration fields. This allows for the generation of TypeScript interfaces and the rendering of a flexible UI. It is recommended to use json-schema-to-typescript to generate interfaces from these schemas. Only a subset of the JSON Schema specification is supported.

  4. Overview of @sofie-automation/corelib integration libraries

    The @sofie-automation/corelib module is a yarn workspace containing various integration libraries and gateways that provide core functionality for the Sofie system. These libraries are referenced directly by the core system. Each individual package within this workspace contains its own README detailing its specific purpose and usage.

  6. Overview of Sofie TV Automation System

    Sofie is a web-based TV automation system designed for studios and live shows, specifically utilized for daily live TV news productions. Its core capabilities include state-based device control and the playout of video, audio, and graphics. The system is built on a modular architecture for device control (supporting various hardware and software setups) and data ingest (supporting MOS and Google spreadsheets), and it features a plug-in architecture for programming shows.

  7. Overview of Sofie TV Automation System

    Sofie is a web-based TV automation system designed for studios and live shows, specifically tailored for live TV news productions. It provides a modern web-based GUI and utilizes a state-based approach for device control and the playout of video, audio, and graphics.

  9. Overview of Sofie TV Automation System

    Sofie is a web-based TV automation system designed for studios and live shows. It is used for daily live TV news productions and provides the following core capabilities:

    • State-based device control and playout for video, audio, and graphics.
    • A modular device-control architecture compatible with various hardware and software setups.
    • A modular data-ingest architecture supporting MOS and Google spreadsheets.
    • A plug-in architecture for programming shows.
    • A modern, web-based graphical user interface (GUI).

  11. Overview of Sofie TV Automation System

    Sofie is a web-based TV automation system designed for studios and live shows, specifically utilized for daily live TV news productions. Its core capabilities include state-based device control and the playout of video, audio, and graphics. The system is built on a modular architecture for device control (supporting various hardware and software setups) and data ingest (supporting MOS and Google spreadsheets), and it features a plug-in architecture for programming shows.

  12. Overview of BaseAPI class

    The BaseAPI class is the base class for all generated API classes within the @sofie-automation/openapi library. It provides the core infrastructure for making requests and attaching middleware. All specific API clients (such as BlueprintsApi, BucketsApi, DevicesApi, IngestApi, PlaylistsApi, ShowstylesApi, SnapshotsApi, SofieApi, SourceLayersApi, and StudiosApi) inherit from BaseAPI.