#include <IAgoraRtcEngine.h>
Public Member Functions | |
| LiveTranscoding () | |
Public Attributes | |
| int | width |
| int | height |
| int | videoBitrate |
| int | videoFramerate |
| bool | lowLatency |
| int | videoGop |
| VIDEO_CODEC_PROFILE_TYPE | videoCodecProfile |
| unsigned int | backgroundColor |
| unsigned int | userCount |
| TranscodingUser * | transcodingUsers |
| const char * | transcodingExtraInfo |
| const char * | metadata |
| RtcImage * | watermark |
| RtcImage * | backgroundImage |
| AUDIO_SAMPLE_RATE_TYPE | audioSampleRate |
| int | audioBitrate |
| int | audioChannels |
Detailed Description
A structure for managing CDN live audio/video transcoding settings.
Constructor & Destructor Documentation
◆ LiveTranscoding()
|
inline |
Member Data Documentation
◆ width
| int agora::rtc::LiveTranscoding::width |
Width of the video. The default value is 360.
◆ height
| int agora::rtc::LiveTranscoding::height |
Height of the video. The default value is 640.
◆ videoBitrate
| int agora::rtc::LiveTranscoding::videoBitrate |
Bitrate of the CDN live output video stream. The default value is 400 Kbps.
◆ videoFramerate
| int agora::rtc::LiveTranscoding::videoFramerate |
Frame rate of the output video stream set for the CDN live broadcast. The default value is 15 fps.
◆ lowLatency
| bool agora::rtc::LiveTranscoding::lowLatency |
Latency mode:
- true: Low latency with unassured quality.
- false: (Default) High latency with assured quality.
◆ videoGop
| int agora::rtc::LiveTranscoding::videoGop |
Video GOP in frames. The default value is 30 fps.
◆ videoCodecProfile
| VIDEO_CODEC_PROFILE_TYPE agora::rtc::LiveTranscoding::videoCodecProfile |
Self-defined video codec profile: VIDEO_CODEC_PROFILE_TYPE
◆ backgroundColor
| unsigned int agora::rtc::LiveTranscoding::backgroundColor |
RGB hex value.
Background color of the output video stream for the CDN live broadcast defined as int color = (A & 0xff) << 24 | (R & 0xff) << 16 | (G & 0xff) << 8 | (B & 0xff). Users can set the backgroundColor with ARGB ColorInt.
- Note
- Value only, do not include a #. For example, C0C0C0.
◆ userCount
| unsigned int agora::rtc::LiveTranscoding::userCount |
The number of users in the live broadcast.
◆ transcodingUsers
| TranscodingUser* agora::rtc::LiveTranscoding::transcodingUsers |
◆ transcodingExtraInfo
| const char* agora::rtc::LiveTranscoding::transcodingExtraInfo |
Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client.
◆ metadata
| const char* agora::rtc::LiveTranscoding::metadata |
The metadata sent to the CDN live client defined by the RTMP or FLV metadata.
◆ watermark
| RtcImage* agora::rtc::LiveTranscoding::watermark |
The watermark image added to the CDN live publishing stream.
The audience of the CDN live publishing stream can see the watermark image. See RtcImage.
◆ backgroundImage
| RtcImage* agora::rtc::LiveTranscoding::backgroundImage |
The background image added to the CDN live publishing stream.
The audience of the CDN live publishing stream can see the background image. See RtcImage.
◆ audioSampleRate
| AUDIO_SAMPLE_RATE_TYPE agora::rtc::LiveTranscoding::audioSampleRate |
Self-defined audio-sampling rate: AUDIO_SAMPLE_RATE_TYPE.
◆ audioBitrate
| int agora::rtc::LiveTranscoding::audioBitrate |
Bitrate of the CDN live audio output stream. The default value is 48 Kbps, and the highest value is 128.
◆ audioChannels
| int agora::rtc::LiveTranscoding::audioChannels |
Agora's self-defined audio-channel types. Agora recommends choosing option 1 or 2. A special player is required if you choose option 3, 4, or 5:
- 1: (Default) Mono
- 2: Two-channel stereo
- 3: Three-channel stereo
- 4: Four-channel stereo
- 5: Five-channel stereo
