Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace "agora-edu-core/src/stores/domain/common/recording/type"

Index

Enumerations

Type aliases

Type aliases

RecordArguments

RecordArguments: { mode?: RecordMode; retryTimeout?: number; webRecordConfig: WebRecordConfig }

Recording arguments.

Type declaration

  • Optional mode?: RecordMode

    Recording mode:

    • Set this parameter as web to enable web page recording mode. The format of recorded files is MP4. When the length of the recorded file exceeds two hours, or when the size of the file exceeds 2 GB, the recording service automatically creates another MP4 file.
    • If you do not set this parameter, Flexible Classroom records the audio and video of the teachers only in composite recording mode by default. The format of recorded files is M3U8 and TS.
  • Optional retryTimeout?: number

    The time (seconds) that the Flexible Classroom cloud service waits between attempts to begin recording. The Flexible Classroom cloud service retries twice at most. If you set this parameter, refer to Record a class for more information.

  • webRecordConfig: WebRecordConfig

    Recording configuration.

WebRecordConfig

WebRecordConfig: { audioProfile?: number; maxRecordingHour?: number; onhold?: boolean; rootUrl?: string; url?: string; videoBitrate?: number; videoFps?: number; videoHeight?: number; videoWidth?: number }

Recording configuration. For more information, see the Classroom RESTful API reference.

Type declaration

  • Optional audioProfile?: number

    The sample rate, encoding mode, number of audio channels, and bitrate or the output audio. 0: (Default) Sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 48 Kbps. 1: Sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 128 Kbps. 2: Sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 192 Kbps.

  • Optional maxRecordingHour?: number

    Maximum recording length (hours). The value range is [1,720].

    • If you set the class duration, the maximum recording length is equal to the ceiling of the class duration. For example, if you set the classroom duration to 1800 seconds (0.5 hours), then maxRecordingHour is 1.
    • If you do not set the classroom duration, the defaul value of maxRecordingHour is 2. When the recording length exceeds the value of maxRecordingHour, the recording stops automatically.
  • Optional onhold?: boolean

    Whether to pause before recording: true: Pauses recording immediately after the web page recording task is enabled. The recording service opens and renders the web page to be recorded, but does not generate a slice file. false: (Default) Enables the web page recording task and starts recording.

  • Optional rootUrl?: string

    Root address of the web page to be recorded.

  • Optional url?: string

    Address of the web page to be recorded.

  • Optional videoBitrate?: number

    Bitrate of the video (Kbps). The value range is [50, 8000]. The default value of videoBitrate varies according to the resolution of the output video:

    • If the resolution of the output video is greater than or equal to 1280 × 720, the default value of videoBitrate is 2000.
    • If the resolution of the output video is less than 1280 × 720, the default value of videoBitrate is 1500.
  • Optional videoFps?: number

    Frame rate of the video (fps). The value range is [5, 60]. The default value is 15.

  • Optional videoHeight?: number

    Height of the video (pixels). The value range is [480, 1280]. The default value is 720. The product of videoWidth and videoHeight must not exceed 921,600 (1280 × 720).

  • Optional videoWidth?: number

    Width of the video (pixels). The value range is [480, 1280]. The default value is 1280. The product of videoWidth and videoHeight must not exceed 921,600 (1280 × 720).