Agora Java API Reference for Android
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 |
Detailed Description
A class for managing user-specific CDN live audio/video transcoding settings.
Member Function Documentation
◆ addUser()
| int io.agora.rtc.live.LiveTranscoding.addUser | ( | TranscodingUser | user | ) |
Adds a user displaying the video in the CDN live.
- Parameters
-
user transcodingUser.
- Returns
- 0: Success.
- <0: Failure.
◆ getUsers()
| final ArrayList<TranscodingUser> io.agora.rtc.live.LiveTranscoding.getUsers | ( | ) |
Retrieves the user list in the CDN live.
This method retrieves all users in the 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 the CDN live.
This method sets all the users involved in the CDN streaming. This method replaces the old user data with the new user data.
- Parameters
-
users All the users involved in the CDN live.
◆ setUsers() [2/2]
| void io.agora.rtc.live.LiveTranscoding.setUsers | ( | Map< Integer, TranscodingUser > | users | ) |
Sets the users in batches in the CDN live. This method sets all the users involved in the CDN live. This method replaces the old user data with the the new user data.
- Parameters
-
users All the users involved in the CDN live.
◆ removeUser()
| int io.agora.rtc.live.LiveTranscoding.removeUser | ( | int | uid | ) |
Removes a user from the CDN live.
- Parameters
-
uid User ID of the user to remove from the CDN live.
- Returns
- 0: Success.
- < 0: Failure.
◆ getUserCount()
| int io.agora.rtc.live.LiveTranscoding.getUserCount | ( | ) |
Retrieves the number of users transcoded in the CDN live.
- Returns
- Number of users transcoded in the CDN live.
◆ getBackgroundColor()
| int io.agora.rtc.live.LiveTranscoding.getBackgroundColor | ( | ) |
Retrieves 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 streaming in the format of RGB hex.
- Parameters
-
color Background color to set in RGB hex value. Value only, do not include a #.
◆ setBackgroundColor() [2/2]
| void io.agora.rtc.live.LiveTranscoding.setBackgroundColor | ( | int | red, |
| int | green, | ||
| int | blue | ||
| ) |
Sets the background color in RGB format.
- Parameters
-
red Red component green Green component blue Blue component
◆ getRed()
| int io.agora.rtc.live.LiveTranscoding.getRed | ( | ) |
- Deprecated:
- Retrieves the background color's red component.
- Returns
- Background color's red component.
◆ getGreen()
| int io.agora.rtc.live.LiveTranscoding.getGreen | ( | ) |
- Deprecated:
- Retrieves the background color's green component.
- Returns
- Background color's green component.
◆ getBlue()
| int io.agora.rtc.live.LiveTranscoding.getBlue | ( | ) |
- Deprecated:
- Retrieves 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 |
Width of the video. The default value is 360.
◆ height
| int io.agora.rtc.live.LiveTranscoding.height |
Height of the video. The default value is 640.
◆ videoBitrate
| int io.agora.rtc.live.LiveTranscoding.videoBitrate |
Bitrate of the CDN live output video stream. The default value is 400 Kbps.
◆ videoFramerate
| int io.agora.rtc.live.LiveTranscoding.videoFramerate |
Frame rate of the CDN live output video stream. The default value is 15 fps.
◆ lowLatency
| boolean io.agora.rtc.live.LiveTranscoding.lowLatency |
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 on the CDN streaming. The default value is 30 fps.
◆ watermark
| AgoraImage io.agora.rtc.live.LiveTranscoding.watermark |
The watermark image added to the CDN publishing stream. Once a watermark image is added, the audience of the CDN publishing stream can see it. See detailed descriptions in Agora Image.
◆ backgroundImage
| AgoraImage io.agora.rtc.live.LiveTranscoding.backgroundImage |
The background image added to the CDN publishing stream. Once a background image is added, the audience of the CDN publishing stream can see it. See detailed descriptions in Agora Image.
◆ audioSampleRate
| AudioSampleRateType io.agora.rtc.live.LiveTranscoding.audioSampleRate |
Self-defined audio-sampling 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 |
Agora’s self-defined audio channel type. Agora recommends choosing 1 or 2. Special players are required if you choose 3, 4 or 5:
- 1: (Default) Mono
- 2: Two-channel stereo
- 3: Three-channel stereo
- 4: Four-channel stereo
- 5: Five-channel stereo
◆ videoCodecProfile
| VideoCodecProfileType io.agora.rtc.live.LiveTranscoding.videoCodecProfile |
Video codec profile type: VideoCodecProfileType
◆ userCount
| int io.agora.rtc.live.LiveTranscoding.userCount |
Number of users in the live broadcast.
- Deprecated:
- This parameter is deprecated. Agora recommends using getUserCount.
◆ backgroundColor
| int io.agora.rtc.live.LiveTranscoding.backgroundColor |
Sets the background color.
- Deprecated:
- This parameter is deprecated. Agora recommends using setBackgroundColor to set the background color.
◆ userConfigExtraInfo
| String io.agora.rtc.live.LiveTranscoding.userConfigExtraInfo |
Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client.
◆ metadata
| String io.agora.rtc.live.LiveTranscoding.metadata |
The metadata sent to the CDN client.
