ef-configuration
Root configuration provider. Sets the API host and URL signing endpoint for all descendant elements.
ef-configuration is a context provider that configures Editframe elements within its subtree. Wrap your composition at the root level to set the API host and URL signing endpoint.
| Attribute | Default | Description |
|---|---|---|
api-host | — | Base URL for the Editframe API (e.g. https://editframe.com) |
signing-url | /@ef-sign-url | Server-side route that signs asset URLs for playback |
image-proxy | "auto" | Controls how ef-image fetches external image URLs. See Image Proxy below. |
Image Proxy
By default, ef-image routes external http:// and https:// source URLs through the Editframe image proxy at /api/v1/assets/image?src=…. The proxy re-serves images from the Editframe origin so the canvas renderer can draw them without a CORS taint error, and it normalises content-type and caching headers.
Set image-proxy="none" when the compositor is embedded in an environment that has no Editframe backend (for example, a third-party CMS editor) and image sources already serve permissive CORS headers. In that mode ef-image fetches the source URL directly; the internal fetch → blob → canvas pipeline still avoids canvas taint as long as the image origin returns a valid CORS response.
<ef-configuration image-proxy="none">
<!-- ef-image elements fetch their src directly, no proxy needed -->
<ef-image src="https://your-cms.example.com/media/photo.jpg"></ef-image>
</ef-configuration>React:
import { Configuration, Image } from "@editframe/react";
<Configuration imageProxy="none">
<Image src="https://your-cms.example.com/media/photo.jpg" />
</Configuration>Failure modes
| Setting | Proxy unavailable | CORS headers absent on source |
|---|---|---|
"auto" (default) | Image request 404s; image missing from render | Proxy fetches successfully; image appears |
"none" | N/A — no proxy request is made | fetch throws; image missing from render, load error logged |
When image-proxy="none" and a source lacks CORS headers, the error surfaces explicitly as a failed fetch rather than a silent proxy 404, making misconfiguration easier to diagnose.