Interface RecordingModalParameters

Interface defining the parameters for the RecordingModal component. Extends ConfirmRecordingParameters and StartRecordingParameters for full recording functionality.

RecordingModalParameters

Recording State:

interface RecordingModalParameters {
    recordPaused: boolean;
    recordingVideoType: string;
    recordingDisplayType: "video" | "media" | "all";
    recordingBackgroundColor: string;
    recordingNameTagsColor: string;
    recordingOrientationVideo: string;
    recordingNameTags: boolean;
    recordingAddText: boolean;
    recordingCustomText: string;
    recordingCustomTextPosition: string;
    recordingCustomTextColor: string;
    recordingMediaOptions: string;
    recordingAudioOptions: string;
    recordingVideoOptions: string;
    recordingAddHLS: boolean;
    eventType: EventType;
    updateRecordingVideoType: ((value: string) => void);
    updateRecordingDisplayType: ((value: "video" | "media" | "all") => void);
    updateRecordingBackgroundColor: ((value: string) => void);
    updateRecordingNameTagsColor: ((value: string) => void);
    updateRecordingOrientationVideo: ((value: string) => void);
    updateRecordingNameTags: ((value: boolean) => void);
    updateRecordingAddText: ((value: boolean) => void);
    updateRecordingCustomText: ((value: string) => void);
    updateRecordingCustomTextPosition: ((value: string) => void);
    updateRecordingCustomTextColor: ((value: string) => void);
    updateRecordingMediaOptions: ((value: string) => void);
    updateRecordingAudioOptions: ((value: string) => void);
    updateRecordingVideoOptions: ((value: string) => void);
    updateRecordingAddHLS: ((value: boolean) => void);
    getUpdatedAllParams: (() => RecordingModalParameters);
    prevActiveNames: string[];
    updateActiveNames: ((activeNames: string[]) => void);
    updatePrevActiveNames: ((prevActiveNames: string[]) => void);
    activeNames: string[];
    trigger: TriggerType;
    audioParams: ProducerOptions;
    videoParams: ProducerOptions;
    localStreamScreen: MediaStream;
    shared: boolean;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    audioProducer: Producer<AppData>;
    localAudioProducer?: Producer<AppData>;
    updateAudioProducer: ((producer: Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void);
    updateAudioLevel: ((level: number) => void);
    screenParams: ProducerOptions;
    params: ProducerOptions;
    videoProducer: Producer<AppData>;
    localVideoProducer?: Producer<AppData>;
    updateMainWindow: boolean;
    updateVideoProducer: ((producer: Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void);
    updateUpdateMainWindow: ((state: boolean) => void);
    islevel: string;
    member: string;
    device: Device;
    producerTransport: Transport<AppData>;
    localProducerTransport?: Transport<AppData>;
    updateProducerTransport: ((producerTransport: Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void);
    updateTransportCreated: ((transportCreated: boolean) => void);
    updateLocalTransportCreated?: ((localTransportCreated: boolean) => void);
    connectSendTransport: ConnectSendTransportType;
    mainScreenPerson: string;
    adminOnMainScreen: boolean;
    mainScreenFilled: boolean;
    screenStates: ScreenState[];
    prevScreenStates: ScreenState[];
    updateScreenStates: ((states: ScreenState[]) => void);
    updatePrevScreenStates: ((states: ScreenState[]) => void);
    compareActiveNames: CompareActiveNamesType;
    compareScreenStates: CompareScreenStatesType;
    participants: Participant[];
    updateDateState?: number;
    lastUpdate: number;
    nForReadjust: number;
    shareScreenStarted: boolean;
    updateUpdateDateState: ((timestamp: number) => void);
    updateLastUpdate: ((lastUpdate: number) => void);
    updateNForReadjust: ((nForReadjust: number) => void);
    autoAdjust: AutoAdjustType;
    showAlert?: ShowAlert;
    meetingDisplayType: string;
    recordingVideoParticipantsFullRoomSupport: boolean;
    recordingAllParticipantsSupport: boolean;
    recordingVideoParticipantsSupport: boolean;
    recordingSupportForOtherOrientation: boolean;
    recordingPreferredOrientation: string;
    recordingMultiFormatsSupport: boolean;
    recordingVideoOptimized: boolean;
    recordingAllParticipantsFullRoomSupport: boolean;
    meetingVideoOptimized: boolean;
    breakOutRoomStarted: boolean;
    breakOutRoomEnded: boolean;
    updateRecordingVideoOptimized: ((value: boolean) => void);
    updateUserRecordingParams: ((params: UserRecordingParams) => void);
    updateConfirmedToRecord: ((value: boolean) => void);
    recordElapsedTime: number;
    recordStartTime: number;
    recordTimerInterval?: Timeout;
    isTimerRunning: boolean;
    canPauseResume: boolean;
    recordChangeSeconds: number;
    updateRecordStartTime: ((time: number) => void);
    updateRecordTimerInterval: ((interval: Timeout) => void);
    updateIsTimerRunning: ((isRunning: boolean) => void);
    updateCanPauseResume: ((canPause: boolean) => void);
    roomName: string;
    userRecordingParams: UserRecordingParams;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    updateIsRecordingModalVisible: ((visible: boolean) => void);
    confirmedToRecord: boolean;
    videoAlreadyOn: boolean;
    audioAlreadyOn: boolean;
    recordStarted: boolean;
    recordResumed: boolean;
    recordStopped: boolean;
    startReport: boolean;
    endReport: boolean;
    canRecord: boolean;
    updateClearedToRecord: ((cleared: boolean) => void);
    updateRecordStarted: ((started: boolean) => void);
    updateRecordPaused: ((paused: boolean) => void);
    updateRecordResumed: ((resumed: boolean) => void);
    updateStartReport: ((started: boolean) => void);
    updateEndReport: ((ended: boolean) => void);
    updateCanRecord: ((canRecord: boolean) => void);
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    rePort: RePortType;
    captureCanvasStream: CaptureCanvasStreamType;
    canvasWhiteboard: HTMLCanvasElement;
    canvasStream: MediaStream;
    updateCanvasStream: ((stream: MediaStream) => void);
    screenProducer: Producer<AppData>;
    localScreenProducer?: Producer<AppData>;
    transportCreated: boolean;
    localTransportCreated?: boolean;
    updateScreenProducer: ((producer: Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void);
    sleep: SleepType;
    createSendTransport: CreateSendTransportType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    disconnectSendTransportScreen: DisconnectSendTransportScreenType;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

recordPaused recordingVideoType recordingDisplayType recordingBackgroundColor recordingNameTagsColor recordingOrientationVideo recordingNameTags recordingAddText recordingCustomText recordingCustomTextPosition recordingCustomTextColor recordingMediaOptions recordingAudioOptions recordingVideoOptions recordingAddHLS eventType updateRecordingVideoType updateRecordingDisplayType updateRecordingBackgroundColor updateRecordingNameTagsColor updateRecordingOrientationVideo updateRecordingNameTags updateRecordingAddText updateRecordingCustomText updateRecordingCustomTextPosition updateRecordingCustomTextColor updateRecordingMediaOptions updateRecordingAudioOptions updateRecordingVideoOptions updateRecordingAddHLS getUpdatedAllParams prevActiveNames updateActiveNames updatePrevActiveNames activeNames trigger audioParams videoParams localStreamScreen shared connectSendTransportAudio connectSendTransportVideo audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenParams params videoProducer localVideoProducer? updateMainWindow updateVideoProducer updateLocalVideoProducer? updateUpdateMainWindow islevel member device producerTransport localProducerTransport? updateProducerTransport updateLocalProducerTransport? updateTransportCreated updateLocalTransportCreated? connectSendTransport mainScreenPerson adminOnMainScreen mainScreenFilled screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates participants updateDateState? lastUpdate nForReadjust shareScreenStarted updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust showAlert? meetingDisplayType recordingVideoParticipantsFullRoomSupport recordingAllParticipantsSupport recordingVideoParticipantsSupport recordingSupportForOtherOrientation recordingPreferredOrientation recordingMultiFormatsSupport recordingVideoOptimized recordingAllParticipantsFullRoomSupport meetingVideoOptimized breakOutRoomStarted breakOutRoomEnded updateRecordingVideoOptimized updateUserRecordingParams updateConfirmedToRecord recordElapsedTime recordStartTime recordTimerInterval? isTimerRunning canPauseResume recordChangeSeconds updateRecordStartTime updateRecordTimerInterval updateIsTimerRunning updateCanPauseResume roomName userRecordingParams socket localSocket? updateIsRecordingModalVisible confirmedToRecord videoAlreadyOn audioAlreadyOn recordStarted recordResumed recordStopped startReport endReport canRecord updateClearedToRecord updateRecordStarted updateRecordPaused updateRecordResumed updateStartReport updateEndReport updateCanRecord whiteboardStarted whiteboardEnded rePort captureCanvasStream canvasWhiteboard canvasStream updateCanvasStream screenProducer localScreenProducer? transportCreated localTransportCreated? updateScreenProducer updateLocalScreenProducer? sleep createSendTransport connectSendTransportScreen disconnectSendTransportScreen

Properties

recordPaused

recordPaused: boolean

Whether recording is currently paused

recordingVideoType

recordingVideoType: string

Video capture type ('fullDisplay', 'mainScreen', etc.)

recordingDisplayType

recordingDisplayType: "video" | "media" | "all"

What to display in recording

recordingBackgroundColor

recordingBackgroundColor: string

Background color for recording canvas

recordingNameTagsColor

recordingNameTagsColor: string

Color for participant name tags

recordingOrientationVideo

recordingOrientationVideo: string

Video orientation ('landscape', 'portrait')

recordingNameTags

recordingNameTags: boolean

Whether to show participant name tags

recordingAddText

recordingAddText: boolean

Whether to add custom text overlay

recordingCustomText

recordingCustomText: string

Custom text to overlay on recording

recordingCustomTextPosition

recordingCustomTextPosition: string

Position of custom text ('top', 'bottom', etc.)

recordingCustomTextColor

recordingCustomTextColor: string

Color of custom text

Media Options:

recordingMediaOptions

recordingMediaOptions: string

General media recording options

recordingAudioOptions

recordingAudioOptions: string

Audio encoding/quality options

recordingVideoOptions

recordingVideoOptions: string

Video quality/codec options

Visual Customization:

recordingAddHLS

recordingAddHLS: boolean

Whether to enable HLS streaming

State Update Functions:

eventType

eventType: EventType

Type of event being recorded

Video Settings:

updateRecordingVideoType

updateRecordingVideoType: ((value: string) => void)

Update video type setting

updateRecordingDisplayType

updateRecordingDisplayType: ((value: "video" | "media" | "all") => void)

Update display type

updateRecordingBackgroundColor

updateRecordingBackgroundColor: ((value: string) => void)

Update background color

updateRecordingNameTagsColor

updateRecordingNameTagsColor: ((value: string) => void)

Update name tags color

updateRecordingOrientationVideo

updateRecordingOrientationVideo: ((value: string) => void)

Update video orientation

updateRecordingNameTags

updateRecordingNameTags: ((value: boolean) => void)

Toggle name tags

updateRecordingAddText

updateRecordingAddText: ((value: boolean) => void)

Toggle custom text

updateRecordingCustomText

updateRecordingCustomText: ((value: string) => void)

Update custom text content

updateRecordingCustomTextPosition

updateRecordingCustomTextPosition: ((value: string) => void)

Update text position

updateRecordingCustomTextColor

updateRecordingCustomTextColor: ((value: string) => void)

Update text color

updateRecordingMediaOptions

updateRecordingMediaOptions: ((value: string) => void)

Update media options

updateRecordingAudioOptions

updateRecordingAudioOptions: ((value: string) => void)

Update audio options

updateRecordingVideoOptions

updateRecordingVideoOptions: ((value: string) => void)

Update video options

updateRecordingAddHLS

updateRecordingAddHLS: ((value: boolean) => void)

Toggle HLS streaming

Utility:

getUpdatedAllParams

getUpdatedAllParams: (() => RecordingModalParameters)

Get latest parameter state

prevActiveNames

prevActiveNames: string[]

updateActiveNames

updateActiveNames: ((activeNames: string[]) => void)

updatePrevActiveNames

updatePrevActiveNames: ((prevActiveNames: string[]) => void)

activeNames

activeNames: string[]

trigger

trigger: TriggerType

audioParams

audioParams: ProducerOptions

videoParams

videoParams: ProducerOptions

localStreamScreen

localStreamScreen: MediaStream

shared

shared: boolean

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

audioProducer

audioProducer: Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: Producer<AppData>

updateAudioProducer

updateAudioProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalAudioProducer

updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void)

updateAudioLevel

updateAudioLevel: ((level: number) => void)

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

videoProducer

videoProducer: Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: Producer<AppData>

updateMainWindow

updateMainWindow: boolean

updateVideoProducer

updateVideoProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalVideoProducer

updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void)

updateUpdateMainWindow

updateUpdateMainWindow: ((state: boolean) => void)

islevel

islevel: string

member

member: string

device

device: Device

producerTransport

producerTransport: Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: Transport<AppData>

updateProducerTransport

updateProducerTransport: ((producerTransport: Transport<AppData>) => void)

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void)

updateTransportCreated

updateTransportCreated: ((transportCreated: boolean) => void)

OptionalupdateLocalTransportCreated

updateLocalTransportCreated?: ((localTransportCreated: boolean) => void)

connectSendTransport

connectSendTransport: ConnectSendTransportType

mainScreenPerson

mainScreenPerson: string

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenFilled

mainScreenFilled: boolean

screenStates

screenStates: ScreenState[]

prevScreenStates

prevScreenStates: ScreenState[]

updateScreenStates

updateScreenStates: ((states: ScreenState[]) => void)

updatePrevScreenStates

updatePrevScreenStates: ((states: ScreenState[]) => void)

compareActiveNames

compareActiveNames: CompareActiveNamesType

compareScreenStates

compareScreenStates: CompareScreenStatesType

participants

participants: Participant[]

OptionalupdateDateState

updateDateState?: number

lastUpdate

lastUpdate: number

nForReadjust

nForReadjust: number

shareScreenStarted

shareScreenStarted: boolean

updateUpdateDateState

updateUpdateDateState: ((timestamp: number) => void)

updateLastUpdate

updateLastUpdate: ((lastUpdate: number) => void)

updateNForReadjust

updateNForReadjust: ((nForReadjust: number) => void)

autoAdjust

autoAdjust: AutoAdjustType

OptionalshowAlert

showAlert?: ShowAlert

meetingDisplayType

meetingDisplayType: string

recordingVideoParticipantsFullRoomSupport

recordingVideoParticipantsFullRoomSupport: boolean

recordingAllParticipantsSupport

recordingAllParticipantsSupport: boolean

recordingVideoParticipantsSupport

recordingVideoParticipantsSupport: boolean

recordingSupportForOtherOrientation

recordingSupportForOtherOrientation: boolean

recordingPreferredOrientation

recordingPreferredOrientation: string

recordingMultiFormatsSupport

recordingMultiFormatsSupport: boolean

recordingVideoOptimized

recordingVideoOptimized: boolean

recordingAllParticipantsFullRoomSupport

recordingAllParticipantsFullRoomSupport: boolean

meetingVideoOptimized

meetingVideoOptimized: boolean

breakOutRoomStarted

breakOutRoomStarted: boolean

breakOutRoomEnded

breakOutRoomEnded: boolean

updateRecordingVideoOptimized

updateRecordingVideoOptimized: ((value: boolean) => void)

updateUserRecordingParams

updateUserRecordingParams: ((params: UserRecordingParams) => void)

updateConfirmedToRecord

updateConfirmedToRecord: ((value: boolean) => void)

recordElapsedTime

recordElapsedTime: number

recordStartTime

recordStartTime: number

OptionalrecordTimerInterval

recordTimerInterval?: Timeout

isTimerRunning

isTimerRunning: boolean

canPauseResume

canPauseResume: boolean

recordChangeSeconds

recordChangeSeconds: number

updateRecordStartTime

updateRecordStartTime: ((time: number) => void)

updateRecordTimerInterval

updateRecordTimerInterval: ((interval: Timeout) => void)

updateIsTimerRunning

updateIsTimerRunning: ((isRunning: boolean) => void)

updateCanPauseResume

updateCanPauseResume: ((canPause: boolean) => void)

roomName

roomName: string

userRecordingParams

userRecordingParams: UserRecordingParams

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

updateIsRecordingModalVisible

updateIsRecordingModalVisible: ((visible: boolean) => void)

confirmedToRecord

confirmedToRecord: boolean

videoAlreadyOn

videoAlreadyOn: boolean

audioAlreadyOn

audioAlreadyOn: boolean

recordStarted

recordStarted: boolean

recordResumed

recordResumed: boolean

recordStopped

recordStopped: boolean

startReport

startReport: boolean

endReport

endReport: boolean

canRecord

canRecord: boolean

updateClearedToRecord

updateClearedToRecord: ((cleared: boolean) => void)

updateRecordStarted

updateRecordStarted: ((started: boolean) => void)

updateRecordPaused

updateRecordPaused: ((paused: boolean) => void)

updateRecordResumed

updateRecordResumed: ((resumed: boolean) => void)

updateStartReport

updateStartReport: ((started: boolean) => void)

updateEndReport

updateEndReport: ((ended: boolean) => void)

updateCanRecord

updateCanRecord: ((canRecord: boolean) => void)

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

rePort

rePort: RePortType

captureCanvasStream

captureCanvasStream: CaptureCanvasStreamType

canvasWhiteboard

canvasWhiteboard: HTMLCanvasElement

canvasStream

canvasStream: MediaStream

updateCanvasStream

updateCanvasStream: ((stream: MediaStream) => void)

screenProducer

screenProducer: Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: Producer<AppData>

transportCreated

transportCreated: boolean

OptionallocalTransportCreated

localTransportCreated?: boolean

updateScreenProducer

updateScreenProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalScreenProducer

updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void)

sleep

sleep: SleepType

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

disconnectSendTransportScreen

disconnectSendTransportScreen: DisconnectSendTransportScreenType

Settings

Member Visibility

On This Page

Properties
recordPausedrecordingVideoTyperecordingDisplayTyperecordingBackgroundColorrecordingNameTagsColorrecordingOrientationVideorecordingNameTagsrecordingAddTextrecordingCustomTextrecordingCustomTextPositionrecordingCustomTextColorrecordingMediaOptionsrecordingAudioOptionsrecordingVideoOptionsrecordingAddHLSeventTypeupdateRecordingVideoTypeupdateRecordingDisplayTypeupdateRecordingBackgroundColorupdateRecordingNameTagsColorupdateRecordingOrientationVideoupdateRecordingNameTagsupdateRecordingAddTextupdateRecordingCustomTextupdateRecordingCustomTextPositionupdateRecordingCustomTextColorupdateRecordingMediaOptionsupdateRecordingAudioOptionsupdateRecordingVideoOptionsupdateRecordingAddHLSgetUpdatedAllParamsprevActiveNamesupdateActiveNamesupdatePrevActiveNamesactiveNamestriggeraudioParamsvideoParamslocalStreamScreensharedconnectSendTransportAudioconnectSendTransportVideoaudioProducerlocalAudioProducerupdateAudioProducerupdateLocalAudioProducerupdateAudioLevelscreenParamsparamsvideoProducerlocalVideoProducerupdateMainWindowupdateVideoProducerupdateLocalVideoProducerupdateUpdateMainWindowislevelmemberdeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportmainScreenPersonadminOnMainScreenmainScreenFilledscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesparticipantsupdateDateStatelastUpdatenForReadjustshareScreenStartedupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustshowAlertmeetingDisplayTyperecordingVideoParticipantsFullRoomSupportrecordingAllParticipantsSupportrecordingVideoParticipantsSupportrecordingSupportForOtherOrientationrecordingPreferredOrientationrecordingMultiFormatsSupportrecordingVideoOptimizedrecordingAllParticipantsFullRoomSupportmeetingVideoOptimizedbreakOutRoomStartedbreakOutRoomEndedupdateRecordingVideoOptimizedupdateUserRecordingParamsupdateConfirmedToRecordrecordElapsedTimerecordStartTimerecordTimerIntervalisTimerRunningcanPauseResumerecordChangeSecondsupdateRecordStartTimeupdateRecordTimerIntervalupdateIsTimerRunningupdateCanPauseResumeroomNameuserRecordingParamssocketlocalSocketupdateIsRecordingModalVisibleconfirmedToRecordvideoAlreadyOnaudioAlreadyOnrecordStartedrecordResumedrecordStoppedstartReportendReportcanRecordupdateClearedToRecordupdateRecordStartedupdateRecordPausedupdateRecordResumedupdateStartReportupdateEndReportupdateCanRecordwhiteboardStartedwhiteboardEndedrePortcaptureCanvasStreamcanvasWhiteboardcanvasStreamupdateCanvasStreamscreenProducerlocalScreenProducertransportCreatedlocalTransportCreatedupdateScreenProducerupdateLocalScreenProducersleepcreateSendTransportconnectSendTransportScreendisconnectSendTransportScreen