Class JRTCRecordRemoteParam

远程录制参数类 JRTCRecordRemoteParam

Remarks

用于配置远程录制功能的参数，包括视频录制、音频录制、布局设置等

Accessors

recordVideo frameRate mergeMode intelligentMergeMode scsMergeMode videoWidth videoHeight iBitrate extraInfo watermarkTextMap layoutType layoutList fileName splitFileSize

Methods

toJSON toString

Accessors

recordVideo

  • get recordVideo(): boolean

    获取录制是否包含视频

    Returns boolean

    是否包含视频

  • set recordVideo(recordVideo: boolean): void

    设置录制是否包含视频

    Parameters

    • recordVideo: boolean

      是否包含视频

    Returns void

    Remarks

    当设置为false时，服务器将只录制音频文件(aac格式)

frameRate

  • get frameRate(): number

    获取录制帧率

    Returns number

    视频帧率

  • set frameRate(frameRate: number): void

    设置录制帧率

    Parameters

    • frameRate: number

      视频帧率

    Returns void

mergeMode

  • get mergeMode(): JRTCVideoMergeMode

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

    Returns JRTCVideoMergeMode

    视频合并模式

  • set mergeMode(mergeMode: JRTCVideoMergeMode): void

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

    Parameters

    Returns void

intelligentMergeMode

  • get intelligentMergeMode(): JRTCIntelligentMergeMode

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

    Returns JRTCIntelligentMergeMode

    智能分屏布局模式

  • set intelligentMergeMode(intelligentMergeMode: JRTCIntelligentMergeMode): void

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

    Parameters

    Returns void

scsMergeMode

  • get scsMergeMode(): JRTCScsMergeMode

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

    Returns JRTCScsMergeMode

    屏幕共享时的布局模式

  • set scsMergeMode(scsMergeMode: JRTCScsMergeMode): void

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

    Parameters

    Returns void

videoWidth

  • get videoWidth(): number

    获取录制视频的宽度

    Returns number

    视频宽度（像素）

  • set videoWidth(videoWidth: number): void

    设置录制视频的宽度

    Parameters

    • videoWidth: number

      视频宽度（像素）

    Returns void

videoHeight

  • get videoHeight(): number

    获取录制视频的高度

    Returns number

    视频高度（像素）

  • set videoHeight(videoHeight: number): void

    设置录制视频的高度

    Parameters

    • videoHeight: number

      视频高度（像素）

    Returns void

iBitrate

  • get iBitrate(): number

    获取录制码率

    Returns number

    视频码率（kbps）

  • set iBitrate(iBitrate: number): void

    设置录制码率

    Parameters

    • iBitrate: number

      视频码率（kbps）

    Returns void

extraInfo

  • get extraInfo(): undefined | string

    获取录制自定义随路参数

    Returns undefined | string

    JSON格式的自定义参数

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

    设置录制自定义随路参数

    Parameters

    • extraInfo: undefined | string

      JSON格式的自定义参数

    Returns void

watermarkTextMap

  • get watermarkTextMap(): any

    获取录制视频水印串

    Returns any

    水印文本映射

  • set watermarkTextMap(watermarkTextMap: any): void

    设置录制视频水印串

    Parameters

    • watermarkTextMap: any

      水印文本映射

    Returns void

layoutType

  • get layoutType(): undefined | string

    获取录制样式

    Returns undefined | string

    录制样式ID

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

    设置录制样式

    Parameters

    • layoutType: undefined | string

      业务管理平台上录制配置中的编号ID，不传则使用默认样式

    Returns void

layoutList

  • get layoutList(): any

    获取录制成员布局列表

    Returns any

    自定义布局列表

  • set layoutList(layoutList: any): void

    设置录制成员布局列表

    Parameters

    • layoutList: any

      自定义布局列表

    Returns void

    Remarks

    仅在自定义布局模式下需要设置

fileName

  • get fileName(): undefined | string

    获取存储文件名

    Returns undefined | string

    存储文件名

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

    设置存储文件名

    Parameters

    • fileName: undefined | string

      存储文件名

    Returns void

    Remarks

    • ftp模式下可以带路径，如：juphoon/1.mp4
    • 视频文件录制后缀为mp4，如xx.mp4
    • 音频文件录制后缀为aac，如xx.aac

splitFileSize

  • get splitFileSize(): number

    获取录制文件分割大小

    Returns number

    文件分割大小，单位KB

  • set splitFileSize(splitFileSize: number): void

    设置录制文件分割大小

    Parameters

    • splitFileSize: number

      文件分割大小，单位KB

    Returns void

    Remarks

    传 <= 0表示不分割，默认不分割

Methods

toJSON

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

    将参数转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有参数的JSON对象

toString

  • toString(): string

    将参数转换为JSON字符串

    Returns string

    包含所有参数的JSON字符串

设置

主题