Class PrepopulateUserMedia

Prepopulates the user media based on the provided options.

This method prepares the UI components for the user's media based on the event type and participant information. It manages the display of video and audio cards, mini cards, and handles screen sharing scenarios.

Param: options

The options for prepopulating user media.

Param: options.name

The name of the user.

Param: options.parameters

The parameters for prepopulating user media.

Param: options.parameters.getUpdatedAllParams

Function to get updated parameters.

Param: options.parameters.participants

List of participants.

Param: options.parameters.allVideoStreams

List of all video streams.

Param: options.parameters.islevel

The level of the user.

Param: options.parameters.member

The member name.

Param: options.parameters.shared

Indicates if the screen is shared.

Param: options.parameters.shareScreenStarted

Indicates if screen sharing has started.

Param: options.parameters.eventType

The type of event (e.g., "broadcast", "chat", "conference").

Param: options.parameters.screenId

The ID of the screen.

Param: options.parameters.forceFullDisplay

Indicates if full display is forced.

Param: options.parameters.updateMainWindow

Function to update the main window.

Param: options.parameters.mainScreenFilled

Indicates if the main screen is filled.

Param: options.parameters.adminOnMainScreen

Indicates if admin is on the main screen.

Param: options.parameters.mainScreenPerson

The person on the main screen.

Param: options.parameters.videoAlreadyOn

Indicates if the video is already on.

Param: options.parameters.audioAlreadyOn

Indicates if the audio is already on.

Param: options.parameters.oldAllStreams

List of old all streams.

Param: options.parameters.checkOrientation

Function to check orientation.

Param: options.parameters.screenForceFullDisplay

Indicates if screen force full display is enabled.

Param: options.parameters.localStreamScreen

The local screen stream.

Param: options.parameters.remoteScreenStream

List of remote screen streams.

Param: options.parameters.localStreamVideo

The local video stream.

Param: options.parameters.mainHeightWidth

The main height and width.

Param: options.parameters.isWideScreen

Indicates if the screen is wide.

Param: options.parameters.localUIMode

Indicates if local UI mode is enabled.

Param: options.parameters.whiteboardStarted

Indicates if whiteboard has started.

Param: options.parameters.whiteboardEnded

Indicates if whiteboard has ended.

Param: options.parameters.virtualStream

The virtual stream.

Param: options.parameters.keepBackground

Indicates if background should be kept.

Param: options.parameters.annotateScreenStream

The annotate screen stream.

Param: options.parameters.updateMainScreenPerson

Function to update the main screen person.

Param: options.parameters.updateMainScreenFilled

Function to update if the main screen is filled.

Param: options.parameters.updateAdminOnMainScreen

Function to update if admin is on the main screen.

Param: options.parameters.updateMainHeightWidth

Function to update the main height and width.

Param: options.parameters.updateScreenForceFullDisplay

Function to update screen force full display.

Param: options.parameters.updateUpdateMainWindow

Function to update the main window update status.

Param: options.parameters.updateMainGridStream

Function to update the main grid stream.

Returns

A promise that resolves with the components and inputs or void.

Throws

Throws an error if there is an issue preparing and populating the main screen.

Example

const options = {
  name: 'John Doe',
  parameters: {
    getUpdatedAllParams: () => { },
    participants: [],
    allVideoStreams: [],
    islevel: '1',
    member: 'John',
    shared: false,
    shareScreenStarted: false,
    eventType: 'conference',
    screenId: 'screen123',
    forceFullDisplay: false,
    updateMainWindow: false,
    mainScreenFilled: false,
    adminOnMainScreen: false,
    mainScreenPerson: '',
    videoAlreadyOn: false,
    audioAlreadyOn: false,
    oldAllStreams: [],
    checkOrientation: () => 'landscape',
    screenForceFullDisplay: false,
    localStreamScreen: null,
    remoteScreenStream: [],
    localStreamVideo: null,
    mainHeightWidth: 100,
    isWideScreen: true,
    localUIMode: false,
    whiteboardStarted: false,
    whiteboardEnded: false,
    virtualStream: null,
    keepBackground: false,
    annotateScreenStream: false,
    updateMainScreenPerson: (person) => { console.log(updated) },
    updateMainScreenFilled: (filled) => { console.log(updated) },
    updateAdminOnMainScreen: (admin) => { console.log(updated) },
    updateMainHeightWidth: (heightWidth) => { console.log(updated) },
    updateScreenForceFullDisplay: (force) => { console.log(updated) },
    updateUpdateMainWindow: (update) => { console.log(updated) },
    updateMainGridStream: (components) => { console.log(updated) },
  },
};

await prepopulateUserMedia(options);

Constructors

constructor

Methods

prepopulateUserMedia

Constructors

constructor

Methods

prepopulateUserMedia

  • prepopulateUserMedia(options): Promise<void | {
        component: any;
        inputs: any;
    }[]>

  • Prepopulates the user media based on the provided options.

    Parameters

    Returns Promise<void | {
        component: any;
        inputs: any;
    }[]>

    A promise that resolves with the components and inputs or void.

Settings

Member Visibility

On This Page

Constructors
Methods