Server Gateway SDK v3.7.200.21 for Linux Java
Public Member Functions | List of all members
io.agora.rtc.LiveTranscoding Class Reference

Public Member Functions

 LiveTranscoding ()
 LiveTranscoding (int width, int height, int videoBitrate, int videoFrameRate, int lowLatency, int videoGop, int videoCodecProfile, int backgroundColor, int userCount, TranscodingUser transcodingUsers, java.lang.String transcodingExtraInfo, java.lang.String metadata, RtcImage watermark, int watermarkCount, RtcImage backgroundImage, int backgroundImageCount, int audioSampleRate, int audioBitrate, int audioChannels, int audioCodecProfile)
int getWidth ()
void setWidth (int width)
int getHeight ()
void setHeight (int height)
int getVideoBitrate ()
void setVideoBitrate (int videoBitrate)
int getVideoFrameRate ()
void setVideoFrameRate (int videoFrameRate)
int getLowLatency ()
void setLowLatency (int lowLatency)
int getVideoGop ()
void setVideoGop (int videoGop)
int getVideoCodecProfile ()
void setVideoCodecProfile (int videoCodecProfile)
int getBackgroundColor ()
void setBackgroundColor (int backgroundColor)
int getUserCount ()
void setUserCount (int userCount)
TranscodingUser getTranscodingUsers ()
void setTranscodingUsers (TranscodingUser transcodingUsers)
java.lang.String getTranscodingExtraInfo ()
void setTranscodingExtraInfo (java.lang.String transcodingExtraInfo)
java.lang.String getMetadata ()
void setMetadata (java.lang.String metadata)
RtcImage getWatermark ()
void setWatermark (RtcImage watermark)
int getWatermarkCount ()
void setWatermarkCount (int watermarkCount)
RtcImage getBackgroundImage ()
void setBackgroundImage (RtcImage backgroundImage)
int getBackgroundImageCount ()
void setBackgroundImageCount (int backgroundImageCount)
int getAudioSampleRate ()
void setAudioSampleRate (int audioSampleRate)
int getAudioBitrate ()
void setAudioBitrate (int audioBitrate)
int getAudioChannels ()
void setAudioChannels (int audioChannels)
int getAudioCodecProfile ()
void setAudioCodecProfile (int audioCodecProfile)

Detailed Description

The LiveTranscoding class.

Constructor & Destructor Documentation

◆ LiveTranscoding() [1/2]

io.agora.rtc.LiveTranscoding.LiveTranscoding ( )

◆ LiveTranscoding() [2/2]

io.agora.rtc.LiveTranscoding.LiveTranscoding ( int  width,
int  height,
int  videoBitrate,
int  videoFrameRate,
int  lowLatency,
int  videoGop,
int  videoCodecProfile,
int  backgroundColor,
int  userCount,
TranscodingUser  transcodingUsers,
java.lang.String  transcodingExtraInfo,
java.lang.String  metadata,
RtcImage  watermark,
int  watermarkCount,
RtcImage  backgroundImage,
int  backgroundImageCount,
int  audioSampleRate,
int  audioBitrate,
int  audioChannels,
int  audioCodecProfile 


widthThe 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.
heightThe 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.
videoBitrateThe 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.
videoFrameRateThe 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.
lowLatencyDetermines whether to enable low latency.
  • true: Low latency with unassured quality.
  • false: (Default) High latency with assured quality.
videoGopGop (Group of video) of the video frames in the CDN live stream. The default value is 30 fps.
videoCodecProfileThe video codec profile.
  • 66: Baseline video codec profile. Generally used in video calls on mobile phones.
  • 77: Main video codec profile. Generally used in mainstream electronics, such as MP4 players, portable video players, PSP, and iPads.
  • 100: (Default) High video codec profile. Generally used in high-resolution broadcasts or television.
backgroundColorThe background color in RGB hex. Value only, do not include a preceding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).
userCountThe number of users in the live broadcast.
transcodingUsersThe user layout configuration in the CDN live streaming.
transcodingExtraInfoExtra user-defined information sent to the CDN client. The extra information will be transmitted by SEI packets.
metadataThe metadata sent to the CDN client.
watermarkThe 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.
watermarkCountThe variables means the count of watermark.
backgroundImageThe 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.
backgroundImageCountThe number of background images on the live video. The total number of watermarks and background images must be greater than or equal to 0 and less than or equal to 10. This parameter is used in conjunction with backgroundImage.
audioSampleRateThe audio sample rates.
  • 32000: 32 KHz.
  • 44100: 44.1 KHz.
  • 48000: 48 KHz.
audioBitrateThe bitrate (Kbps) of the audio output stream set for CDN live. The default value is 48 and the highest value is 128.
audioChannelsThe 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.
audioCodecProfileThe audio codec profile type.
  • 0: (Default) LC-AAC, which is the low-complexity audio codec type.
  • 1: HE-AAC, which is the high-efficiency audio codec type.

Member Function Documentation

◆ getAudioBitrate()

int io.agora.rtc.LiveTranscoding.getAudioBitrate ( )

◆ getAudioChannels()

int io.agora.rtc.LiveTranscoding.getAudioChannels ( )

◆ getAudioCodecProfile()

int io.agora.rtc.LiveTranscoding.getAudioCodecProfile ( )

◆ getAudioSampleRate()

int io.agora.rtc.LiveTranscoding.getAudioSampleRate ( )

◆ getBackgroundColor()

int io.agora.rtc.LiveTranscoding.getBackgroundColor ( )

◆ getBackgroundImage()

RtcImage io.agora.rtc.LiveTranscoding.getBackgroundImage ( )

◆ getBackgroundImageCount()

int io.agora.rtc.LiveTranscoding.getBackgroundImageCount ( )

◆ getHeight()

int io.agora.rtc.LiveTranscoding.getHeight ( )

◆ getLowLatency()

int io.agora.rtc.LiveTranscoding.getLowLatency ( )

◆ getMetadata()

java.lang.String io.agora.rtc.LiveTranscoding.getMetadata ( )

◆ getTranscodingExtraInfo()

java.lang.String io.agora.rtc.LiveTranscoding.getTranscodingExtraInfo ( )

◆ getTranscodingUsers()

TranscodingUser io.agora.rtc.LiveTranscoding.getTranscodingUsers ( )

◆ getUserCount()

int io.agora.rtc.LiveTranscoding.getUserCount ( )

◆ getVideoBitrate()

int io.agora.rtc.LiveTranscoding.getVideoBitrate ( )

◆ getVideoCodecProfile()

int io.agora.rtc.LiveTranscoding.getVideoCodecProfile ( )

◆ getVideoFrameRate()

int io.agora.rtc.LiveTranscoding.getVideoFrameRate ( )

◆ getVideoGop()

int io.agora.rtc.LiveTranscoding.getVideoGop ( )

◆ getWatermark()

RtcImage io.agora.rtc.LiveTranscoding.getWatermark ( )

◆ getWatermarkCount()

int io.agora.rtc.LiveTranscoding.getWatermarkCount ( )

◆ getWidth()

int io.agora.rtc.LiveTranscoding.getWidth ( )

◆ setAudioBitrate()

void io.agora.rtc.LiveTranscoding.setAudioBitrate ( int  audioBitrate)

◆ setAudioChannels()

void io.agora.rtc.LiveTranscoding.setAudioChannels ( int  audioChannels)

◆ setAudioCodecProfile()

void io.agora.rtc.LiveTranscoding.setAudioCodecProfile ( int  audioCodecProfile)

◆ setAudioSampleRate()

void io.agora.rtc.LiveTranscoding.setAudioSampleRate ( int  audioSampleRate)

◆ setBackgroundColor()

void io.agora.rtc.LiveTranscoding.setBackgroundColor ( int  backgroundColor)

◆ setBackgroundImage()

void io.agora.rtc.LiveTranscoding.setBackgroundImage ( RtcImage  backgroundImage)

◆ setBackgroundImageCount()

void io.agora.rtc.LiveTranscoding.setBackgroundImageCount ( int  backgroundImageCount)

◆ setHeight()

void io.agora.rtc.LiveTranscoding.setHeight ( int  height)

◆ setLowLatency()

void io.agora.rtc.LiveTranscoding.setLowLatency ( int  lowLatency)

◆ setMetadata()

void io.agora.rtc.LiveTranscoding.setMetadata ( java.lang.String  metadata)

◆ setTranscodingExtraInfo()

void io.agora.rtc.LiveTranscoding.setTranscodingExtraInfo ( java.lang.String  transcodingExtraInfo)

◆ setTranscodingUsers()

void io.agora.rtc.LiveTranscoding.setTranscodingUsers ( TranscodingUser  transcodingUsers)

◆ setUserCount()

void io.agora.rtc.LiveTranscoding.setUserCount ( int  userCount)

◆ setVideoBitrate()

void io.agora.rtc.LiveTranscoding.setVideoBitrate ( int  videoBitrate)

◆ setVideoCodecProfile()

void io.agora.rtc.LiveTranscoding.setVideoCodecProfile ( int  videoCodecProfile)

◆ setVideoFrameRate()

void io.agora.rtc.LiveTranscoding.setVideoFrameRate ( int  videoFrameRate)

◆ setVideoGop()

void io.agora.rtc.LiveTranscoding.setVideoGop ( int  videoGop)

◆ setWatermark()

void io.agora.rtc.LiveTranscoding.setWatermark ( RtcImage  watermark)

◆ setWatermarkCount()

void io.agora.rtc.LiveTranscoding.setWatermarkCount ( int  watermarkCount)

◆ setWidth()

void io.agora.rtc.LiveTranscoding.setWidth ( int  width)

The documentation for this class was generated from the following file: