Agora Electron SDK API Reference
Hierarchy
- TranscodingConfig
Index
Properties
audioChannels
用于旁路直播的输出音频的声道数，取值范围为 [1, 5] 中的整型，默认值为 1。建议取 1 或 2，其余三个选项需要特殊播放器支持：
- 1：单声道
- 2：双声道
- 3：三声道
- 4：四声道
- 5：五声道
audioSampleRate
用于旁路直播的输出音频的采样率：
- AUDIO_SAMPLE_RATE_32000 = 32000
- AUDIO_SAMPLE_RATE_44100 = 44100（默认）
- AUDIO_SAMPLE_RATE_48000 = 48000
backgroundColor
用于旁路直播的输出视频的背景色，格式为 RGB 定义下的十六进制整数（不要带 # 号）， 如 0xFFB6C1 表示浅粉色。默认0x000000，黑色。
height
用于旁路直播的输出视频的总高度，默认值为 640。
- 如果你是视频推流，设置的 width × height 不得低于 64 × 64 (px)，否则系统会默认调整 为 64 x 64 (px)。
- 如果你是音频推流，请将 width × height 设为 0 x 0 (px)。
lowLatency
transcodingExtraInfo
transcodingUsers
TranscodingUser 类。
userCount
获取旁路直播中的用户人数
videoBitrate
用于旁路直播的输出视频的码率，单位为 Kbps，默认值为 400 Kbps。
用户可以根据码率参考表中的码率值进行设置；如果设置的码率超出合理范围， Agora 服务器会在合理区间内自动调整码率值。
videoCodecProfile
用于旁路直播的输出视频的编解码规格。可以设置为 BASELINE、MAIN 或 HIGH；如果设置其他值，服务端会统一设为默认值 HIGH。
- VIDEO_CODEC_PROFILE_BASELINE = 66：Baseline 级别的视频编码规格，一般用于视频通话、手机视频等。
- VIDEO_CODEC_PROFILE_MAIN = 77：Main 级别的视频编码规格，一般用于主流消费类电子产品，如 mp4、便携的视频播放器、PSP 和 iPad 等
- VIDEO_CODEC_PROFILE_HIGH = 100：（默认）High 级别的视频编码规格，一般用于广播及视频碟片存储，高清电视
videoFrameRate
用于旁路直播的输出视频的帧率，单位为帧每秒，取值范围为 (0, 30]， 默认值为 15 fps。
服务器会将将高于 30 的帧率设置改为 30。
videoGop
用于旁路直播的输出视频的 GOP，单位为帧。默认值为 30 帧
watermark
直播视频上的水印图片
Type declaration
-
height: number
图片在视频帧上的高度。
-
url: string
直播视频上图片的 HTTP/HTTPS 地址，字符长度不得超过 1024 字节
-
width: number
图片在视频帧上的宽度。
-
x: number
图片左上角在视频帧上的横轴坐标。
-
y: number
图片左上角在视频帧上的纵轴坐标。
width
用于旁路直播的输出视频的总宽度，默认值为 360。
- 如果你是视频推流，设置的 width × height 不得低于 64 × 64 (px)，否则系统会默认调整 为 64 x 64 (px)。
- 如果你是音频推流，请将 width × height 设为 0 x 0 (px)。
直播转码的相关配置。