本地房间内录制参数(需要建立通信)

Accessors

  • get frameRate(): number
  • 获取录制帧率

    Returns number

  • set frameRate(frameRate: number): void
  • 设置录制帧率,默认15,当使用配置文件时,该参数无效

    Parameters

    • frameRate: number

    Returns void

  • get mergeMode(): JRTCVideoMergeMode
  • 获取媒体录制视频合并模式

    Returns JRTCVideoMergeMode

  • set mergeMode(mergeMode: JRTCVideoMergeMode): void
  • 设置媒体录制视频合并模式,默认智能分屏模式,当使用配置文件时,该参数无效

    Parameters

    Returns void

  • get intelligentMergeMode(): JRTCIntelligentMergeMode
  • 获取 mergeMode 为智能分屏模式下的布局样式(无屏幕共享

    Returns JRTCIntelligentMergeMode

  • set intelligentMergeMode(intelligentMergeMode: JRTCIntelligentMergeMode): void
  • 设置 mergeMode 为智能分屏模式下的布局样式(无屏幕共享),当使用配置文件时,该参数无效

    Parameters

    Returns void

  • get scsMergeMode(): JRTCScsMergeMode
  • 获取 mergeMode 为智能分屏模式下的布局样式(有屏幕共享)

    Returns JRTCScsMergeMode

  • set scsMergeMode(scsMergeMode: JRTCScsMergeMode): void
  • 设置 mergeMode 为智能分屏模式下的布局样式(有屏幕共享),当使用配置文件时,该参数无效

    Parameters

    Returns void

  • get videoWidth(): number
  • 获取录制视频的宽度

    Returns number

  • set videoWidth(videoWidth: number): void
  • 设置录制视频的宽度,当使用配置文件时,该参数无效

    Parameters

    • videoWidth: number

    Returns void

  • get videoHeight(): number
  • 获取录制视频的高度

    Returns number

  • set videoHeight(videoHeight: number): void
  • 设置录制视频的高度,当使用配置文件时,该参数无效

    Parameters

    • videoHeight: number

    Returns void

  • get iBitrate(): number
  • 获取录制码率

    Returns number

  • set iBitrate(iBitrate: number): void
  • 设置录制码率,当使用配置文件时,该参数无效

    Parameters

    • iBitrate: number

    Returns void

  • get filePath(): string
  • 获取保存的文件路径

    Returns string

  • set filePath(filePath: string): void
  • 设置保存的文件路径,必须包含文件名 音频文件录制后缀为mp4,如xx.mp4 音频文件录制后缀为aac,如xx.aac

    Parameters

    • filePath: string

    Returns void

  • get recVideo(): boolean
  • 获取是否录制视频

    Returns boolean

  • set recVideo(recVideo: boolean): void
  • 设置是否录制视频,默认 true

    Parameters

    • recVideo: boolean

    Returns void

  • get recAudio(): boolean
  • 获取是否录制音频

    Returns boolean

  • set recAudio(recAudio: boolean): void
  • 设置是否录制音频,默认 true

    Parameters

    • recAudio: boolean

    Returns void

  • get includeSelf(): boolean
  • 获取录制是否包含自己

    Returns boolean

  • set includeSelf(includeSelf: boolean): void
  • 设置录制是否包含自己,默认 true

    Parameters

    • includeSelf: boolean

    Returns void

  • get watermarkTextMap(): any
  • 获取录制视频文本水印

    Returns any

  • set watermarkTextMap(watermarkTextMap: any): void
  • 设置录制视频文本水印,需要结合配置文件一起使用

    Parameters

    • watermarkTextMap: any

    Returns void

  • get configFilePath(): string
  • 获取录制配置文件路径

    Returns string

  • set configFilePath(configFilePath: string): void
  • 设置录制配置文件路径 例如: xxx\record.cfg

    配置文件说明:

    Parameters

    • configFilePath: string

    Returns void

    , "watermark" : { //水印配置, 固定值. "picture" : [ //图片水印配置, 固定值, 图片水印目前只支持 png 格式. { "enable" : true, //是否启用(布尔类型). "pcUrl" : "http://xxx/xxx.png", //图片水印链接地址. "index" : 1, //水印的序号. "state" : 1, //水印的状态. 设置值为1表示使用水印,设置值为2表示关闭水印. "posX" : 0, //相对于基准位置的水平偏移值(整数类型), 负值向左偏移, 正值向右偏移, 实际大小非比例值. "posY" : 600 //相对于基准位置的垂直偏移值(整数类型), 负值向上偏移, 正值向下偏移, 实际大小非比例值. } ], "text" : { //文本水印配置, 固定值. "enable" : true, //是否启用(布尔类型). "memo" : [ //文本水印样式配置(JSON数组类型), 如果不设置就使用默认全局样式. "Dialogue: 0,0:00:00.0,60:00:00.0,Default,,0,0,0,,{\pos(34, 56)\an7}菊风文本水印1$@name@$", "Dialogue: 0,0:00:00.0,60:00:00.0,Default,,0,0,0,,{\pos(50, 100)\an7}菊风文本水印2" //数组的每个元素为一条 ASS 字幕的 event 字符串, 支持通过标签来设置各种文字特效, 添加的event字符串必须是utf-8编码, 否则中文会出现乱码. ASS 格式规范下载地址: http://www.perlfu.co.uk/projects/asa/ass-specs.doc //其中以 "$@" 开始并且以 "@$" 结束的部分内容"$@name@$"将提取出关键字"name", 通过解析用户通过 #setWatermarkTextMap(Map) setWatermarkTextMap 设置的自定义文本水印信息获取其对应值, "$@name@$"格式的内容被其对应值替换后就是实际应用的 event 字符串, "$@xxx@$" 格式的内容支持同时设置多个. ], "style" : { //文本水印格式, 固定值. "enable" : true, //格式是否启用(布尔类型). "alignment" : 0, //对齐方式, 有效值参考 0:左对齐;1:居中对齐;2:右对齐; "backColor" : 16777215, //背景颜色(整数类型), 10进制颜色代码. "blod" : false, //是否使用粗体(布尔类型). "fontColor" : 16777215, //字体颜色(整数类型), 10进制颜色代码. "fontFile" : "SourceHanSansCN-Normal.otf",//字体文件路径,Windows系统上只能用相对路径(相对配置文件所在路径),不可以带盘符,建议和配置文件放在同个目录下. "fontSize" : 36, //字体尺寸(整数类型). "italic" : true, //是否使用斜体(布尔类型). "underline" : false //是否带有下划线(布尔类型). } }, "timestamp" : { //时间戳水印配置, 固定值. "enable" : true, //是否启用(布尔类型). "basePosType" : 0, //水印基准位置类型(整数类型), 有效值参考 0:左上;1:左下;2:右上;3:右下;4:居中; "borderWidth" : 2, //字体边界宽度(整数类型), 取值范围为[0, 5]. "fontFile" : "SourceHanSansCN-Normal.otf",//字体文件路径,Windows系统上只能用相对路径(相对配置文件所在路径),不可以带盘符,建议和配置文件放在同个目录下. "fontColor" : 0, //字体颜色(整数类型), 有效值参考 0:红色;1:黄色;2:绿色;3:青色;4:蓝色;5:洋红色;6:白色;7:中和色;8:黑色; "fontSize" : 36, //字体尺寸(整数类型). "isMs" : true, //是否显示毫秒值(布尔类型). "posX" : 0, //相对于基准位置的水平偏移值(整数类型), 负值向左偏移, 正值向右偏移, 实际大小非比例值. "posY" : 0 //相对于基准位置的垂直偏移值(整数类型), 负值向上偏移, 正值向下偏移, 实际大小非比例值. } } } }

  • get layoutList(): any
  • 设置录制成员布局列表,mergeMode 为自定义布局需要,需要结合配置文件一起使用

    Returns any

  • set layoutList(layoutList: any): void
  • 设置录制成员布局列表,mergeMode 为自定义布局需要,需要结合配置文件一起使用

    Parameters

    • layoutList: any

    Returns void

Methods

  • 转换 string

    Returns string