Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RecordingProperties

Hierarchy

  • RecordingProperties

Index

Properties

Optional customLayout

customLayout: string

The relative path to the specific custom layout you want to use.
Will only have effect if RecordingProperties.outputMode is COMPOSED (or COMPOSED_QUICK_START) and RecordingProperties.recordingLayout is CUSTOM
See Custom recording layouts to learn more

Optional hasAudio

hasAudio: boolean

Whether or not to record audio. Cannot be set to false at the same time as RecordingProperties.hasVideo

Optional hasVideo

hasVideo: boolean

Whether or not to record video. Cannot be set to false at the same time as RecordingProperties.hasAudio

Optional mediaNode

mediaNode: { id: string }

This feature is part of OpenVidu Pro tier PRO

The Media Node where to host the recording. The default option if this property is not defined is the same Media Node hosting the Session to record. This object defines the following properties as Media Node selector:

  • id: Media Node unique identifier

Type declaration

  • id: string

Optional name

name: string

Name of the Recording. The video file will be named after this property. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)

Optional outputMode

outputMode: OutputMode

The mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream

Optional recordingLayout

recordingLayout: RecordingLayout

The layout to be used in the recording.
Will only have effect if RecordingProperties.outputMode is COMPOSED or COMPOSED_QUICK_START

Optional resolution

resolution: string

Recording video file resolution. Must be a string with format "WIDTHxHEIGHT", being both WIDTH and HEIGHT the number of pixels between 100 and 1999.
Will only have effect if RecordingProperties.outputMode is set to Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START. For Recording.OutputMode.INDIVIDUAL all individual video files will have the native resolution of the published stream

Optional shmSize

shmSize: number

If COMPOSED recording, the amount of shared memory reserved for the recording process in bytes. Minimum 134217728 (128MB). Property ignored if INDIVIDUAL recording. Default to 536870912 (512 MB)

Generated using TypeDoc