Function DisplaySettingsModal

DisplaySettingsModal - Visual display and optimization settings interface

DisplaySettingsModal is a React Native component that provides controls for configuring how the meeting content is displayed and rendered. It offers settings for display mode, participant animations, full-screen forcing, and video performance optimization.

Key Features:

  • Display mode selection (video, media, all)
  • Auto-wave animation toggle for participants
  • Force full-screen display option
  • Video rendering optimization toggle
  • Position-configurable modal (4 corners)
  • Real-time settings persistence
  • Custom settings handler support

UI Customization: This component can be replaced via uiOverrides.displaySettingsModal to provide a completely custom display settings interface.

Component

Example

// Basic usage with default settings
import React, { useState } from 'react';
import { DisplaySettingsModal } from 'mediasfu-reactnative-expo';

const [showSettings, setShowSettings] = useState(false);

const displayParams = {
  meetingDisplayType: 'video',
  autoWave: true,
  forceFullDisplay: false,
  meetingVideoOptimized: false,
  getUpdatedAllParams: () => ({ ...displayParams }),
};

return (
  <DisplaySettingsModal
    isDisplaySettingsModalVisible={showSettings}
    onDisplaySettingsClose={() => setShowSettings(false)}
    parameters={displayParams}
  />
);

Example

// With custom position and styling
const handleModifySettings = async (options: ModifyDisplaySettingsOptions) => {
  await modifyDisplaySettings(options);
  console.log('Display settings updated');
};

return (
  <DisplaySettingsModal
    isDisplaySettingsModalVisible={showDisplaySettings}
    onDisplaySettingsClose={() => setShowDisplaySettings(false)}
    onModifyDisplaySettings={handleModifySettings}
    parameters={displayParameters}
    position="bottomRight"
    backgroundColor="#2c3e50"
  />
);

Example

// With performance optimization enabled
const optimizedParams = {
  meetingDisplayType: 'video',
  autoWave: false, // Disable for better performance
  forceFullDisplay: true,
  meetingVideoOptimized: true, // Enable video optimization
  getUpdatedAllParams: () => ({ ...optimizedParams }),
};

return (
  <DisplaySettingsModal
    isDisplaySettingsModalVisible={isVisible}
    onDisplaySettingsClose={handleClose}
    parameters={optimizedParams}
  />
);

Example

// Using custom UI via uiOverrides
const config = {
  uiOverrides: {
    displaySettingsModal: {
      component: MyCustomDisplaySettings,
      injectedProps: {
        theme: 'dark',
        showAdvancedOptions: true,
      },
    },
  },
};

return <MyMeetingComponent config={config} />;

Properties

propTypes? contextTypes? defaultProps? displayName?

Properties

OptionalpropTypes

propTypes?: WeakValidationMap<DisplaySettingsModalOptions>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<DisplaySettingsModalOptions>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

Settings

Member Visibility

On This Page

Properties