管理旁路推流转码的类

example

示例代码

var LiveTranscoding = {
  width: 640,
  height: 360,
  videoBitrate: 400,
  videoFramerate: 15,
  lowLatency: false,
  audioSampleRate: AgoraRTC.AUDIO_SAMPLE_RATE_48000,
  audioBitrate: 48,
  audioChannels: 1,
  videoGop: 30,
  videoCodecProfile: AgoraRTC.VIDEO_CODEC_PROFILE_HIGH,
  userCount: 0,
  backgroundColor: 0x000000,
  transcodingUsers: [],
};

Hierarchy

  • LiveTranscoding

Index

Properties

audioBitrate

audioBitrate: number

用于旁路直播的输出音频的码率。单位为 Kbps,默认值为 48,最大值为 128。

audioChannels

audioChannels: number

用于旁路直播的输出音频的声道数

默认值为 1。取值范围为 [1,5] 中的整型,建议取 1 或 2。 3、4、5 需要特殊播放器支持:

  • 1: (默认值)单声道
  • 2: 双声道
  • 3: 三声道
  • 4: 四声道
  • 5: 五声道

audioSampleRate

audioSampleRate: 32000 | 441000 | 48000

用于旁路直播的输出音频的采样率

  • 32000: 音频采样率 32 kHz
  • 44100: 音频采样率 44.1 kHz
  • 48000: 音频采样率 48 kHz

backgroundColor

backgroundColor: number

背景色,默认 0x000000。

height

height: number

用于旁路直播的输出视频的宽,默认 360。

lowLatency

lowLatency: boolean

低延时模式

  • true: 低延时,不保证画质
  • false: (默认值)高延时,保证画质

transcodingUsers

transcodingUsers: object

用于管理参与旁路直播的视频转码合图的用户

最多支持 17 人同时参与转码合图。

Type declaration

  • alpha: number

    直播视频上用户视频的透明度

    取值范围为 [0.0,1.0]:

    • 0.0: 该区域图像完全透明
    • 1.0: (默认值)该区域图像完全不透明
  • height: number

    视频帧高度

  • uid: number

    旁路推流的用户 ID

  • width: number

    视频帧宽度

  • x: number

    视频帧左上角的横轴位置

  • y: number

    视频帧左上角的纵轴位置

  • zOrder: number

    直播视频上用户视频帧的图层编号

    整数,取值范围为 0 到 100。

    Agora SDK 从 v2.3.0 开始支持将 zOrder 设为 0。

    • 最小值为 0(默认值),表示该区域图像位于最下层。
    • 最大值为 100,表示该区域图像位于最上层。

userCount

userCount: number

参与合图的用户数量,默认 0。

videoBitrate

videoBitrate: number

用于旁路直播的输出视频的码率。单位为 Kbps。默认值为 400 Kbps。

videoCodecProfiel

videoCodecProfiel: 66 | 77 | 100

用于旁路直播的输出视频的编码规格:

  • 66: Baseline 级别的视频编码规格,一般用于低阶或需要额外容错的应用,比如视频通话、手机视频等。
  • 77: Main 级别的视频编码规格,一般用于主流消费类电子产品,如 mp4、便携的视频播放器、PSP 和 iPad 等。
  • 100: High 级别的视频编码规格,一般用于广播及视频碟片存储,高清电视。

videoFramerate

videoFramerate: number

用于旁路直播的输出视频的帧率。单位为 fps。默认值为 15 fps。

videoGop

videoGop: number

用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 帧。

width

width: number

用于旁路直播的输出视频的宽,默认 640。