LiveTranscodingOption
rn-agora-docs › "types" › LiveTranscodingOption
member videoBitrate integer number
member videoFramerate integer number
member lowLatency boolean
member videoGop number
member videoCodecProfile VideoCodecProfile
member audioCodecProfile AudioCodecProfile
member audioSampleRate AudioSampleRate
member watermark BackgroundImage
member backgroundImage BackgroundImage
member backgroundColor Standard RGB hex number: e.g. 0xffffff
member audioBitrate number
member audioChannels AudioChannelStereo
member transcodingUsers Array,TranscodingUser>,
member transcodingExtraInfo string
Hierarchy
- LiveTranscodingOption
Index
Properties
- audioBitrate
- audioChannels
- audioCodecProfile
- audioSampleRate
- backgroundColor
- backgroundImage
- lowLatency
- size
- transcodingExtraInfo
- transcodingUsers
- videoBitrate
- videoCodecProfile
- videoFramerate
- videoGop
- watermark
Properties
audioBitrate
• audioBitrate: number
Defined in types.ts:282
Bitrate (Kbps) of the CDN live audio output stream. The default value is 48 and the highest value is 128.
audioChannels
• audioChannels: AudioChannelStereo
Defined in types.ts:284
Bitrate (Kbps) of the CDN live audio output stream. The default value is 48 and the highest value is 128.
audioCodecProfile
• audioCodecProfile: AudioCodecProfile
Defined in types.ts:272
Audio codec profile type {@link AudioCodecProfileType}. Set it as LC-AAC or HE-AAC. The default value is LC-AAC.
audioSampleRate
• audioSampleRate: AudioSampleRate
Defined in types.ts:274
Look at AudioSampleRate for more info.
backgroundColor
• backgroundColor: number
Defined in types.ts:280
[Deprecated]
backgroundImage
• backgroundImage: BackgroundImage
Defined in types.ts:278
The background image added to the CDN live publishing stream. Once a background image is added, the audience of the CDN live publishing stream can see it.
lowLatency
• lowLatency: boolean
Defined in types.ts:266
[Deprecated]
size
• size: Size
Defined in types.ts:260
{width: number,height: number}
Height (pixel) of the video. The default value is 640.
- If you push video streams to the CDN, set the value of width × height to at least 64 × 64, or the SDK adjusts it to 64 x 64.
- If you push audio streams to the CDN, set the value of width × height to 0 × 0.
Width (pixel) of the video. The default value is 360.
- If you push video streams to the CDN, set the value of width × height to at least 64 × 64, or the SDK adjusts it to 64 x 64.
- If you push audio streams to the CDN, set the value of width × height to 0 × 0.
transcodingExtraInfo
• transcodingExtraInfo: string
Defined in types.ts:288
Reserved property. Extra user-defined information to send the Supplemental Enhancement Information (SEI) for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 Bytes. For more information on SEI frames, see SEI-related questions.
transcodingUsers
• transcodingUsers: Array‹TranscodingUser›
Defined in types.ts:286
An array of Transcoding users. Look at TranscodingUser for more info.
videoBitrate
• videoBitrate: number
Defined in types.ts:262
Bitrate (Kbps) of the CDN live output video stream. The default value is 400. Set this parameter according to the Video Bitrate Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
videoCodecProfile
• videoCodecProfile: VideoCodecProfile
Defined in types.ts:270
Video codec profile type: VideoCodecProfile. Set it as BASELINE, MAIN, or HIGH (default). If you set this parameter to other values, Agora adjusts it to the default value HIGH.
videoFramerate
• videoFramerate: number
Defined in types.ts:264
Frame rate (fps) of the CDN live output video stream. The value range is [0, 30]. The default value is 15. Agora adjusts all values over 30 to 30.
videoGop
• videoGop: number
Defined in types.ts:268
Gop of the video frames in the CDN live stream. The default value is 30 fps.
watermark
• watermark: BackgroundImage
Defined in types.ts:276
The watermark image added to the CDN live publishing stream. Ensure that the format of the image is PNG. Once a watermark image is added, the audience of the CDN live publishing stream can see it.