Configures a registered connector. A configurator helper is passed as an argument of the callback for you to setup your connector.
the id of your registered connector
callback to setup the connector
Gets all available connectors of a 'ConnectorType'
list of all available connectors of a 'ConnectorType'
type of connector you want to get
Gets a connector by its id
connector
the id of the connector
Gets the mapped data from connector.
mappings
the id of your registered connector
the mapping direction
Optional direction: undefinedGets the options from the connector.
options
the id of your registered connector
Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitToBeReady' method in this controller.
connector state
the id of your registered connector you want to make sure it is loaded
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
the Id of the newly created connector, this Id should be used going forward.
registration object containing all details about the connector
Unregisters a connector from the document.
the id of the connector to unregister
Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially useful during startup of the SDK / right after the loadDocument call.
the id of your registered connector you want to make sure it is loaded
Generated using TypeDoc
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.