Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCMCUConfigBuilder

Hierarchy

  • RCMCUConfigBuilder

Index

Constructors

Methods

Constructors

constructor

  • new RCMCUConfigBuilder(_executeCtx: CommandExecuteContext, _invoker: Invoker, _isValidTrackId: ((trackId: string) => boolean)): RCMCUConfigBuilder

  • Parameters

    • _executeCtx: CommandExecuteContext
    • _invoker: Invoker
    • _isValidTrackId: ((trackId: string) => boolean)
        • (trackId: string): boolean

        • trackId 有效性验证方法

          Parameters

          • trackId: string

          Returns boolean

    Returns RCMCUConfigBuilder

Methods

setHostVideoTrack

  • 设置合流后的主位置显示的视频流

    Parameters

    • videoTrackId: string

      视频流资源 Id

    Returns RCMCUConfigBuilder

setMixLayoutMode

  • 设置合流布局模式，当使用 MixLayoutMode.CUSTOMIZE 模式时，需自定义合流结构

    Parameters

    • mode: MixLayoutMode
      • MixLayoutMode.CUSTOMIZE: 自定义布局，需用户设置布局结构
      • MixLayoutMode.SUSPENSION: 悬浮布局（默认）
      • MixLayoutMode.ADAPTATION: 自适应布局

    Returns RCMCUConfigBuilder

setOutputVideoResolution

  • 设置合流输出视频流的分辨率

    Parameters

    Returns RCMCUConfigBuilder

setOutputVideoFPS

  • 设置合流输出视频流的帧率

    Parameters

    • fps: RCFrameRate

      其有效值为 RCFrameRate 中定义的枚举值

    Returns RCMCUConfigBuilder

setOutputVideoBitrate

  • 设置合流输出视频流的码率（不推荐主动修改）

    Parameters

    • bitrate: number

    Returns RCMCUConfigBuilder

setOutputTinyVideoResolution

  • 设置合流后输出视频流小流的分辨率

    Parameters

    Returns RCMCUConfigBuilder

setOutputTinyVideoFPS

  • 设置合流输出视频流小流的帧率

    Parameters

    • fps: RCFrameRate

      其有效值为 RCFrameRate 中定义的枚举值

    Returns RCMCUConfigBuilder

setOutputTinyVideoBitrate

  • 设置合流输出视频流小流的码率（不推荐主动修改）

    Parameters

    • bitrate: number

    Returns RCMCUConfigBuilder

setOutputVideoRenderMode

setOutputAudioBitrate

  • 设置合流后音频流的编码参数（不推荐主动修改）

    Parameters

    • bitrate: number

      音频码率

    Returns RCMCUConfigBuilder

setOutputBackgroundColor

  • 设置合流后的视频流的背景色，默认为 0x000000

    Parameters

    • color: string

      颜色参数，为 16 进制标识法，如 '0x000000'

    Returns RCMCUConfigBuilder

addOutputBackgroundPicture

  • addOutputBackgroundPicture(uri: string, x: number, y: number, w: number, h: number): RCMCUConfigBuilder

  • 向合流后的视频流中增加背景图片

    Parameters

    • uri: string

      图片资源的完整下载地址

    • x: number

      相对于整体画布的起始位置 x 坐标（百分比），有效值 0.0 - 1.0

    • y: number

      相对于整体画布的起始位置 y 坐标（百分比），有效值 0.0 - 1.0

    • w: number

      相对于整体画布的宽（百分比），有效值 0.0 - 1.0

    • h: number

      相对于整体画布的高（百分比），有效值 0.0 - 1.0

    Returns RCMCUConfigBuilder

removeOutputBackgroundPicture

  • 移除对合流后的视频流中添加的指定背景图片

    Parameters

    • uri: string

    Returns RCMCUConfigBuilder

clearOutputBackgroundPicture

  • 清理对合流后的视频流中添加的所有背景图片

    Returns RCMCUConfigBuilder

setOutputBackgroundPictureFillMode

  • 设置合流后的视频流中添加的背景图片的填充方式：

    1. 按比例裁剪
    2. 不裁剪，按比例压缩

    Parameters

    Returns RCMCUConfigBuilder

addPublishStreamUrls

  • 设置直播 CDN 旁路推流地址，最多支持 5 个推流地址

    Parameters

    • urls: string[]

      地址列表

    Returns RCMCUConfigBuilder

removePublishStreamUrls

  • 移除直播 CDN 旁路推流地址

    Parameters

    • urls: string[]

    Returns RCMCUConfigBuilder

clearPublishStreamUrls

  • 清理已添加的 CDN 旁路推流地址

    Returns RCMCUConfigBuilder

addCustomizeLayoutVideo

  • addCustomizeLayoutVideo(trackId: string, x: number, y: number, width: number, height: number): RCMCUConfigBuilder

  • 在自定义布局中增加视频流配置

    Parameters

    • trackId: string

      资源 Id

    • x: number

      在画布中的坐标 x

    • y: number

      在画布中的坐标 y

    • width: number

      分辨率宽度

    • height: number

      分辨率高度

    Returns RCMCUConfigBuilder

removeCustomizeLayoutVideo

  • 移除自定义布局中的视频流配置

    Parameters

    • trackId: string

    Returns RCMCUConfigBuilder

clearCustomizeLayoutVideo

  • 清除已添加的自定义布局中的视频流配置

    Returns RCMCUConfigBuilder

setCustomizeInputAudio

  • 覆盖设置合流媒体中的音频流

    Parameters

    • trackIds: string[]

      音频流 trackId 数组，当数组长度为 0 时，则合流媒体中将无音频输出

    Returns RCMCUConfigBuilder

addCustomizeInputAudio

  • 向既有的音频流合流配置中增加一道音频流

    since

    v5.3.7

    Parameters

    • trackId: string

      音频 trackId

    Returns RCMCUConfigBuilder

removeCustomizeInputAudio

  • 从既有的音频流合流配置中删除一道音频流

    since

    v5.3.7

    Parameters

    • trackId: string

      音频对应的 trackId

    Returns RCMCUConfigBuilder

clearCustomizeInputAudio

  • 清除音频流合流配置，恢复房间内的全音频流合流输出

    since

    v5.3.7

    Returns RCMCUConfigBuilder

addPictureWaterMark

  • addPictureWaterMark(trackId: string, uri: string, x: number, y: number, w: number, h: number): RCMCUConfigBuilder

  • 给单道流添加水印

    description

    注意，参数中 x + width 不得大于 1，y + height 不得大于 1，否则调用 flush() 时会提示 46020 错误

    Parameters

    • trackId: string

      资源 Id

    • uri: string

      水印图片的地址，需注意图片需要是 png 格式

    • x: number

      相对于整体画布的起始位置 x 坐标（百分比），有效值 0.0 - 1.0

    • y: number

      相对于整体画布的起始位置 y 坐标（百分比），有效值 0.0 - 1.0

    • w: number
    • h: number

    Returns RCMCUConfigBuilder

clearPictureWaterMark

  • 删除所有水印

    Returns RCMCUConfigBuilder

removePictureWaterMark

  • 移除对合流后的某个视频流中添加的指定水印图片

    Parameters

    • trackId: string
    • uri: string

    Returns RCMCUConfigBuilder

reset

  • 重置所有合流配置

    since

    v5.3.7

    Returns RCMCUConfigBuilder

flush

  • flush(reset?: boolean): Promise<{ code: RCRTCCode }>

  • 使已修改的配置生效，在调用该方法前，所有数据只会对本地配置进行修改，不会产生实际效果

    Parameters

    • reset: boolean = true

      调用完成后清空当前配置记录，默认为 true（v5.3.7 版本开始启用）

    Returns Promise<{ code: RCRTCCode }>