Agora Web API Reference
Hierarchy
- LiveTranscoding
Index
Properties
Optional audioBitrate
用于直播推流的输出音频的码率，单位为 Kbps。
正整数，默认值为 48，最大值为 128。
Optional audioChannels
用于直播推流的输出音频的声道数
默认值为 1。取值范围为 [1,5] 中的整型，建议取 1 或 2。 3、4、5 需要特殊播放器支持：
- 1: （默认值）单声道
- 2: 双声道
- 3: 三声道
- 4: 四声道
- 5: 五声道
Optional audioSampleRate
用于直播推流的输出音频的采样率
- 32000: 音频采样率 32 kHz
- 44100:（默认值）音频采样率 44.1 kHz
- 48000: 音频采样率 48 kHz
Optional backgroundColor
背景色
默认 0x000000，必须是 16 进制格式。 取值范围为 [0x000000, 0xffffff]。
Optional height
推流视频的总高度，默认值 360，单位为像素。
- 如果推视频流，
height值不得低于 64，否则 Agora 会调整为 64。 - 如果推音频流，请将
width和height设为 0。
images
用于给直播推流的视频添加水印。
具体设置见 TranscodingWatermark。
Optional lowLatency
低延时模式
DEPRECATED
已废弃，不推荐使用。
- true: 低延时，不保证画质
- false: （默认值）高延时，保证画质
transcodingUsers
用于管理参与直播推流的视频转码合图的用户。
最多支持 17 人同时参与转码合图。具体设置见 TranscodingUser。
Optional userCount
参与合图的用户数量，默认 0，最多 17 人。
Optional videoBitrate
用于直播推流的输出视频的码率，单位为 Kbps。
正整数，默认值为 400 Kbps，取值范围为 [1,1000000]。
你可以参考视频分辨率表格进行设置。如果设置的码率超出合理范围，Agora 服务器会在合理区间内自动调整码率值。
Optional videoCodecProfile
用于直播推流的输出视频的编码规格
可以设置为 66、77 或 100。如果设置其他值，Agora 会统一设为默认值 100。
- 66: Baseline 级别的视频编码规格，一般用于低阶或需要额外容错的应用，比如视频通话、手机视频等。
- 77: Main 级别的视频编码规格，一般用于主流消费类电子产品，如 mp4、便携的视频播放器、PSP 和 iPad 等。
- 100（默认）: High 级别的视频编码规格，一般用于广播及视频碟片存储，高清电视。
Optional videoFramerate
用于直播推流的输出视频的帧率，单位为 fps。
正整数，默认值为 15 fps，取值范围为 [1,30]。
服务器会将高于 30 的帧率设置改为 30。
Optional videoGop
用于直播推流的输出视频的 GOP，单位为帧。
正整数，默认值为 30 帧，取值范围为 [1,10000]。
Optional width
推流视频的总宽度，默认值 640，单位为像素。
- 如果推视频流，
width值不得低于 64，否则 Agora 会调整为 64。 - 如果推音频流，请将
width和height设为 0。
管理 CDN 直播推流转码的接口
调用 setLiveTranscoding 时可以通过该接口设置直播推流。
示例代码
var LiveTranscoding = { width: 640, height: 360, videoBitrate: 400, videoFramerate: 15, audioSampleRate: AgoraRTC.AUDIO_SAMPLE_RATE_48000, audioBitrate: 48, audioChannels: 1, videoGop: 30, videoCodecProfile: AgoraRTC.VIDEO_CODEC_PROFILE_HIGH, userCount: 0, backgroundColor: 0x000000, transcodingUsers: [], images: [], };