@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface FormatRenderEntry

    v3 render specification — one entry in Format.renders[].

    Renamed from FormatRender (see deprecated alias below) to free the FormatRender name for the factory namespace in format-render-builders, which is the more common autocomplete target. TypeScript keeps type and value namespaces separate, but the re-export barrel in src/lib/index.ts can't disambiguate between a type re-export and a const re-export at the same name — hence the rename.

    interface FormatRenderEntry {
        render_id: string;
        role: string;
        dimensions?: RenderDimensions;
        parameters_from_format_id?: boolean;
    }
    Index

    Properties

    render_id: string

    Unique identifier for this render

    role: string

    Semantic role (e.g., 'primary', 'companion', 'mobile_variant')

    dimensions?: RenderDimensions

    Dimensions of this render

    parameters_from_format_id?: boolean

    Whether dimensions come from format_id parameters