Agora Java API Reference for Android
Public Attributes | List of all members
agora::rtc::LiveTranscoding Struct Reference

#include <AgoraBase.h>

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
 
TranscodingUsertranscodingUsers
 
const char * transcodingExtraInfo
 
const char * metadata
 
RtcImagewatermark
 
unsigned int watermarkCount
 
RtcImagebackgroundImage
 
unsigned int backgroundImageCount
 
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
 
int audioBitrate
 
int audioChannels
 
AUDIO_CODEC_PROFILE_TYPE audioCodecProfile
 

Detailed Description

The definition of the LiveTranscoding struct.

Member Data Documentation

◆ width

int agora::rtc::LiveTranscoding::width

The width of the video in pixels. The default value is 360.

  • When pushing video streams to the CDN, ensure that width is at least 64; otherwise, the Agora server adjusts the value to 64.
  • When pushing audio streams to the CDN, set width and height as 0..

◆ height

int agora::rtc::LiveTranscoding::height

The height of the video in pixels. The default value is 640.

  • When pushing video streams to the CDN, ensure that height is at least 64; otherwise, the Agora server adjusts the value to 64.
  • When pushing audio streams to the CDN, set width and height as 0.

◆ videoBitrate

int agora::rtc::LiveTranscoding::videoBitrate

The bitrate (Kbps) of the video. The default value is 400. Set this parameter according to the bitrate you set in VideoEncoderConfiguration. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.

◆ videoFramerate

int agora::rtc::LiveTranscoding::videoFramerate

The frame rate (fps) of the video that ranges from 0 to 30. The default value is 15. The server adjusts any value over 30 to 30.

◆ lowLatency

bool agora::rtc::LiveTranscoding::lowLatency

Determines whether to enable low latency.

  • true: Low latency with unassured quality.
  • false: (Default) High latency with assured quality.

◆ videoGop

int agora::rtc::LiveTranscoding::videoGop

Gop (Group of video) of the video frames in the CDN live stream. The default value is 30 fps.

◆ videoCodecProfile

VIDEO_CODEC_PROFILE_TYPE agora::rtc::LiveTranscoding::videoCodecProfile

The video codec profile: #VIDEO_CODEC_PROFILE_TYPE.

◆ backgroundColor

unsigned int agora::rtc::LiveTranscoding::backgroundColor

The background color in RGB hex. Value only, do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).

◆ userCount

unsigned int agora::rtc::LiveTranscoding::userCount

The number of users in the live broadcast.

◆ transcodingUsers

TranscodingUser* agora::rtc::LiveTranscoding::transcodingUsers

The user layout configuration in the CDN live streaming.: TranscodingUser.

◆ transcodingExtraInfo

const char* agora::rtc::LiveTranscoding::transcodingExtraInfo

Extra user-defined information sent to the CDN client. The extra infomation will be transmitted by SEI packets.

◆ metadata

const char* agora::rtc::LiveTranscoding::metadata

The pointer to the metadata sent to the CDN client.

◆ watermark

RtcImage* agora::rtc::LiveTranscoding::watermark

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. See #RtcImage.

◆ watermarkCount

unsigned int agora::rtc::LiveTranscoding::watermarkCount

The variables means the count of watermark. if watermark is array, watermarkCount is count of watermark. if watermark is just a pointer, watermarkCount pointer to object address. At the same time, watermarkCount must be 0 or 1. default value: 0, compatible with old user-api

◆ backgroundImage

RtcImage* agora::rtc::LiveTranscoding::backgroundImage

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. See #RtcImage.

◆ backgroundImageCount

unsigned int agora::rtc::LiveTranscoding::backgroundImageCount

The variables means the count of backgroundImage. if backgroundImage is array, backgroundImageCount is count of backgroundImage. if backgroundImage is just a pointer, backgroundImageCount pointer to object address. At the same time, backgroundImageCount must be 0 or 1. default value: 0, compatible with old user-api

◆ audioSampleRate

AUDIO_SAMPLE_RATE_TYPE agora::rtc::LiveTranscoding::audioSampleRate

The audio sample rates: #AUDIO_SAMPLE_RATE_TYPE.

◆ audioBitrate

int agora::rtc::LiveTranscoding::audioBitrate

The bitrate (Kbps) of the audio output stream set for CDN live. The default value is 48 and the highest value is 128.

◆ audioChannels

int agora::rtc::LiveTranscoding::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.

◆ audioCodecProfile

AUDIO_CODEC_PROFILE_TYPE agora::rtc::LiveTranscoding::audioCodecProfile

The audio codec profile type: #AUDIO_CODEC_PROFILE_TYPE.