Class ResumePauseAudioStreams

Resumes or pauses audio streams based on the provided options.

This method checks the current state of participants in breakout rooms and updates the audio streams accordingly. It can add or remove audio streams based on the participant's current status (in a breakout room or not) and the event type (e.g., conference, webinar).

Param: options

The options for resuming or pausing audio streams.

Param: options.breakRoom

The ID of the break room. Defaults to -1 if not specified.

Param: options.inBreakRoom

Indicates if the participant is in a break room. Defaults to false.

Param: options.parameters

The parameters required for processing audio streams.

Param: options.parameters.breakoutRooms

Array of breakout rooms.

Param: options.parameters.ref_participants

Array of reference participants.

Param: options.parameters.allAudioStreams

Array of all audio streams.

Param: options.parameters.participants

Array of participants.

Param: options.parameters.islevel

The level of the participant.

Param: options.parameters.eventType

The type of event (e.g., conference, webinar).

Param: options.parameters.consumerTransports

Array of consumer transports.

Param: options.parameters.limitedBreakRoom

Array of participants in the limited break room.

Param: options.parameters.hostNewRoom

The ID of the host's new room.

Param: options.parameters.member

The name of the member.

Param: options.parameters.updateLimitedBreakRoom

Function to update the limited break room.

Param: options.parameters.processConsumerTransportsAudio

Function to process audio transports.

Returns

A promise that resolves when the audio streams have been processed.

Throws

Will log an error message if there is an issue processing the audio streams.

Example

await resumePauseAudioStreams({
  breakRoom: 1,
  inBreakRoom: true,
  parameters: {
    breakoutRooms: [],
    ref_participants: [],
    allAudioStreams: [],
    participants: [],
    islevel: '1',
    eventType: 'conference',
    consumerTransports: [],
    limitedBreakRoom: [],
    hostNewRoom: 2,
    member: 'JohnDoe',
    updateLimitedBreakRoom: myUpdateFunction,
    processConsumerTransportsAudio: myProcessFunction,
  },
});

Constructors

constructor

Methods

resumePauseAudioStreams

Constructors

constructor

Methods

resumePauseAudioStreams

  • resumePauseAudioStreams(options): Promise<void>

  • Resumes or pauses audio streams based on the provided options.

    Parameters

    Returns Promise<void>

    A promise that resolves when the audio streams have been processed.

    Throws

    Will log an error message if there is an issue processing the audio streams.

Settings

Member Visibility

On This Page

Constructors
Methods