@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Interface MediaEmbedConfig

    Configuration produced by a MediaEmbedProvider when it recognises a URL as embeddable.

    The component renders this as a sandboxed <iframe> instead of a native <video> / <audio> element.

    const config: MediaEmbedConfig = {
      iframeSrc: 'https://www.youtube.com/embed/dQw4w9WgXcQ',
      providerName: 'YouTube',
      allow: 'autoplay; encrypted-media; picture-in-picture',
      aspectRatio: '16 / 9',
    };
    interface MediaEmbedConfig {
        aspectRatio?: string;
        iframeSrc: string;
        providerName: string;
    }
    Index

    Properties

    aspectRatio? iframeSrc providerName

    Properties

    aspectRatio?: string

    CSS aspect-ratio value for the embed viewport.

    '16 / 9'
    iframeSrc: string

    The full src URL for the embed <iframe>.

    Must be an HTTPS URL pointing to the provider's embed endpoint.

    providerName: string

    Human-readable name of the provider (e.g. 'YouTube').

    Settings

    Member Visibility

    On This Page

    Properties