Variable startRecords`Const`

startRecords: (
{ roomName, member, socket, }: StartRecordsOptions,
) => Promise<void>

Requests recording startup for the current room.

Type Declaration

- ({ roomName, member, socket, }: StartRecordsOptions): Promise<void>
- Parameters
  - { roomName, member, socket, }: StartRecordsOptions
  Returns Promise<void>
  Resolves after the emit request is sent.

Example

await startRecords({
  roomName: 'RoomA',
  member: 'AdminUser',
  socket,
});