MediaSFU React Native
    Preparing search index...

    Interface MainScreenComponentOptions

    Options for rendering MainScreenComponent.

    MainScreenComponentOptions

    Content:

    interface MainScreenComponentOptions {
        children: ReactNode;
        mainSize: number;
        doStack: boolean;
        containerWidthFraction?: number;
        containerHeightFraction?: number;
        updateComponentSizes: (sizes: ComponentSizes) => void;
        defaultFraction?: number;
        showControls: boolean;
        componentSizes: ComponentSizes;
        style?: StyleProp<ViewStyle>;
        renderContent?: (
            options: {
                defaultContent: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
        renderContainer?: (
            options: {
                defaultContainer: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
    }
    Index

    Properties

    children mainSize doStack containerWidthFraction? containerHeightFraction? updateComponentSizes defaultFraction? showControls componentSizes style? renderContent? renderContainer?

    Properties

    children: ReactNode

    Child layout rendered within the screen container.

    Layout:

    mainSize: number

    Percentage (0-100) assigned to the main component when stacking.

    doStack: boolean

    Whether to split the screen between main/other regions.

    containerWidthFraction?: number

    Fraction of window width consumed by the container.

    containerHeightFraction?: number

    Fraction of window height consumed by the container.

    updateComponentSizes: (sizes: ComponentSizes) => void

    Callback invoked when dimensions are recalculated.

    Sizing:

    defaultFraction?: number

    Height multiplier when controls are visible.

    showControls: boolean

    Whether control surfaces are visible, affecting height.

    Appearance:

    componentSizes: ComponentSizes

    Cached dimensions for main and secondary regions.

    style?: StyleProp<ViewStyle>

    Additional styles for the screen container.

    Advanced Render Overrides:

    renderContent?: (
        options: {
            defaultContent: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Customize the rendered children with computed dimensions.

    renderContainer?: (
        options: {
            defaultContainer: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Replace the entire container wrapper.

    Settings

    Member Visibility

    On This Page

    Properties