Agora Java API Reference for Android
io.agora.rtc.live.LiveTranscoding Class Reference

Classes

enum  AudioCodecProfileType
 
enum  AudioSampleRateType
 
class  TranscodingUser
 
enum  VideoCodecProfileType
 
enum  VideoCodecType
 

Public Member Functions

void addWatermark (AgoraImage watermark)
 
boolean removeWatermark (AgoraImage watermark)
 
ArrayList< AgoraImagegetWatermarkList ()
 
void addBackgroundImage (AgoraImage backgroundImage)
 
boolean removeBackgroundImage (AgoraImage backgroundImage)
 
ArrayList< AgoraImagegetBackgroundImageList ()
 
void setAdvancedFeatures (String featureName, Boolean opened)
 
Map< String, Boolean > getAdvancedFeatures ()
 
int addUser (TranscodingUser user)
 
final ArrayList< TranscodingUsergetUsers ()
 
void setUsers (ArrayList< TranscodingUser > users)
 
void setUsers (Map< Integer, TranscodingUser > users)
 
int removeUser (int uid)
 
int getUserCount ()
 
int getBackgroundColor ()
 
void setBackgroundColor (int color)
 
void setBackgroundColor (int red, int green, int blue)
 
int getRed ()
 
int getGreen ()
 
int getBlue ()
 
void setRed (int red)
 
void setGreen (int green)
 
void setBlue (int blue)
 

Public Attributes

int width
 
int height
 
int videoBitrate
 
int videoFramerate
 
boolean lowLatency
 
int videoGop
 
AgoraImage watermark
 
AgoraImage backgroundImage
 
AudioSampleRateType audioSampleRate
 
int audioBitrate
 
int audioChannels
 
AudioCodecProfileType audioCodecProfile
 
VideoCodecProfileType videoCodecProfile
 
VideoCodecType videoCodecType
 
int userCount
 
int backgroundColor
 
String userConfigExtraInfo
 
String metadata
 

Static Public Attributes

static final String LBHQ = "lbhq"
 

Detailed Description

A class for managing user-specific CDN live audio/video transcoding settings.

Member Function Documentation

◆ addWatermark()

void io.agora.rtc.live.LiveTranscoding.addWatermark ( AgoraImage  watermark)

Adds a watermark.

Since
v3.6.0

This method can add a watermark at a time. To add multiple watermarks, call this method multiple times.

The total number of watermarks and background images must be greater than or equal to 0 and less than or equal to 10.

Parameters
watermarkThe watermark on the live video. The format must be in the PNG format. See AgoraImage.

◆ removeWatermark()

boolean io.agora.rtc.live.LiveTranscoding.removeWatermark ( AgoraImage  watermark)

Removes a watermark from the watermark list.

Since
v3.6.0

This method can remove a watermark at a time, so if you need to remove multiple watermarks, call this method multiple times.

Parameters
watermarkThe watermark on the live video. The format must be in the PNG format. See AgoraImage.
Returns
Whether the watermark is successfully removed:
  • true: The watermark is successfully removed.
  • false: The watermark is not removed.

◆ getWatermarkList()

ArrayList< AgoraImage > io.agora.rtc.live.LiveTranscoding.getWatermarkList ( )

Gets the list of watermarks.

Since
v3.6.0
Returns
The list of watermarks.

◆ addBackgroundImage()

void io.agora.rtc.live.LiveTranscoding.addBackgroundImage ( AgoraImage  backgroundImage)

Add a background image.

Since
v3.6.0

This method can add a background image at a time, so if you need to add multiple background images, call this method multiple times.

The total number of watermarks and background images must be greater than or equal to 0 and less than or equal to 10.

Parameters
backgroundImageThe background image on the live video. The format must be in the PNG format. See AgoraImage.

◆ removeBackgroundImage()

boolean io.agora.rtc.live.LiveTranscoding.removeBackgroundImage ( AgoraImage  backgroundImage)

Removes a background image from the background image list.

Since
v3.6.0

This method can remove a background image at a time, so if you need to remove multiple background images, call this method multiple times.

Parameters
backgroundImageThe background image on the live video. The format must be in the PNG format. See AgoraImage.
Returns
Whether the background image is successfully removed:
  • true: The background image is successfully removed.
  • false: The background image is not removed.

◆ getBackgroundImageList()

ArrayList< AgoraImage > io.agora.rtc.live.LiveTranscoding.getBackgroundImageList ( )

Gets the list of background images.

Since
v3.6.0
Returns
The list of background images.

◆ setAdvancedFeatures()

void io.agora.rtc.live.LiveTranscoding.setAdvancedFeatures ( String  featureName,
Boolean  opened 
)

Enables/Disables the advanced feature of the RTMP or RTMPS streaming with transcoding.

Parameters
featureNameThe name of the advanced feature to enable. You can set the name as LBHQ, which means the advanced feature for high-quality video with a lower bitrate.
openedWhether to enable the advanced feature:
  • true: Enable the advanced feature.
  • false: (Default) Disable the advanced feature.

◆ getAdvancedFeatures()

Map< String, Boolean > io.agora.rtc.live.LiveTranscoding.getAdvancedFeatures ( )

Checks whether the advanced feature of the RTMP or RTMPS streaming with transcoding is enabled.

Returns
The name of the advanced feature and whether the advanced feature is enabled. See advancedFeatures for details.

◆ addUser()

int io.agora.rtc.live.LiveTranscoding.addUser ( TranscodingUser  user)

Adds a user displaying the video in CDN live.

Parameters
usertranscodingUser.
Returns
  • 0: Success.
  • <0: Failure.

◆ getUsers()

final ArrayList< TranscodingUser > io.agora.rtc.live.LiveTranscoding.getUsers ( )

Gets the user list in CDN live.

This method retrieves all users in CDN live. The user list returned by this method is read-only and should not be modified.

Returns
User list in a array.

◆ setUsers() [1/2]

void io.agora.rtc.live.LiveTranscoding.setUsers ( ArrayList< TranscodingUser users)

Sets the users in batches in CDN live.

This method sets all users involved in the CDN live stream. This method replaces the old user data with the new user data.

Parameters
usersAll users involved in CDN live.

◆ setUsers() [2/2]

void io.agora.rtc.live.LiveTranscoding.setUsers ( Map< Integer, TranscodingUser users)

Sets the users in batches in CDN live. This method sets all users involved in CDN live. This method replaces the old user data with the the new user data.

Parameters
usersAll users involved in CDN live.

◆ removeUser()

int io.agora.rtc.live.LiveTranscoding.removeUser ( int  uid)

Removes a user from CDN live.

Parameters
uidUser ID of the user to remove from CDN live.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getUserCount()

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

Gets the number of users transcoded in CDN live.

Returns
Number of users transcoded in CDN live.

◆ getBackgroundColor()

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

Gets the background color in hex.

Returns
Background color to set in RGB hex value.

◆ setBackgroundColor() [1/2]

void io.agora.rtc.live.LiveTranscoding.setBackgroundColor ( int  color)

Sets the background color of the CDN live stream in the format of RGB hex.

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

◆ setBackgroundColor() [2/2]

void io.agora.rtc.live.LiveTranscoding.setBackgroundColor ( int  red,
int  green,
int  blue 
)

Sets the background color in RGB format.

Parameters
redRed component.
greenGreen component.
blueBlue component.

◆ getRed()

int io.agora.rtc.live.LiveTranscoding.getRed ( )
Deprecated:
Gets the background color's red component.
Returns
Background color's red component.

◆ getGreen()

int io.agora.rtc.live.LiveTranscoding.getGreen ( )
Deprecated:
Gets the background color's green component.
Returns
Background color's green component.

◆ getBlue()

int io.agora.rtc.live.LiveTranscoding.getBlue ( )
Deprecated:
Gets the background color's blue component.
Returns
Background color's blue component.

◆ setRed()

void io.agora.rtc.live.LiveTranscoding.setRed ( int  red)
Deprecated:
Sets the background color's red component.

◆ setGreen()

void io.agora.rtc.live.LiveTranscoding.setGreen ( int  green)
Deprecated:
Sets the background color's green component.

◆ setBlue()

void io.agora.rtc.live.LiveTranscoding.setBlue ( int  blue)
Deprecated:
Sets the background color's blue component.

Member Data Documentation

◆ width

int io.agora.rtc.live.LiveTranscoding.width

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

  • When pushing video streams to the CDN, the value range of width is [64,1920]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1920, Agora server automatically adjusts it to 1920.
  • When pushing audio streams to the CDN, set width and height as 0.

◆ height

int io.agora.rtc.live.LiveTranscoding.height

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

  • When pushing video streams to the CDN, the value range of height is [64,1080]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1080, Agora server automatically adjusts it to 1080.
  • When pushing audio streams to the CDN, set width and height as 0.

◆ videoBitrate

int io.agora.rtc.live.LiveTranscoding.videoBitrate

The bitrate (Kbps) of the video. 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.

◆ videoFramerate

int io.agora.rtc.live.LiveTranscoding.videoFramerate

The frame rate (fps) of the video. The value range is (0, 30]. The default value is 15. The Agora server adjusts any value over 30 to 30.

◆ lowLatency

boolean io.agora.rtc.live.LiveTranscoding.lowLatency
Deprecated:
Deprecated as of v2.8.0. Agora does not recommend using this parameter. Latency mode:
  • true: Low latency with unassured quality.
  • false: (Default) High latency with assured quality.

◆ videoGop

int io.agora.rtc.live.LiveTranscoding.videoGop

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

◆ watermark

AgoraImage io.agora.rtc.live.LiveTranscoding.watermark

The watermark on the live video. The format must be in the PNG format. See AgoraImage.

Deprecated:
Deprecated from v3.6.0. Use addWatermark instead.

◆ backgroundImage

AgoraImage io.agora.rtc.live.LiveTranscoding.backgroundImage

The background image on the live video. The format must be in the PNG format. See AgoraImage.

Deprecated:
Deprecated from v3.6.0. Use addBackgroundImage instead.

◆ audioSampleRate

AudioSampleRateType io.agora.rtc.live.LiveTranscoding.audioSampleRate

Self-defined audio-sample rate: AudioSampleRateType.

◆ audioBitrate

int io.agora.rtc.live.LiveTranscoding.audioBitrate

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

◆ audioChannels

int io.agora.rtc.live.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

AudioCodecProfileType io.agora.rtc.live.LiveTranscoding.audioCodecProfile

Audio codec profile type: AudioCodecProfileType. Set it as LC-AAC or HE-AAC. The default value is LC-AAC.

◆ videoCodecProfile

VideoCodecProfileType io.agora.rtc.live.LiveTranscoding.videoCodecProfile

Video codec profile type: VideoCodecProfileType. Set it as BASELINE, MAIN, or HIGH (default). If you set this parameter to other values, Agora adjusts it to the default value HIGH.

◆ videoCodecType

VideoCodecType io.agora.rtc.live.LiveTranscoding.videoCodecType

The video codec type of the output video stream. See VideoCodecType.

◆ userCount

int io.agora.rtc.live.LiveTranscoding.userCount

Number of users in the live broadcast.

The value range is [0,17].

Deprecated:
This parameter is deprecated. We recommend using the getUserCount method.

◆ backgroundColor

int io.agora.rtc.live.LiveTranscoding.backgroundColor

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

Deprecated:
This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.

◆ userConfigExtraInfo

String io.agora.rtc.live.LiveTranscoding.userConfigExtraInfo

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.

◆ metadata

String io.agora.rtc.live.LiveTranscoding.metadata

The metadata sent to the CDN live client.

Deprecated:
This parameter is deprecated.

◆ LBHQ

final String io.agora.rtc.live.LiveTranscoding.LBHQ = "lbhq"
static

The advanced feature for high-quality video with a lower bitrate.