Events

Every callback the video editor calls, and the DOM event that goes with it. The custom element sends each DOM event from the element itself. Each DOM event bubbles and crosses a shadow DOM boundary. Its detail holds the callback's argument, or an array of the arguments when there are several.

For how to use them, see Events.

CallbacksCopy Anchor Link

A callback that returns a value to the editor has no DOM event, because an event listener cannot return a value. Pass it as a prop.

The custom element sends one export event for each export. Its event.detail is the exported File. The extras object is not in the event: read it from the second argument of onExport.

Export extrasCopy Anchor Link

The second argument of onExport. Every field is optional, and the whole object can be missing.

Export progressCopy Anchor Link

The argument of onExportProgress, and the detail of exportprogress.

ThumbnailsCopy Anchor Link

The argument of onThumbnails. It arrives after onExport, even when no thumbnail could be made.

Template saveCopy Anchor Link

The detail of templatesave. It is sent once for each save, when the save ends.

License stateCopy Anchor Link

The argument of onLicenseState. Every field is safe to log. It does not contain the license key.

Chat eventsCopy Anchor Link

The argument of onChatEvent, and the detail of chatevent. Every event has type and sessionId. Every event except ready has turnId, which is the same for everything that happens after one message from the user.

Preference changeCopy Anchor Link

onPreferenceChange receives three arguments: the name of the preference, its new value, and all preferences. The detail of preferencechange is an array of those three.

AI generationCopy Anchor Link

Pass generation observers inside ai, rather than as editor event props.

import type { EditorAIConfig } from '@layermetry/media-editor';

export const ai: EditorAIConfig = {
  endpointUrl: '/api/ai', image: true,
  onGenerationError: (error, context) => {
    console.warn(error.code, error.providerError?.requestId, context.attemptId);
  },
  onGenerationEvent: (event) => {
    if (event.type === 'progress') console.info(event.percent, event.stage);
  },
};

Hooks observe only. Returning a value does not recover a generation. Throwing does not change its outcome.

Error contextCopy Anchor Link

The error context identifies the attempt without copying request content.

The context contains no prompt, source, body, header values or license key. The accompanying error can contain providerError; see Provider errors.

Lifecycle eventsCopy Anchor Link

Every event contains type, attemptId and operation.

One attempt emits one start and one terminal success, failure or cancel. A success event confirms generation, not a later user choice to place a candidate.

Generated file receiptCopy Anchor Link

The context of onUploadAsset includes producedBy for generated media.

An omitted identity field stays absent. These fields record identity; they do not prove that a provider applied each requested setting.

CustomActionEventCopy Anchor Link