Classes | |
enum | AudioSampleRateType |
class | TranscodingUser |
enum | VideoCodecProfileType |
Public Member Functions | |
int | addUser (TranscodingUser user) |
final ArrayList< TranscodingUser > | getUsers () |
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 |
VideoCodecProfileType | videoCodecProfile |
int | userCount |
int | backgroundColor |
String | userConfigExtraInfo |
String | metadata |
A class for managing user-specific CDN live audio/video transcoding settings.
int io.agora.rtc.live.LiveTranscoding.addUser | ( | TranscodingUser | user | ) |
Adds a user displaying the video in CDN live.
user | transcodingUser. |
final ArrayList<TranscodingUser> io.agora.rtc.live.LiveTranscoding.getUsers | ( | ) |
Retrieves 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.
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.
users | All users involved in CDN live. |
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.
users | All users involved in CDN live. |
int io.agora.rtc.live.LiveTranscoding.removeUser | ( | int | uid | ) |
Removes a user from CDN live.
uid | User ID of the user to remove from CDN live. |
int io.agora.rtc.live.LiveTranscoding.getUserCount | ( | ) |
Retrieves the number of users transcoded in CDN live.
int io.agora.rtc.live.LiveTranscoding.getBackgroundColor | ( | ) |
Retrieves the background color in hex.
void io.agora.rtc.live.LiveTranscoding.setBackgroundColor | ( | int | color | ) |
Sets the background color of the CDN live stream in the format of RGB hex.
color | Background color to set in RGB hex value. Value only, do not include a #. |
void io.agora.rtc.live.LiveTranscoding.setBackgroundColor | ( | int | red, |
int | green, | ||
int | blue | ||
) |
Sets the background color in RGB format.
red | Red component. |
green | Green component. |
blue | Blue component. |
int io.agora.rtc.live.LiveTranscoding.getRed | ( | ) |
int io.agora.rtc.live.LiveTranscoding.getGreen | ( | ) |
int io.agora.rtc.live.LiveTranscoding.getBlue | ( | ) |
void io.agora.rtc.live.LiveTranscoding.setRed | ( | int | red | ) |
void io.agora.rtc.live.LiveTranscoding.setGreen | ( | int | green | ) |
void io.agora.rtc.live.LiveTranscoding.setBlue | ( | int | blue | ) |
int io.agora.rtc.live.LiveTranscoding.width |
Width of the video. The default value is 360.
int io.agora.rtc.live.LiveTranscoding.height |
Height of the video. The default value is 640.
int io.agora.rtc.live.LiveTranscoding.videoBitrate |
Bitrate of the CDN live output video stream. The default value is 400 Kbps.
int io.agora.rtc.live.LiveTranscoding.videoFramerate |
Frame rate of the CDN live output video stream. The default value is 15 fps.
boolean io.agora.rtc.live.LiveTranscoding.lowLatency |
Latency mode:
int io.agora.rtc.live.LiveTranscoding.videoGop |
Gop of the video frames in the CDN live stream. The default value is 30 fps.
AgoraImage io.agora.rtc.live.LiveTranscoding.watermark |
The watermark image added to the CDN live publishing stream. Once a watermark image is added, the audience of the CDN live publishing stream can see it. See Agora Image.
AgoraImage io.agora.rtc.live.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 Agora Image.
AudioSampleRateType io.agora.rtc.live.LiveTranscoding.audioSampleRate |
Self-defined audio-sample rate: AudioSampleRateType.
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.
int io.agora.rtc.live.LiveTranscoding.audioChannels |
Agora’s self-defined audio channel type. Agora recommends choosing 1 or 2. Special players are required if you choose 3, 4 or 5:
VideoCodecProfileType io.agora.rtc.live.LiveTranscoding.videoCodecProfile |
Video codec profile type: VideoCodecProfileType.
int io.agora.rtc.live.LiveTranscoding.userCount |
Number of users in the live broadcast.
int io.agora.rtc.live.LiveTranscoding.backgroundColor |
Sets the background color.
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.
String io.agora.rtc.live.LiveTranscoding.metadata |
The metadata sent to the CDN live client.