Class JRTCRecordLocalParam

本地房间内录制参数类 JRTCRecordLocalParam

Remarks

用于配置本地房间内录制功能的参数，需要建立通信连接

Accessors

frameRate mergeMode intelligentMergeMode scsMergeMode videoWidth videoHeight iBitrate filePath recVideo recAudio includeSelf watermarkTextMap configFilePath layoutList

Methods

toJSON toString

Accessors

frameRate

  • get frameRate(): number

    获取录制帧率

    Returns number

    视频帧率

  • set frameRate(frameRate: number): void

    设置录制帧率

    Parameters

    • frameRate: number

      视频帧率

    Returns void

    Remarks

    默认15，当使用配置文件时，该参数无效

mergeMode

  • get mergeMode(): JRTCVideoMergeMode

    获取媒体录制视频合并模式

    Returns JRTCVideoMergeMode

    视频合并模式

  • set mergeMode(mergeMode: JRTCVideoMergeMode): void

    设置媒体录制视频合并模式

    Parameters

    Returns void

    Remarks

    默认智能分屏模式，当使用配置文件时，该参数无效

intelligentMergeMode

  • get intelligentMergeMode(): JRTCIntelligentMergeMode

    获取智能分屏模式下的布局样式（无屏幕共享）

    Returns JRTCIntelligentMergeMode

    智能分屏布局模式

  • set intelligentMergeMode(intelligentMergeMode: JRTCIntelligentMergeMode): void

    设置智能分屏模式下的布局样式（无屏幕共享）

    Parameters

    Returns void

    Remarks

    当使用配置文件时，该参数无效

scsMergeMode

  • get scsMergeMode(): JRTCScsMergeMode

    获取智能分屏模式下的布局样式（有屏幕共享）

    Returns JRTCScsMergeMode

    屏幕共享时的布局模式

  • set scsMergeMode(scsMergeMode: JRTCScsMergeMode): void

    设置智能分屏模式下的布局样式（有屏幕共享）

    Parameters

    Returns void

    Remarks

    当使用配置文件时，该参数无效

videoWidth

  • get videoWidth(): number

    获取录制视频的宽度

    Returns number

    视频宽度（像素）

  • set videoWidth(videoWidth: number): void

    设置录制视频的宽度

    Parameters

    • videoWidth: number

      视频宽度（像素）

    Returns void

    Remarks

    当使用配置文件时，该参数无效

videoHeight

  • get videoHeight(): number

    获取录制视频的高度

    Returns number

    视频高度（像素）

  • set videoHeight(videoHeight: number): void

    设置录制视频的高度

    Parameters

    • videoHeight: number

      视频高度（像素）

    Returns void

    Remarks

    当使用配置文件时，该参数无效

iBitrate

  • get iBitrate(): number

    获取录制码率

    Returns number

    视频码率（kbps）

  • set iBitrate(iBitrate: number): void

    设置录制码率

    Parameters

    • iBitrate: number

      视频码率（kbps）

    Returns void

    Remarks

    当使用配置文件时，该参数无效

filePath

  • get filePath(): undefined | string

    获取保存的文件路径

    Returns undefined | string

    文件保存路径

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

    设置保存的文件路径

    Parameters

    • filePath: undefined | string

      文件保存路径，必须包含文件名

    Returns void

    Remarks

    • 视频文件录制后缀为mp4，如xx.mp4
    • 音频文件录制后缀为aac，如xx.aac

recVideo

  • get recVideo(): boolean

    获取是否录制视频

    Returns boolean

    是否录制视频

  • set recVideo(recVideo: boolean): void

    设置是否录制视频

    Parameters

    • recVideo: boolean

      是否录制视频

    Returns void

recAudio

  • get recAudio(): boolean

    获取是否录制音频

    Returns boolean

    是否录制音频

  • set recAudio(recAudio: boolean): void

    设置是否录制音频

    Parameters

    • recAudio: boolean

      是否录制音频

    Returns void

includeSelf

  • get includeSelf(): boolean

    获取录制是否包含自己

    Returns boolean

    是否包含自己

  • set includeSelf(includeSelf: boolean): void

    设置录制是否包含自己

    Parameters

    • includeSelf: boolean

      是否包含自己

    Returns void

watermarkTextMap

  • get watermarkTextMap(): any

    获取录制视频文本水印

    Returns any

    水印文本映射

  • set watermarkTextMap(watermarkTextMap: any): void

    设置录制视频文本水印

    Parameters

    • watermarkTextMap: any

      水印文本映射

    Returns void

    Remarks

    需要结合配置文件一起使用

configFilePath

  • get configFilePath(): undefined | string

    获取录制配置文件路径

    Returns undefined | string

    配置文件路径

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

    设置录制配置文件路径

    Parameters

    • configFilePath: undefined | string

      配置文件路径，例如: xxx\record.cfg

    Returns void

    Remarks

    配置文件详细格式说明请参考文档

layoutList

  • get layoutList(): any

    获取录制成员布局列表

    Returns any

    自定义布局列表

  • set layoutList(layoutList: any): void

    设置录制成员布局列表

    Parameters

    • layoutList: any

      自定义布局列表

    Returns void

    Remarks

    mergeMode为自定义布局时需要，需要结合配置文件一起使用

Methods

toJSON

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

    将参数转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有参数的JSON对象

toString

  • toString(): string

    将参数转换为JSON字符串

    Returns string

    包含所有参数的JSON字符串

设置

主题