Interface RecordingModalParameters

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;
    audioProducer: null | Producer<AppData>;
    localAudioProducer?: null | Producer<AppData>;
    updateAudioProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localProducer: null | Producer<AppData>) => void);
    updateAudioLevel: ((level: number) => void);
    screenParams: ProducerOptions;
    params: ProducerOptions;
    videoProducer: null | Producer<AppData>;
    localVideoProducer?: null | Producer<AppData>;
    updateMainWindow: boolean;
    updateVideoProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: null | Producer<AppData>) => void);
    updateUpdateMainWindow: ((state: boolean) => void);
    audioParams: ProducerOptions;
    videoParams: ProducerOptions;
    localStreamScreen: null | MediaStream;
    shared: boolean;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    islevel: string;
    member: string;
    device: null | Device;
    producerTransport: null | Transport<AppData>;
    localProducerTransport?: null | Transport<AppData>;
    updateProducerTransport: ((producerTransport: null | Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: null | 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?: null | number;
    lastUpdate: null | number;
    nForReadjust: number;
    shareScreenStarted: boolean;
    updateUpdateDateState: ((timestamp: null | number) => void);
    updateLastUpdate: ((lastUpdate: null | 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);
    isTimerRunning: boolean;
    canPauseResume: boolean;
    recordElapsedTime: number;
    recordStartTime: number;
    recordTimerInterval?: null | Timeout;
    updateRecordStartTime: ((time: number) => void);
    updateRecordTimerInterval: ((interval: null | 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: null | HTMLCanvasElement;
    canvasStream: null | MediaStream;
    updateCanvasStream: ((stream: null | MediaStream) => void);
    screenProducer: null | Producer<AppData>;
    localScreenProducer?: null | Producer<AppData>;
    transportCreated: boolean;
    localTransportCreated?: boolean;
    updateScreenProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: null | 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 audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenParams params videoProducer localVideoProducer? updateMainWindow updateVideoProducer updateLocalVideoProducer? updateUpdateMainWindow audioParams videoParams localStreamScreen shared connectSendTransportAudio connectSendTransportVideo 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 isTimerRunning canPauseResume recordElapsedTime recordStartTime recordTimerInterval? 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

recordingVideoType

recordingVideoType: string

recordingDisplayType

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

recordingBackgroundColor

recordingBackgroundColor: string

recordingNameTagsColor

recordingNameTagsColor: string

recordingOrientationVideo

recordingOrientationVideo: string

recordingNameTags

recordingNameTags: boolean

recordingAddText

recordingAddText: boolean

recordingCustomText

recordingCustomText: string

recordingCustomTextPosition

recordingCustomTextPosition: string

recordingCustomTextColor

recordingCustomTextColor: string

recordingMediaOptions

recordingMediaOptions: string

recordingAudioOptions

recordingAudioOptions: string

recordingVideoOptions

recordingVideoOptions: string

recordingAddHLS

recordingAddHLS: boolean

eventType

eventType: EventType

updateRecordingVideoType

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

updateRecordingDisplayType

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

updateRecordingBackgroundColor

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

updateRecordingNameTagsColor

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

updateRecordingOrientationVideo

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

updateRecordingNameTags

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

updateRecordingAddText

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

updateRecordingCustomText

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

updateRecordingCustomTextPosition

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

updateRecordingCustomTextColor

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

updateRecordingMediaOptions

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

updateRecordingAudioOptions

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

updateRecordingVideoOptions

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

updateRecordingAddHLS

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

getUpdatedAllParams

getUpdatedAllParams: (() => RecordingModalParameters)

prevActiveNames

prevActiveNames: string[]

updateActiveNames

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

updatePrevActiveNames

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

activeNames

activeNames: string[]

trigger

trigger: TriggerType

audioProducer

audioProducer: null | Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: null | Producer<AppData>

updateAudioProducer

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

OptionalupdateLocalAudioProducer

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

updateAudioLevel

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

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

videoProducer

videoProducer: null | Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: null | Producer<AppData>

updateMainWindow

updateMainWindow: boolean

updateVideoProducer

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

OptionalupdateLocalVideoProducer

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

updateUpdateMainWindow

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

audioParams

audioParams: ProducerOptions

videoParams

videoParams: ProducerOptions

localStreamScreen

localStreamScreen: null | MediaStream

shared

shared: boolean

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

islevel

islevel: string

member

member: string

device

device: null | Device

producerTransport

producerTransport: null | Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: null | Transport<AppData>

updateProducerTransport

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

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: null | 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?: null | number

lastUpdate

lastUpdate: null | number

nForReadjust

nForReadjust: number

shareScreenStarted

shareScreenStarted: boolean

updateUpdateDateState

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

updateLastUpdate

updateLastUpdate: ((lastUpdate: null | 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)

isTimerRunning

isTimerRunning: boolean

canPauseResume

canPauseResume: boolean

recordElapsedTime

recordElapsedTime: number

recordStartTime

recordStartTime: number

OptionalrecordTimerInterval

recordTimerInterval?: null | Timeout

updateRecordStartTime

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

updateRecordTimerInterval

updateRecordTimerInterval: ((interval: null | 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: null | HTMLCanvasElement

canvasStream

canvasStream: null | MediaStream

updateCanvasStream

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

screenProducer

screenProducer: null | Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: null | Producer<AppData>

transportCreated

transportCreated: boolean

OptionallocalTransportCreated

localTransportCreated?: boolean

updateScreenProducer

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

OptionalupdateLocalScreenProducer

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

sleep

sleep: SleepType

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

disconnectSendTransportScreen

disconnectSendTransportScreen: DisconnectSendTransportScreenType

Settings

Member Visibility

On This Page

Properties
recordPausedrecordingVideoTyperecordingDisplayTyperecordingBackgroundColorrecordingNameTagsColorrecordingOrientationVideorecordingNameTagsrecordingAddTextrecordingCustomTextrecordingCustomTextPositionrecordingCustomTextColorrecordingMediaOptionsrecordingAudioOptionsrecordingVideoOptionsrecordingAddHLSeventTypeupdateRecordingVideoTypeupdateRecordingDisplayTypeupdateRecordingBackgroundColorupdateRecordingNameTagsColorupdateRecordingOrientationVideoupdateRecordingNameTagsupdateRecordingAddTextupdateRecordingCustomTextupdateRecordingCustomTextPositionupdateRecordingCustomTextColorupdateRecordingMediaOptionsupdateRecordingAudioOptionsupdateRecordingVideoOptionsupdateRecordingAddHLSgetUpdatedAllParamsprevActiveNamesupdateActiveNamesupdatePrevActiveNamesactiveNamestriggeraudioProducerlocalAudioProducerupdateAudioProducerupdateLocalAudioProducerupdateAudioLevelscreenParamsparamsvideoProducerlocalVideoProducerupdateMainWindowupdateVideoProducerupdateLocalVideoProducerupdateUpdateMainWindowaudioParamsvideoParamslocalStreamScreensharedconnectSendTransportAudioconnectSendTransportVideoislevelmemberdeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportmainScreenPersonadminOnMainScreenmainScreenFilledscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesparticipantsupdateDateStatelastUpdatenForReadjustshareScreenStartedupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustshowAlertmeetingDisplayTyperecordingVideoParticipantsFullRoomSupportrecordingAllParticipantsSupportrecordingVideoParticipantsSupportrecordingSupportForOtherOrientationrecordingPreferredOrientationrecordingMultiFormatsSupportrecordingVideoOptimizedrecordingAllParticipantsFullRoomSupportmeetingVideoOptimizedbreakOutRoomStartedbreakOutRoomEndedupdateRecordingVideoOptimizedupdateUserRecordingParamsupdateConfirmedToRecordisTimerRunningcanPauseResumerecordElapsedTimerecordStartTimerecordTimerIntervalupdateRecordStartTimeupdateRecordTimerIntervalupdateIsTimerRunningupdateCanPauseResumeroomNameuserRecordingParamssocketlocalSocketupdateIsRecordingModalVisibleconfirmedToRecordvideoAlreadyOnaudioAlreadyOnrecordStartedrecordResumedrecordStoppedstartReportendReportcanRecordupdateClearedToRecordupdateRecordStartedupdateRecordPausedupdateRecordResumedupdateStartReportupdateEndReportupdateCanRecordwhiteboardStartedwhiteboardEndedrePortcaptureCanvasStreamcanvasWhiteboardcanvasStreamupdateCanvasStreamscreenProducerlocalScreenProducertransportCreatedlocalTransportCreatedupdateScreenProducerupdateLocalScreenProducersleepcreateSendTransportconnectSendTransportScreendisconnectSendTransportScreen