enum  AudioCodecProfileType
 
enum  AudioSampleRateType
 
class  TranscodingUser
 
enum  VideoCodecProfileType
 

Public 成员函数

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 属性

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
 

详细描述

LiveTranscoding 定义直播转码的相关配置。

成员函数说明

◆ addUser()

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

添加一个用户到已有的用户中。

参数
user参数合图的用户,定义详见 transcodingUser
返回
  • 0:方法调用成功
  • < 0:方法调用失败

◆ getUsers()

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

批量获取用户。

该方法用于获取参与合图的全部用户。该方法返回的用户列表为只读,开发者不应该修改该数据。

返回
用户列表。

◆ setUsers() [1/2]

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

批量设置用户。

该方法用户设置参与合图的全部用户。该方法会使用新的 User 数据替换原有的数据。

参数
users所有参与合图的用户,定义详见 TranscodingUser

◆ setUsers() [2/2]

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

批量设置用户。

该方法用于设置参与合图的全部用户。该方法会使用新的 User 数据替换原有的数据。

参数
users所有参与合图的用户,定义详见 TranscodingUser

◆ removeUser()

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

删除转码合图用户。

参数
uid待删除的用户 ID
返回
  • 0:方法调用成功
  • < 0:方法调用失败

◆ 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 
)

设置背景色 RGB。

参数
red
green绿
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,否则 Agora 会调整为 64。
  • 如果推音频流,请将 widthheight 设为 0。

◆ height

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

推流视频的总高度,默认值 640,单位为像素。

  • 如果推视频流,height 值不得低于 64,否则 Agora 会调整为 64。
  • 如果推音频流,请将 widthheight 设为 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

用于旁路直播的输出视频上的水印图片,必须为 PNG 格式。添加后所有旁路直播的观众都可以看到水印。水印图片的定义详见 AgoraImage

◆ backgroundImage

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

用于旁路直播的输出视频上的背景图片。添加后所有旁路直播的观众都可以看到背景图片。背景图片的定义详见 AgoraImage

◆ audioSampleRate

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

用于旁路直播的输出音频的采样率。详见 AudioSampleRateType

◆ 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

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

用于旁路直播的输出音频的编解码规格:AudioCodecProfileType。可以设置为 LC-AAC 或 HE-AAC,默认值为 LC-AAC。

◆ videoCodecProfile

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

用于旁路直播的输出视频的编解码规格:VideoCodecProfileType。可以设置为 BASELINE、MAIN 或 HIGH;如果设置其他值,服务端会统一设为默认值 HIGH。

◆ userCount

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

获取旁路直播中的用户人数。

弃用:
该参数已废弃。声网不建议你使用。如果你希望获取旁路直播中的用户人数,请改用 getUserCount 方法。

◆ backgroundColor

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

设置旁路直播的背景颜色。

弃用:
该参数已废弃。声网不建议你使用。如果你希望设置旁路直播的背景颜色,请改用 setBackgroundColor

◆ userConfigExtraInfo

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

预留参数。 用户自定义的发送到旁路推流客户端的信息,用于填充 H264/H265 视频中 SEI 帧内容。长度限制:4096字节。关于 SEI 的详细信息,详见 SEI 帧相关问题

◆ metadata

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

发送给 CDN 客户端的 metadata。

弃用:
该参数已废弃。