Class JRTCRecordVideoCaptureParam

本地视频录制参数类

Remarks

用于配置视频录制的各种参数，包括文件路径、音频源、文件类型、分辨率、 码率、帧率、加密选项、分片设置以及水印等。此类不需要建立通信即可使用。

Accessors

filePath audioSource fileType width height enableEncrypt appendMd5 splitIntervalSec splitMaxNum bitrate frameRate

Methods

toJSON toString

Accessors

filePath

  • get filePath(): undefined | string

    获取录制文件保存的文件路径

    Returns undefined | string

    文件保存路径，可能为 undefined

  • set filePath(filePath: undefined | string): void

    设置录制文件保存的文件路径

    Parameters

    • filePath: undefined | string

    Returns void

    Remarks

    必须包含完整的文件名和扩展名（如 xxx.mp4 或 xxx.avi）

audioSource

fileType

width

  • get width(): number

    获取录制文件宽度

    Returns number

    当前设置的宽度，-1 表示使用实际视频采集宽度

  • set width(width: number): void

    设置录制文件宽度

    Parameters

    • width: number

    Returns void

    Remarks

    传入 -1 时，将使用实际视频采集的宽度

height

  • get height(): number

    获取录制文件高度

    Returns number

    当前设置的高度，-1 表示使用实际视频采集高度

  • set height(height: number): void

    设置录制文件高度

    Parameters

    • height: number

    Returns void

    Remarks

    传入 -1 时，将使用实际视频采集的高度

enableEncrypt

  • get enableEncrypt(): boolean

    获取录制文件是否加密

    Returns boolean

    当前的加密设置

    • true: 启用加密
    • false: 不加密
  • set enableEncrypt(value: boolean): void

    设置录制文件是否加密

    Parameters

    • value: boolean

    Returns void

    Remarks

    默认为 false，不加密

appendMd5

  • get appendMd5(): boolean

    获取录制文件末尾是否增加Md5校验值

    Returns boolean

    当前的Md5校验设置

    • true: 增加Md5校验值
    • false: 不增加Md5校验值
  • set appendMd5(value: boolean): void

    设置录制文件末尾是否增加Md5校验值

    Parameters

    • value: boolean

    Returns void

    Remarks

    默认为 false，不增加

splitIntervalSec

  • get splitIntervalSec(): number

    获取分片录制单个文件录制时长

    Returns number

    当前设置的分片时长（秒），值小于等于0表示不分片录制

  • set splitIntervalSec(value: number): void

    设置分片录制单个文件录制时长

    Parameters

    • value: number

    Returns void

    Remarks

    单位为秒，值小于等于0表示不分片录制，默认不分片录制

splitMaxNum

  • get splitMaxNum(): number

    获取分片录制文件最大分割个数

    Returns number

    当前设置的最大分片数量

  • set splitMaxNum(value: number): void

    设置分片录制文件最大分割个数

    Parameters

    • value: number

    Returns void

    Remarks

    超过最大文件录制分割个数会循环覆盖，默认值为 0x7fffffff

bitrate

  • get bitrate(): number

    获取录制码率

    Returns number

    当前设置的码率，-1 表示使用默认码率

  • set bitrate(value: number): void

    设置录制码率

    Parameters

    • value: number

    Returns void

    Remarks

    单位为 bps，值为 -1 时使用默认码率

frameRate

  • get frameRate(): number

    获取录制帧率

    Returns number

    当前设置的帧率，-1 表示使用默认帧率

  • set frameRate(value: number): void

    设置录制帧率

    Parameters

    • value: number

    Returns void

    Remarks

    值为 -1 时使用默认帧率

Methods

toJSON

  • toJSON(): Record<string, undefined | Object>

    将参数转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有参数的JSON对象

toString

  • toString(): string

    将参数转换为JSON字符串

    Returns string

    包含所有参数的JSON字符串

设置

主题