文档中心
互动直播 (Legacy)
API 参考
Agora Java API Reference for Android
Agora Java API Reference for Android
◆ addWatermark()
void io.agora.rtc.live.LiveTranscoding.addWatermark |
( |
AgoraImage |
watermark | ) |
|
添加水印。
- 自从
- v3.6.0
该方法每次只能添加一个水印,如果你需要添加多个水印,则需多次调用该方法。
水印和背景图的总数量需大于等于 0 且小于等于 10。
- 参数
-
◆ removeWatermark()
boolean io.agora.rtc.live.LiveTranscoding.removeWatermark |
( |
AgoraImage |
watermark | ) |
|
从水印列表中删除一个水印。
- 自从
- v3.6.0
该方法每次只能删除一个水印,如果你需要删除多个水印,则需多次调用该方法。
- 参数
-
- 返回
- 是否成功删除水印:
◆ getWatermarkList()
ArrayList<AgoraImage> io.agora.rtc.live.LiveTranscoding.getWatermarkList |
( |
| ) |
|
◆ addBackgroundImage()
void io.agora.rtc.live.LiveTranscoding.addBackgroundImage |
( |
AgoraImage |
backgroundImage | ) |
|
添加背景图。
- 自从
- v3.6.0
该方法每次只能添加一张背景图,如果你需要添加多张背景图,则需多次调用该方法。
水印和背景图的总数量需大于等于 0 且小于等于 10。
- 参数
-
backgroundImage | 直播视频上的背景图。必须为 PNG 格式。详见 AgoraImage。 |
◆ removeBackgroundImage()
boolean io.agora.rtc.live.LiveTranscoding.removeBackgroundImage |
( |
AgoraImage |
backgroundImage | ) |
|
从背景图列表中删除一张背景图。
- 自从
- v3.6.0
该方法每次只能删除一张背景图,如果你需要删除多张背景图,则需多次调用该方法。
- 参数
-
backgroundImage | 直播视频上的背景图。必须为 PNG 格式。详见 AgoraImage。 |
- 返回
- 是否成功删除背景图:
◆ getBackgroundImageList()
ArrayList<AgoraImage> io.agora.rtc.live.LiveTranscoding.getBackgroundImageList |
( |
| ) |
|
获取背景图列表。
- 自从
- v3.6.0
- 返回
- 背景图列表。
◆ addUser()
◆ getUsers()
final ArrayList<TranscodingUser> io.agora.rtc.live.LiveTranscoding.getUsers |
( |
| ) |
|
批量获取用户。
该方法用于获取参与合图的全部用户。该方法返回的用户列表为只读,开发者不应该修改该数据。
- 返回
- 用户列表。
◆ setUsers() [1/2]
void io.agora.rtc.live.LiveTranscoding.setUsers |
( |
ArrayList< TranscodingUser > |
users | ) |
|
批量设置用户。
该方法用于设置参与合图的全部用户。该方法会使用新的 User 数据替换原有的数据。
- 参数
-
◆ setUsers() [2/2]
void io.agora.rtc.live.LiveTranscoding.setUsers |
( |
Map< Integer, TranscodingUser > |
users | ) |
|
批量设置用户。
该方法用于设置参与合图的全部用户。该方法会使用新的 User 数据替换原有的数据。
- 参数
-
◆ removeUser()
int io.agora.rtc.live.LiveTranscoding.removeUser |
( |
int |
uid | ) |
|
◆ getUserCount()
int io.agora.rtc.live.LiveTranscoding.getUserCount |
( |
| ) |
|
获取转码合图用户人数。
- 返回
- 参与转码合图的用户人数
◆ getBackgroundColor()
int io.agora.rtc.live.LiveTranscoding.getBackgroundColor |
( |
| ) |
|
获取背景颜色。
- 返回
- 背景颜色,格式为 RGB 的 Hex
◆ setBackgroundColor() [1/2]
void io.agora.rtc.live.LiveTranscoding.setBackgroundColor |
( |
int |
color | ) |
|
设置背景色。
- 参数
-
color | 用于旁路直播的输出视频的背景色,格式为 RGB 定义下的 Hex 值,不要带 # 号,如 0xFFB6C1 表示浅粉色。默认0x000000,黑色。 |
◆ setBackgroundColor() [2/2]
void io.agora.rtc.live.LiveTranscoding.setBackgroundColor |
( |
int |
red, |
|
|
int |
green, |
|
|
int |
blue |
|
) |
| |
◆ getRed()
int io.agora.rtc.live.LiveTranscoding.getRed |
( |
| ) |
|
◆ getGreen()
int io.agora.rtc.live.LiveTranscoding.getGreen |
( |
| ) |
|
◆ getBlue()
int io.agora.rtc.live.LiveTranscoding.getBlue |
( |
| ) |
|
◆ setRed()
void io.agora.rtc.live.LiveTranscoding.setRed |
( |
int |
red | ) |
|
◆ setGreen()
void io.agora.rtc.live.LiveTranscoding.setGreen |
( |
int |
green | ) |
|
◆ setBlue()
void io.agora.rtc.live.LiveTranscoding.setBlue |
( |
int |
blue | ) |
|
◆ width
int io.agora.rtc.live.LiveTranscoding.width |
推流视频的总宽度,默认值 360,单位为像素。
- 如果推视频流,
width
取值范围为 [64,1920]。如果取值低于 64,Agora 服务器会自动调整为 64;如果取值高于 1920,Agora 服务器会自动调整为 1920。
- 如果推音频流,请将
width
和 height
设为 0。
◆ height
int io.agora.rtc.live.LiveTranscoding.height |
推流视频的总高度,默认值 640,单位为像素。
- 如果推视频流,
height
取值范围为 [64,1080]。如果取值低于 64,Agora 服务器会自动调整为 64;如果取值高于 1080,Agora 服务器会自动调整为 1080。
- 如果推音频流,请将
width
和 height
设为 0。
◆ videoBitrate
int io.agora.rtc.live.LiveTranscoding.videoBitrate |
推流视频的码率,单位为 Kbps,默认值为 400 Kbps。用户可以根据 码率参考表 中的码率值进行设置;如果设置的码率超出合理范围,Agora 服务器会在合理区间内自动调整码率值。
◆ videoFramerate
int io.agora.rtc.live.LiveTranscoding.videoFramerate |
推流视频的帧率,单位为 fps,取值范围为 (0, 30],默认值为 15 fps。服务器会将高于 30 的帧率设置改为 30。
◆ lowLatency
boolean io.agora.rtc.live.LiveTranscoding.lowLatency |
- 弃用:
- 从 v2.8.0 起废弃。Agora 不推荐使用。
是否启用低延时模式:
-
true:低延时,不保证画质
-
false:(默认值)高延时,保证画质
◆ videoGop
int io.agora.rtc.live.LiveTranscoding.videoGop |
用于旁路直播的输出视频的 GOP,单位为帧。默认值为 30 帧。
◆ watermark
AgoraImage io.agora.rtc.live.LiveTranscoding.watermark |
◆ backgroundImage
AgoraImage io.agora.rtc.live.LiveTranscoding.backgroundImage |
◆ audioSampleRate
◆ audioBitrate
int io.agora.rtc.live.LiveTranscoding.audioBitrate |
用于旁路直播的输出音频的码率。单位为 Kbps,默认值为 48,最大值为 128。
◆ audioChannels
int io.agora.rtc.live.LiveTranscoding.audioChannels |
用于旁路直播的输出音频的声道数,取值范围为 [1, 5] 中的整型,默认值为 1。建议取 1 或 2,其余三个选项需要特殊播放器支持:
-
1:单声道
-
2:双声道
-
3:三声道
-
4:四声道
-
5:五声道
◆ audioCodecProfile
◆ videoCodecProfile
◆ videoCodecType
◆ userCount
int io.agora.rtc.live.LiveTranscoding.userCount |
获取旁路直播中的用户人数,取值范围为 [0,17]。
- 弃用:
- 该参数已废弃。声网不建议你使用。如果你希望获取旁路直播中的用户人数,请改用 getUserCount 方法。
◆ backgroundColor
int io.agora.rtc.live.LiveTranscoding.backgroundColor |
◆ userConfigExtraInfo
String io.agora.rtc.live.LiveTranscoding.userConfigExtraInfo |
预留参数。 用户自定义的发送到旁路推流客户端的信息,用于填充 H264/H265 视频中 SEI 帧内容。长度限制:4096字节。关于 SEI 的详细信息,详见 SEI 帧相关问题。
◆ metadata
String io.agora.rtc.live.LiveTranscoding.metadata |
发送给 CDN 客户端的 metadata。
- 弃用:
- 该参数已废弃。