Class RecordStartTimer

Starts the recording timer and manages its state.

Param: options

The options for starting the recording timer.

Param: options.parameters

The parameters for the recording timer.

Param: options.parameters.getUpdatedAllParams

Function to get updated parameters.

Param: options.parameters.recordStartTime

The start time of the recording.

Param: options.parameters.recordTimerInterval

The interval ID for the recording timer.

Param: options.parameters.isTimerRunning

Flag indicating if the timer is currently running.

Param: options.parameters.canPauseResume

Flag indicating if pause/resume actions are enabled.

Param: options.parameters.recordChangeSeconds

The time after which pause/resume actions are enabled.

Param: options.parameters.updateRecordStartTime

Function to update the recording start time.

Param: options.parameters.updateRecordTimerInterval

Function to update the recording timer interval.

Param: options.parameters.updateIsTimerRunning

Function to update the timer running state.

Param: options.parameters.updateCanPauseResume

Function to update the pause/resume state.

Returns

A promise that resolves when the timer is started.

Remarks

This function initializes the recording start time and sets up an interval to update the timer every second. It also manages the state of the timer, including enabling and disabling pause/resume actions. The timer is stopped if the recording is paused, stopped, or if the room name is invalid.

Example

const options: RecordStartTimerOptions = {
  parameters: {
    recordStartTime: Date.now(),
    recordTimerInterval: null,
    isTimerRunning: false,
    canPauseResume: false,
    recordChangeSeconds: 15,
    recordPaused: false,
    recordStopped: false,
    roomName: 'room1',
    updateRecordStartTime: (time) => {  },
    updateRecordTimerInterval: (interval) => {  },
    updateIsTimerRunning: (isRunning) => { },
    updateCanPauseResume: (canPause) => {},
    getUpdatedAllParams: () => { },
  },
};
await recordStartTimer(options);

Constructors

constructor

Methods

recordStartTimer

Constructors

constructor

Methods

recordStartTimer

  • recordStartTimer(options): Promise<void>

  • Starts a recording timer and manages its state.

    Parameters

    • options: {
          parameters: any;
      }

      The options for starting the recording timer.

      • parameters: any

    Returns Promise<void>

    A promise that resolves when the timer is started.

    Remarks

    This function initializes the recording start time and sets up an interval to update the timer every second. It also manages the state of the timer, including enabling and disabling pause/resume actions. The timer is stopped if the recording is paused, stopped, or if the room name is invalid.

Settings

Member Visibility

On This Page

Constructors
Methods