Appendix

silentRecord

bool

Silent recording mode.

false

width

int

The width of the recorded video.

640

height

int

The height of the recorded video.

360

recordTotalStream

int

The minimum number of streams required to start recording successfully.

0

startTimeout

int

The timeout period for starting a recording.

10 s

splitType

int

Separates audio and video into additional files.

• 0: Does not separate.

• 1: Separates audio into an additional file.

• 2: Separates video into an additional file.

0

splitFilePath

String

The storage path for the separated audio and video files.

Automatically generated by the backend.

endType

int

Termination type:

• 0: When the caller exits.

• 1: When the channel is destroyed.

0

layoutParam

Array

The layout parameters: [tag1, tag2, tag3, ...]

-

tagPositions

JsonArray

The JSON content is as follows:

• Stream tag. Cannot be empty.

• position

• xPosition

• yPosition

• width

• height

-

overlaps

JsonArray

The JSON content is as follows:

• enable: A boolean value, where `true` indicates enabled and `false` indicates disabled.

• type:

  • 1: Timestamp watermark

  • 2: Text watermark

  • 3: Image watermark

• id: The watermark ID. Leave empty if not set.

• tag: The stream tag. If this is not set or is left empty, the watermark is applied globally.

• xPosition: The position on the x-axis.

• yPosition: The position on the y-axis.

• text: The text for the watermark.

• fontSize: The font size.

• url: The HTTP URL for the watermark image.

-

tagFilter

String

The prefix of the publisher's stream tag. Only streams with a matching tag prefix are subscribed to for recording.

-

crf

int

The definition of the recorded video.

-