The ConnectorController manages lifetime of all available connectors, regardless of the type, in the document. Use it to add/remove connectors to a template, or set specific configuration.

The way CHILI Studio handles different sources of resources is called 'Connectors'. A Connectors is an implementation of a set of capabilities we need to interact with a certain external resource management system. In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to execute the media connector both on web using webassembly and on the server side during e.g. animation output generation. This controller is an interface to the running connector instance inside the studio engine. The engine will automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered manually.

Hierarchy

  • ConnectorController

Methods

  • Gets all available connectors of a 'ConnectorType'

    Returns

    list of all available connectors of a 'ConnectorType'

    Parameters

    • type: ConnectorType

      type of connector you want to get

    Returns Promise<EditorResponse<ConnectorInstance[]>>

  • Registers a new connector in the SDK. After successful registration, depending on the connector type, the connector can be configured and used in the template Remember to add custom authentication information after registering the connector

    Returns

    the Id of the newly created connector, this Id should be used going forward.

    Parameters

    • registration: ConnectorUrlRegistration | ConnectorGrafxRegistration | ConnectorLocalRegistration

      registration object containing all details about the connector

    Returns Promise<EditorResponse<string>>

Generated using TypeDoc