Returns a single media using a specific MediaConnector.
The connector needs to list detail as a supported capability.
unique id of the Media connector
unique id of the Media
context that will be available in the connector script.
Media item
The combination of a connectorId and mediaId is typically enough for a media connector to
perform the download of this asset. The download endpoint is capable of relaying this information to the
media connector instance running in the editor engine.
unique id of the media connector
unique id of the media to download
hint to the media connector about desired quality of the downloaded media
context that will be available in the connector script.
This method returns what capabilities the selected connector has. It gives an indication what methods can be used successfully for a certain connector.
unique id of the media connector
MediaConnectorCapabilities
All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This
method allows you to discover which mappings are available for a given connector. If you want to use any of these
mappings, they will be available in the context parameter of any connector method.
unique id of the media connector
connector mappings
This method will parse the deprecatedMediaDownloadType to the new media download type. This method will be removed once the deprecatedMediaDownloadType is out of use
legacy download type
MediaDownloadType
This method will parse the deprecatedMediaType to the new media type. This method will be removed once the deprecatedMediaType is out of use
is 0 or 1
connector capabilities
Query a specific MediaConnector for data using both standardized queryOptions and the dynamic context as parameters. This call returns an array of Media items.
unique id of the media connector
stringified instance of QueryOptions
context that will be available in the connector script.
array of Media items
Invokes the upload on the connector, using the given staged pointer(s).
If you want help with staging files, use the stageFiles method from the UtilsController.
The MediaConnector instance to use (just like download API).
Array of FilePointer as staged by stageFile(s).
Arbitrary metadata/context for the upload (auth, meta fields, etc).
Promise<Media[]>
The MediaConnectorController is responsible for all communication regarding media connectors. Methods inside this controller can be called by
window.SDK.mediaConnector.{method-name}The way GraFx Studio handles different sources of media is called 'MediaConnector'. A MediaConnector is an implementation of a set of capabilities we need to interact with a certain Digital Asset 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.