@videosdk.live/server-sdk
    Preparing search index...

    Interface Composition

    Shared composition options for egress (recording, RTMP, and HLS) — layout, priority, grid size, orientation, theme, and quality.

    interface Composition {
        gridSize?: number;
        layout?: CompositionLayout;
        orientation?: Orientation;
        priority?: LayoutPriority;
        quality?: CompositionQuality;
        theme?: Theme;
    }
    Index
    gridSize? layout? orientation? priority? quality? theme?
    gridSize?: number

    Number of tiles in grid layout (0–25, default 25).

    layout?: CompositionLayout

    "grid" | "spotlight" | "sidebar", or { custom: templateUrl }. If omitted while quality, theme, or orientation are set, defaults to "grid" (a layout is required whenever any other composition option is present).

    orientation?: Orientation
    priority?: LayoutPriority

    Speaker priority. Required by HLS/RTMP when a layout is present (the SDK defaults it to "SPEAKER" for those).

    quality?: CompositionQuality

    Quality tier.

    theme?: Theme

    Settings
    Member Visibility

    On This Page
    Properties