Function confirmRecording

confirmRecording(options: ConfirmRecordingOptions): Promise<void>

Confirms the recording settings based on the provided parameters and updates the recording state.

Parameters

options: ConfirmRecordingOptions
The options for confirming the recording.
- parameters: ConfirmRecordingParameters

Returns Promise<void>

A promise that resolves when the recording settings have been confirmed.

Remarks

This function performs several checks to ensure that the recording settings are valid based on the provided parameters. If any of the checks fail, an alert is shown and the function returns early without updating the recording state.

The function checks for the following conditions:

Whether recording videos of all participants is allowed.
Whether recording all participants is allowed.
Whether recording other video participants is allowed.
Whether recording all orientations is allowed.
Whether recording the preferred orientation is allowed.
Whether recording all formats is allowed.
Whether the recording display type is valid based on the meeting display type.
Whether recording all participants with media is allowed.

If all checks pass, the function constructs the mainSpecs, dispSpecs, and textSpecs objects based on the state variables, updates the user recording parameters, and confirms the recording.

Example

confirmRecording({
  parameters: {
    showAlert: (alert) => console.log(alert.message),
    recordingMediaOptions: "video",
    recordingAudioOptions: "high",
    recordingVideoOptions: "all",
    recordingVideoType: "HD",
    recordingDisplayType: "video",
    recordingNameTags: true,
    recordingBackgroundColor: "#000000",
    recordingNameTagsColor: "#ffffff",
    recordingOrientationVideo: "landscape",
    recordingAddHLS: true,
    recordingAddText: true,
    recordingCustomText: "Meeting",
    recordingCustomTextPosition: "top-right",
    recordingCustomTextColor: "#ffffff",
    meetingDisplayType: "video",
    recordingVideoParticipantsFullRoomSupport: true,
    recordingAllParticipantsSupport: true,
    recordingVideoParticipantsSupport: true,
    recordingSupportForOtherOrientation: true,
    recordingPreferredOrientation: "landscape",
    recordingMultiFormatsSupport: true,
    recordingVideoOptimized: true,
    recordingAllParticipantsFullRoomSupport: true,
    meetingVideoOptimized: false,
    eventType: "broadcast",
    breakOutRoomStarted: false,
    breakOutRoomEnded: true,
    updateRecordingDisplayType: (displayType) => console.log(`Updated display type: ${displayType}`),
    updateRecordingVideoOptimized: (optimized) => console.log(`Updated video optimized: ${optimized}`),
    updateUserRecordingParams: (params) => console.log(`Updated recording params:`, params),
    updateConfirmedToRecord: (confirmed) => console.log(`Confirmed to record: ${confirmed}`),
  }
});