Class ModifyDisplaySettings

Modifies the display settings based on the provided parameters.

This method updates the display settings for the meeting based on the participant's level, recording status, and other conditions. It validates display types and shows alerts when necessary. It also handles the display settings for breakout rooms.

Param: options

The options containing the parameters to modify the display settings.

Param: options.parameters

The parameters for modifying the display settings.

Param: options.parameters.showAlert

Function to show alert messages.

Param: options.parameters.meetingDisplayType

The current meeting display type.

Param: options.parameters.autoWave

Flag indicating if auto wave is enabled.

Param: options.parameters.forceFullDisplay

Flag indicating if full display is forced.

Param: options.parameters.meetingVideoOptimized

Flag indicating if the meeting video is optimized.

Param: options.parameters.islevel

The current level of the meeting.

Param: options.parameters.recordStarted

Flag indicating if recording has started.

Param: options.parameters.recordResumed

Flag indicating if recording has resumed.

Param: options.parameters.recordStopped

Flag indicating if recording has stopped.

Param: options.parameters.recordPaused

Flag indicating if recording is paused.

Param: options.parameters.recordingDisplayType

The current recording display type.

Param: options.parameters.recordingVideoOptimized

Flag indicating if the recording video is optimized.

Param: options.parameters.prevForceFullDisplay

The previous force full display value.

Param: options.parameters.prevMeetingDisplayType

The previous meeting display type.

Param: options.parameters.updateMeetingDisplayType

Function to update the meeting display type.

Param: options.parameters.updateAutoWave

Function to update the auto wave setting.

Param: options.parameters.updateForceFullDisplay

Function to update the force full display setting.

Param: options.parameters.updateMeetingVideoOptimized

Function to update the meeting video optimization setting.

Param: options.parameters.updatePrevForceFullDisplay

Function to update the previous force full display setting.

Param: options.parameters.updatePrevMeetingDisplayType

Function to update the previous meeting display type.

Param: options.parameters.updateIsDisplaySettingsModalVisible

Function to update the visibility of the display settings modal.

Param: options.parameters.updateFirstAll

Function to update the first all setting.

Param: options.parameters.updateUpdateMainWindow

Function to update the main window.

Param: options.parameters.breakOutRoomStarted

Flag indicating if a breakout room has started.

Param: options.parameters.breakOutRoomEnded

Flag indicating if a breakout room has ended.

Param: options.parameters.onScreenChanges

Function to handle screen changes.

Returns

A promise that resolves when the display settings have been modified.

Example

const options: ModifyDisplaySettingsOptions = {
  parameters: {
    showAlert: (alert) => console.log(alert.message),
    meetingDisplayType: 'video',
    autoWave: true,
    forceFullDisplay: false,
    meetingVideoOptimized: true,
    islevel: '1',
    recordStarted: false,
    recordResumed: false,
    recordStopped: false,
    recordPaused: false,
    recordingDisplayType: 'media',
    recordingVideoOptimized: false,
    prevForceFullDisplay: false,
    prevMeetingDisplayType: 'media',
    updateMeetingDisplayType: (type) => console.log('Updated display type:', type),
    updateAutoWave: (wave) => console.log('Updated auto wave:', wave),
    updateForceFullDisplay: (fullDisplay) => console.log('Updated force full display:', fullDisplay),
    updateMeetingVideoOptimized: (optimized) => console.log('Updated video optimization:', optimized),
    updatePrevForceFullDisplay: (fullDisplay) => console.log('Updated previous full display:', fullDisplay),
    updatePrevMeetingDisplayType: (type) => console.log('Updated previous display type:', type),
    updateIsDisplaySettingsModalVisible: (isVisible) => console.log('Display settings modal is now:', isVisible),
    updateFirstAll: (firstAll) => console.log('Updated first all:', firstAll),
    updateUpdateMainWindow: (update) => console.log('Updated main window:', update),
    breakOutRoomStarted: false,
    breakOutRoomEnded: false,
    onScreenChanges: async ({ changed, parameters }) => console.log('Screen changes:', changed),
  },
};

const modifyDisplaySettingsService = new ModifyDisplaySettings();
await modifyDisplaySettingsService.modifyDisplaySettings(options);

Constructors

constructor

Methods

modifyDisplaySettings

Constructors

constructor

Methods

modifyDisplaySettings

Settings

Member Visibility

On This Page

Constructors
Methods