Skip to main content

CasparCG Integration

CasparCG Server is versatile software compatible with both Windows and Linux, designed for professional graphics, audio, and video playout across multiple outputs. This powerful open-source solution has been in 24/7 broadcast production since 2006.

Exporting​

When exporting templates for CasparCG, Loopic generates a single .html graphic template file. To incorporate it into CasparCG, you can either designate CasparCG's templates directory during the export process or manually transfer the HTML file to that directory. To activate templates, you can execute AMCP commands directly from the console or employ CasparCG client applications with user interfaces, such as the CasparCG Client.

Graphics Data Definition​

CasparCG functions as a server application and lacks inherent knowledge of template definitions beyond the methods available for controlling template playback.

The Graphics Data Definition (referred to as "GDD") comprises a specialized collection of JSON-schema definitions tailored exclusively for dynamic TV graphic templates, and it is integrated into certain CasparCG client applications. All templates exported from Loopic include embedded GDD schemas.

You define the GDD schema in the Template Definition Builder. Select CasparCG in the Export panel and click the settings button (gear icon) next to the dropdown:

  • Manifest – the graphic's Title and Description.
  • Fields – one field per value the client can send. Each field has an ID, Label, Description and Type (string or number). String fields also have a GDD Type, such as single-line, multi-line, file path, image path or color, which tells the client which input to show. Expand a field to set properties for its type.
  • Actions – which elements a field updates when the graphic receives data, for example the content of a Text element.

Limitations​

Different versions of CasparCG are bundled with varying versions of the Chromium Embedded Framework (CEF). This distinction is significant as the CEF version dictates the rendering capabilities of HTML5 graphic templates within CasparCG.

Masks​

The table below outlines the types of masks supported by each version of CasparCG.

CasparCG VersionRectangleEllipsePath
CasparCG 2.3.3✅
CasparCG 2.4.0 and newer✅✅✅

CEF versions​

If you're incorporating custom CSS into your templates, ensure that the features you're using are supported by the version of CasparCG you're utilizing. caniuse.com can be a valuable resource in verifying compatibility.

CasparCG VersionCEF version
CasparCG 2.2.063
CasparCG 2.3.071
CasparCG 2.3.171
CasparCG 2.3.271
CasparCG 2.3.371
CasparCG 2.4.0 Stable117
CasparCG 2.4.1 Stable117
CasparCG 2.4.2 Stable117
CasparCG 2.4.3 Stable117

Useful CasparCG links: