Agora Web SDK API Reference
Hierarchy
- LiveTranscoding
Index
Properties
Optional audioBitrate
The audio bitrate (Kbps) of the CDN live stream.
A positive integer. The default value is 48, and the highest value is 128.
Optional audioChannels
The number of audio channels for the CDN live stream.
Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5.
- 1: (Default) Mono
- 2: Stereo
- 3: Three audio channels
- 4: Four audio channels
- 5: Five audio channels
Optional audioSampleRate
The audio sampling rate:
- 32000: 32 kHz
- 44100: (Default) 44.1 kHz
- 48000: 48 kHz
Optional backgroundColor
The background color in RGB hex.
Value only. Do not include a preceding #. The default value is 0x000000. The value range is [0x000000, 0xffffff].
Optional height
The height of the video in pixels.
A positive integer. The default value is 360.
- When pushing video streams to the CDN, ensure that
heightis at least 64; otherwise, the Agora server adjusts the value to 64. - When pushing audio streams to the CDN, set
widthandheightas 0.
images
Optional lowLatency
DEPRECATED
Latency mode:
- true: Low latency with unassured quality.
- false: (Default）High latency with assured quality.
transcodingUsers
Manages the user layout configuration in the CDN live streaming.
Agora supports a maximum of 17 transcoding users in a CDN streaming channel. See TranscodingUser for details.
Optional userCount
The number of users; default value is 0. The maximum is 17.
Optional videoBitrate
The bitrate (Kbps) of the output video stream.
A positive integer. The default value is 400 Kbps. The value range is [1,1000000].
Set the bitrate according to the Video Profile Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
Optional videoCodecProfile
The video codec profile type.
Set it as 66, 77, or 100 (default). If you set this parameter to any other value, Agora adjusts it to the default value 100.
- 66: Baseline video codec profile. Generally used for video calls on mobile phones.
- 77: Main video codec profile. Generally used for mainstream electronics, such as MP4 players, portable video players, PSP, and iPads.
- 100: (Default) High video codec profile. Generally used for high-resolution broadcasts or television.
Optional videoFramerate
The video frame rate (fps) of the CDN live stream.
A positive integer. The default value is 15 fps. The value range is [1, 30]. The Agora server adjusts any value over 30 to 30.
Optional videoGop
The video GOP in frames. The default value is 30 frames. The value range is [1,10000].
Optional width
The width of the video in pixels.
A positive integer, the default value is 640.
- When pushing video streams to the CDN, ensure that
widthis at least 64; otherwise, the Agora server adjusts the value to 64. - When pushing audio streams to the CDN, set
widthandheightas 0.
The configurations for CDN live stream transcoding. To be used in setLiveTranscoding.
Sample code
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: [], };