Agora Java API Reference for Android
Classes | Public Member Functions | Public Attributes | List of all members
io.agora.rtc2.live.LiveTranscoding Class Reference

Classes

enum  AudioCodecProfileType
 
enum  AudioSampleRateType
 
class  TranscodingUser
 
enum  VideoCodecProfileType
 

Public Member Functions

void addWatermark (AgoraImage watermark)
 
boolean removeWatermark (AgoraImage watermark)
 
ArrayList< AgoraImagegetWatermarkList ()
 
void addBackgroundImage (AgoraImage backgroundImage)
 
boolean removeBackgroundImage (AgoraImage backgroundImage)
 
ArrayList< AgoraImagegetBackgroundImageList ()
 
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
 
int userCount
 
int backgroundColor
 
String userConfigExtraInfo
 
String metadata
 

Member Function Documentation

◆ addWatermark()

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

add watermark to list

Parameters
watermarkyou want to add watermark.

◆ removeWatermark()

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

remove watermark from list

Parameters
watermarkyou want to remove object.
Returns
if success, will return true. Otherwise, will return false.

◆ getWatermarkList()

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

get object attribute of watermarkList

Returns
watermark list

◆ addBackgroundImage()

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

add background image to backgroundImageList

Parameters
backgroundImageyou want to add background to list.

◆ removeBackgroundImage()

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

remove background from background image list

Parameters
backgroundImageyou want to remove background image
Returns
if success to remove, will return true. Otherwise, will return false.

◆ getBackgroundImageList()

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

get object attribute of backgroundImageList

Returns
backgroundImage list

Member Data Documentation

◆ audioCodecProfile

AudioCodecProfileType io.agora.rtc2.live.LiveTranscoding.audioCodecProfile

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