LiteAVSDK
腾讯云音视频 SDK ,服务于数万家企业客户的高可用组件,致力于最大限度地节省您的研发成本。
关键类型定义

详细描述

腾讯云视频通话功能的关键类型定义


结构体说明

◆ TRTCParams

class TRTCParams

Public 成员函数

 TRTCParams ()
 
 TRTCParams (int sdkAppId, String userId, String userSig, int roomId, String privateMapKey, String businessInfo)
 
 TRTCParams (TRTCParams original)
 

成员变量

int sdkAppId = 0
 
String userId = ""
 
String userSig = ""
 
int roomId = 0
 
int role = TRTCCloudDef.TRTCRoleAnchor
 
String streamId
 
String userDefineRecordId
 
String privateMapKey = ""
 
String businessInfo = ""
 

构造及析构函数说明

◆ TRTCParams() [1/3]

TRTCParams ( )
inline

◆ TRTCParams() [2/3]

TRTCParams ( int  sdkAppId,
String  userId,
String  userSig,
int  roomId,
String  privateMapKey,
String  businessInfo 
)
inline

◆ TRTCParams() [3/3]

TRTCParams ( TRTCParams  original)
inline

结构体成员变量说明

◆ sdkAppId

int sdkAppId = 0

【字段含义】应用标识 [必填],腾讯视频云基于 sdkAppId 进行计费统计。
【推荐取值】在 实时音视频控制台 创建应用后可以在账号信息页面中得到该 ID

◆ userId

String userId = ""

【字段含义】用户标识 [必填],当前用户的 userId,相当于用户名。
【推荐取值】限制长度为32字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。

◆ userSig

String userSig = ""

【字段含义】用户签名 [必填],当前 userId 对应的验证签名,相当于使用云服务的登录密码。
【推荐取值】具体计算方法请参见 如何计算UserSig

◆ roomId

int roomId = 0

【字段含义】房间号码 [必填] ,在同一个房间里的用户(userId)可以彼此看到对方并进行视频通话
【推荐取值】取值范围:1 - 4294967294。

◆ role

【字段含义】直播场景下的角色,SDK 用这个参数确定用户是主播还是观众[直播场景下必填,通话场景下不填写]。
【特别说明】仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM),通话场景(AUDIOCALL 和 VIDEOCALL)下指定无效。
【推荐取值】默认值:主播(TRTCRoleAnchor)

◆ streamId

String streamId

【字段含义】绑定腾讯云直播 CDN 流 ID[非必填],设置之后,您就可以在腾讯云直播 CDN 上通过标准直播方案(FLV或HLS)播放该用户的音视频流。
【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 “sdkappid_roomid_userid_main” 作为 streamid,这样比较好辨认且不会在您的多个应用中发生冲突。
【特殊说明】要使用腾讯云直播 CDN,您需要先在控制台 中的功能配置页开启“启动自动旁路直播”开关。
【参考文档】CDN 旁路直播

◆ userDefineRecordId

String userDefineRecordId

【字段含义】云端录制开关,用于指定是否要在云端将该用户的音视频流录制成指定格式的文件。 方案一:手动录制

  • 需要在“控制台 => 应用管理 => 云端录制配置”中开启云端录制。
  • 设置“录制形式”为“手动录制”。
  • 设置手动录制后,在一个 TRTC 房间中只有设置了 userDefineRecordId 参数的用户才会在云端录制出视频文件,不指定该参数的用户不会产生录制行为。
  • 文件会以 “userDefineRecordId_起始时间_结束时间” 的格式命名。

方案二:自动录制

  • 需要在“控制台 => 应用管理 => 云端录制配置”中开启云端录制。
  • 设置“录制形式”为“自动录制”。
  • 设置自动录制后,在一个 TRTC 房间中的任何一个有音视频上行的用户,均会在云端录制出视频文件。
  • 文件会以 “userDefineRecordId_起始时间_结束时间” 的格式命名,如果不指定 userDefineRecordId,则文件会以 streamid 命名。


【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
【参考文档】云端录制

◆ privateMapKey

String privateMapKey = ""

【字段含义】房间签名 [非必填],当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。
【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 进房权限保护

◆ businessInfo

String businessInfo = ""

业务数据 [非必填] 某些非常用的特殊需求才需要用到此字段。
【推荐取值】不建议使用

◆ TRTCVideoEncParam

class TRTCVideoEncParam
成员变量
int videoResolution

【字段含义】 视频分辨率
【推荐取值】

  • 视频通话建议选择360 × 640及以下分辨率,resMode 选择 Portrait。
  • 手机直播建议选择540 × 960,resMode 选择 Portrait。
  • Window 和 iMac 建议选择640 × 360及以上分辨率,resMode 选择 Landscape。
    【特别说明】 TRTCVideoResolution 默认只能横屏模式的分辨率,例如640 × 360。 如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如640 × 360结合 Portrait 则为360 × 640。
int videoResolutionMode

【字段含义】分辨率模式(横屏分辨率 - 竖屏分辨率)
【推荐取值】手机直播建议选择 Portrait,Window 和 Mac 建议选择 Landscape。
【特别说明】如果 videoResolution 指定分辨率640 × 360,resMode 指定模式为 Portrait,则最终编码出的分辨率为360 × 640。

int videoFps

【字段含义】视频采集帧率
【推荐取值】15fps或20fps,5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,则过于浪费(电影的帧率为24fps)。
【特别说明】很多 Android 手机的前置摄像头并不支持15fps以上的采集帧率,部分过于突出美颜功能的 Android 手机前置摄像头的采集帧率可能低于10fps。

int videoBitrate

【字段含义】目标视频码率,SDK 会按照目标码率进行编码,只有在网络不佳的情况下才会主动降低视频码率。
【推荐取值】请参考本 TRTCVideoResolution 在各档位注释的最佳码率,也可以在此基础上适当调高。 比如 TRTC_VIDEO_RESOLUTION_1280_720 对应 1200kbps 的目标码率,您也可以设置为 1500kbps 用来获得更好的清晰度观感。
【特别说明】SDK 会努力按照 videoBitrate 指定的码率进行编码,只有在网络不佳的情况下才会主动降低视频码率,最低会降至 minVideoBitrate 所设定的数值。 如果您追求“允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60; 如果您追求“允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为 200kbps; 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 的自适应调节能力。

int minVideoBitrate

【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率,最低会降至 minVideoBitrate 所设定的数值。
【推荐取值】

  • 如果您追求“允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60;
  • 如果您追求“允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为 200kbps;
  • 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 的自适应调节能力;
  • 默认值:0,此时最低码率由 SDK 根据分辨率情况,自动设置合适的数值。
    【特别说明】
  • 当您把分辨率设置的比较高时,minVideoBitrate 不适合设置的太低,否则会出现画面模糊和大范围的马赛克宏块。 比如把分辨率设置为 720p,把码率设置为 200kbps,那么编码出的画面将会出现大范围区域性马赛克。
boolean enableAdjustRes

【字段含义】是否允许调整分辨率
【推荐取值】

  • 手机直播建议选择 false。
  • 视频通话模式,若更关注流畅性,建议选择 true,此时若遇到带宽有限的弱网,SDK 会自动降低分辨率以保障更好的流畅度(仅针对 TRTCVideoStreamTypeBig 生效)。
  • 默认值:false。
    【特别说明】若有录制需求,选择 true 时,请确保通话过程中,调整分辨率不会影响您的录制效果。

◆ TRTCNetworkQosParam

class TRTCNetworkQosParam
成员变量
int preference

【字段含义】弱网下选择“保清晰”或“保流畅”
【特别说明】

  • 弱网下保流畅:在遭遇弱网环境时,画面会变得模糊,且出现较多马赛克,但可以保持流畅不卡顿
  • 弱网下保清晰:在遭遇弱网环境时,画面会尽可能保持清晰,但可能会更容易出现卡顿
int controlMode

【字段含义】视频分辨率(云端控制 - 客户端控制)
【推荐取值】云端控制
【特别说明】

  • Server 模式(默认):云端控制模式,若没有特殊原因,请直接使用该模式
  • Client 模式:客户端控制模式,用于 SDK 开发内部调试,客户请勿使用

◆ TRTCQuality

class TRTCQuality
成员变量
String userId 用户 ID
int quality 网络质量,定义参见 视频(或网络)质量常量定义

◆ TRTCTexture

class TRTCTexture
成员变量
int textureId 视频纹理 ID
egl eglContext10 使用 (javax.microedition.khronos.egl.*) 定义的 OpenGL 接口
opengl eglContext14 使用 (android.opengl.*) 定义的 OpenGL 接口

◆ TRTCVideoFrame

class TRTCVideoFrame
成员变量
int pixelFormat

【字段含义】视频像素格式,定义参见视频像素格式
【推荐取值】自定义采集:TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 或 TRTC_VIDEO_PIXEL_FORMAT_NV21;自定义渲染:TRTC_VIDEO_PIXEL_FORMAT_I420。

int bufferType

【字段含义】视频数据包装格式,定义参见视频数据包装格式
【推荐取值】自定义采集:TRTC_VIDEO_BUFFER_TYPE_TEXTURE;自定义渲染:TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER 或 TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY

TRTCTexture texture 【字段含义】bufferType 为 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 时的视频数据。
byte[] data 【字段含义】bufferType 为 TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY 时的视频数据。
ByteBuffer buffer 【字段含义】bufferType 为 TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER 时的视频数据,主要在 native 层使用。
int width

【字段含义】视频宽度
【推荐取值】请严格填写传入视频数据的宽度

int height

【字段含义】视频高度
【推荐取值】请严格填写传入视频数据的高度

long timestamp

【字段含义】视频帧的时间戳,单位毫秒
【推荐取值】自定义视频采集时可以填0,这样 SDK 会自定填充 timestamp 字段,但请“均匀”地控制 sendCustomVideoData 的调用间隔。

int rotation

【字段含义】视频像素的顺时针旋转角度
【推荐取值】自定义视频采集时不需要填写。

◆ TRTCAudioFrame

class TRTCAudioFrame
成员变量
byte[] data 音频数据
int sampleRate 采样率
int channel 声道数
long timestamp 时间戳

◆ TRTCVolumeInfo

class TRTCVolumeInfo
成员变量
String userId 说话者的 userId, 空则为自己
int volume 说话者的音量, 取值范围0 - 100

◆ TRTCSpeedTestResult

class TRTCSpeedTestResult

Public 成员函数

String toString ()
 

成员变量

String ip
 
int quality
 
float upLostRate
 
float downLostRate
 
int rtt
 

成员函数说明

◆ toString()

String toString ( )
inline

结构体成员变量说明

◆ ip

String ip

服务器 IP 地址

◆ quality

int quality

网络质量,内部通过评估算法测算出的网络质量,loss 越低,rtt 越小,得分便越高。

◆ upLostRate

float upLostRate

上行丢包率,范围是0 - 1.0,例如,0.3代表每向服务器发送10个数据包,可能有3个会在中途丢失。

◆ downLostRate

float downLostRate

下行丢包率,范围是0 - 1.0,例如,0.2表示每从服务器收取10个数据包可能会在中途丢失2个。

◆ rtt

int rtt

延迟(毫秒),指当前设备到腾讯云服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms

◆ TRTCMixUser

class TRTCMixUser

Public 成员函数

 TRTCMixUser ()
 
 TRTCMixUser (String userId, int x, int y, int width, int height, int zOrder)
 
 TRTCMixUser (TRTCMixUser original)
 
String toString ()
 

成员变量

String userId
 
String roomId
 
int x
 
int y
 
int width
 
int height
 
int zOrder
 
int streamType
 
boolean pureAudio
 

构造及析构函数说明

◆ TRTCMixUser() [1/3]

TRTCMixUser ( )
inline

◆ TRTCMixUser() [2/3]

TRTCMixUser ( String  userId,
int  x,
int  y,
int  width,
int  height,
int  zOrder 
)
inline

◆ TRTCMixUser() [3/3]

TRTCMixUser ( TRTCMixUser  original)
inline

成员函数说明

◆ toString()

String toString ( )
inline

结构体成员变量说明

◆ userId

String userId

参与混流的 userId

◆ roomId

String roomId

参与混流的 userId 所在roomId,null表示当前房间

◆ x

int x

图层位置 x 坐标(绝对像素值)

◆ y

int y

图层位置 y 坐标(绝对像素值)

◆ width

int width

图层位置宽度(绝对像素值)

◆ height

int height

图层位置高度(绝对像素值)

◆ zOrder

int zOrder

图层层次(1 - 15)不可重复

◆ streamType

int streamType

参与混合的是主路画面(TRTC_VIDEO_STREAM_TYPE_BIG,默认)或屏幕分享(TRTC_VIDEO_STREAM_TYPE_SUB)画面

◆ pureAudio

boolean pureAudio

该用户是不是只开启了音频

◆ TRTCTranscodingConfig

class TRTCTranscodingConfig

Public 成员函数

 TRTCTranscodingConfig ()
 
 TRTCTranscodingConfig (TRTCTranscodingConfig original)
 
String toString ()
 

成员变量

int appId
 
int bizId
 
int mode
 
int videoWidth
 
int videoHeight
 
int videoBitrate
 
int videoFramerate
 
int videoGOP
 
int backgroundColor
 
String backgroundImage
 
int audioSampleRate
 
int audioBitrate
 
int audioChannels
 
ArrayList< TRTCMixUsermixUsers
 
String streamId
 

构造及析构函数说明

◆ TRTCTranscodingConfig() [1/2]

◆ TRTCTranscodingConfig() [2/2]

成员函数说明

◆ toString()

String toString ( )
inline

结构体成员变量说明

◆ appId

int appId

【字段含义】腾讯云直播 AppID
【推荐取值】请在 实时音视频控制台 选择已经创建的应用,单击【帐号信息】后,在“直播信息”中获取

◆ bizId

int bizId

【字段含义】腾讯云直播 bizid
【推荐取值】请在 实时音视频控制台 选择已经创建的应用,单击【帐号信息】后,在“直播信息”中获取

◆ mode

int mode

【字段含义】转码config模式

◆ videoWidth

int videoWidth

【字段含义】最终转码后的视频分辨率的宽度。
【推荐取值】推荐值:360px,如果你是纯音频推流,请将 width × height 设为 0px × 0px,否则混流后会携带一条画布背景的视频流。

◆ videoHeight

int videoHeight

【字段含义】最终转码后的视频分辨率的高度。
【推荐取值】推荐值:640px,如果你是纯音频推流,请将 width × height 设为 0px × 0px,否则混流后会携带一条画布背景的视频流。

◆ videoBitrate

int videoBitrate

【字段含义】最终转码后的视频分辨率的码率(kbps)。
【推荐取值】如果填0,后台会根据 videoWidth 和 videoHeight 来估算码率,您也可以参考枚举定义 TRTC_VIDEO_RESOLUTION_640_480 的注释。

◆ videoFramerate

int videoFramerate

【字段含义】最终转码后的视频分辨率的帧率(FPS)。
【推荐取值】默认值:15fps,取值范围是 (0,30]。

◆ videoGOP

int videoGOP

【字段含义】最终转码后的视频分辨率的关键帧间隔(又称为 GOP)。
【推荐取值】默认值:2,单位为秒,取值范围是 [1,8]。

◆ backgroundColor

int backgroundColor

【字段含义】混合后画面的底色颜色,默认为黑色,格式为十六进制数字,比如:“0x61B9F1” 代表 RGB 分别为(97,158,241)。
【推荐取值】默认值:0x000000,黑色

◆ backgroundImage

String backgroundImage

【字段含义】混合后画面的背景图。
【推荐取值】默认值:null,即不设置背景图
【特别说明】背景图需要您事先在 “控制台 => 应用管理 => 功能配置 => 素材管理” 中上传,
上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置到 backgroundImage 里即可。
例如:假设“图片ID” 为 63,可以设置 backgroundImage = "63";

◆ audioSampleRate

int audioSampleRate

【字段含义】最终转码后的音频采样率。
【推荐取值】默认值:48000Hz。支持12000HZ、16000HZ、22050HZ、24000HZ、32000HZ、44100HZ、48000HZ。

◆ audioBitrate

int audioBitrate

【字段含义】最终转码后的音频码率。
【推荐取值】默认值:64kbps,取值范围是 [32,192]。

◆ audioChannels

int audioChannels

【字段含义】最终转码后的音频声道数
【推荐取值】默认值:1。取值范围为 [1,2] 中的整型。

◆ mixUsers

ArrayList<TRTCMixUser> mixUsers

【字段含义】每一路子画面的位置信息

◆ streamId

String streamId

【字段含义】输出到 CDN 上的直播流 ID 如不设置该参数,SDK 会执行默认逻辑,即房间里的多路流会混合到该接口调用者的视频流上,也就是 A+B =>A; 如果设置该参数,SDK 会将房间里的多路流混合到您指定的直播流 ID 上,也就是 A+B =>C。
【推荐取值】默认值:null,即房间里的多路流会混合到该接口调用者的视频流上。

◆ TRTCPublishCDNParam

class TRTCPublishCDNParam
成员变量
int appId 腾讯云 AppID,请在 实时音视频控制台 选择已经创建的应用,单击【帐号信息】,在“直播信息”中获取
int bizId 腾讯云直播 bizid,请在 实时音视频控制台 选择已经创建的应用,单击【帐号信息】,在“直播信息”中获取
String url 旁路转推的 URL

◆ TRTCAudioRecordingParams

class TRTCAudioRecordingParams
成员变量
String filePath

【字段含义】文件路径(必填),录音的文件地址,由用户自行指定,请确保 App 里指定的目录存在且可写。
【特别说明】该路径需精确到文件名及格式后缀,格式后缀决定录音文件的格式,目前支持的格式有 PCM、WAV 和 AAC。 例如,指定路径为 path/to/audio.aac,则会生成一个 AAC 格式的文件。 请指定一个有读写权限的合法路径,否则录音文件无法生成。

◆ TRTCAudioEffectParam

class TRTCAudioEffectParam

Public 成员函数

 TRTCAudioEffectParam (int effectId, String path)
 

成员变量

int effectId
 
String path
 
int loopCount
 
boolean publish
 
int volume
 

构造及析构函数说明

◆ TRTCAudioEffectParam()

TRTCAudioEffectParam ( int  effectId,
String  path 
)
inline

结构体成员变量说明

◆ effectId

int effectId

【字段含义】音效 ID 【特殊说明】SDK 允许播放多路音效,因此需要音效 ID 进行标记,用于控制音效的开始、停止、音量等

◆ path

String path

【字段含义】音效文件的绝对路径,支持的文件格式:aac, mp3。 【特殊说明】如果以/assets/开头表示音效文件放在应用asset目录下,如/assets/effect.aac

◆ loopCount

int loopCount

【字段含义】音效循环播放的次数 【推荐取值】取值范围为0 - 任意正整数,默认值:0。0表示播放音效一次;1表示播放音效两次;以此类推

◆ publish

boolean publish

【字段含义】是否将音效传到远端 【推荐取值】YES:音效在本地播放的同时,会上行至云端,因此远端用户也能听到该音效;NO:音效不会上行至云端,因此只能在本地听到该音效。默认值:NO

◆ volume

int volume

【字段含义】音效的音量大小 【推荐取值】取值范围为0 - 100;默认值:100

◆ TRTCScreenShareParams

class TRTCScreenShareParams
成员变量
View floatingView

【字段含义】可以通过此参数设置一个悬浮view。
从 Android 7.0 系统开始,对于没有做过任何保活的后台 App,很容易会被系统强杀掉。
当 App 出于屏幕分享状态时,不可避免的要被切到后台运行,此时如果能弹出悬浮窗,可以避免被系统强杀掉。
同时,在手机屏幕上显示悬浮窗,也有利于告知用户当前正在做屏幕分享,避免用户泄漏个人隐私。

【特殊说明】您也可以使用 Android 系统的 WindowsManager 接口达到同样的效果。

◆ TRTCCloudDef

class TRTCCloudDef

静态 Public 属性

static final String TRTC_SDK_VERSION = "0.0.0.0"
 

1.1 视频分辨率

此处仅定义横屏分辨率,如需使用竖屏分辨率(例如360 × 640),需要同时指定 TRTCVideoResolutionMode 为 Portrait。

static final int TRTC_VIDEO_RESOLUTION_120_120 = 1
 
static final int TRTC_VIDEO_RESOLUTION_160_160 = 3
 
static final int TRTC_VIDEO_RESOLUTION_270_270 = 5
 
static final int TRTC_VIDEO_RESOLUTION_480_480 = 7
 
static final int TRTC_VIDEO_RESOLUTION_160_120 = 50
 
static final int TRTC_VIDEO_RESOLUTION_240_180 = 52
 
static final int TRTC_VIDEO_RESOLUTION_280_210 = 54
 
static final int TRTC_VIDEO_RESOLUTION_320_240 = 56
 
static final int TRTC_VIDEO_RESOLUTION_400_300 = 58
 
static final int TRTC_VIDEO_RESOLUTION_480_360 = 60
 
static final int TRTC_VIDEO_RESOLUTION_640_480 = 62
 
static final int TRTC_VIDEO_RESOLUTION_960_720 = 64
 
static final int TRTC_VIDEO_RESOLUTION_160_90 = 100
 
static final int TRTC_VIDEO_RESOLUTION_256_144 = 102
 
static final int TRTC_VIDEO_RESOLUTION_320_180 = 104
 
static final int TRTC_VIDEO_RESOLUTION_480_270 = 106
 
static final int TRTC_VIDEO_RESOLUTION_640_360 = 108
 
static final int TRTC_VIDEO_RESOLUTION_960_540 = 110
 
static final int TRTC_VIDEO_RESOLUTION_1280_720 = 112
 
static final int TRTC_VIDEO_RESOLUTION_1920_1080 = 114
 

1.2 视频宽高比模式

- 横屏分辨率:TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360

  • 竖屏分辨率:TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640
static final int TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE = 0
 
static final int TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT = 1
 

1.3 视频流类型

TRTC 内部有三种不同的音视频流,分别是:

  • 主画面:最常用的一条线路,一般用来传输摄像头的视频数据。
  • 小画面:跟主画面的内容相同,但是分辨率和码率更低。
  • 辅流画面:一般用于屏幕分享,以及远程播片(例如老师放一段视频给学生)。
注意
  • 如果主播的上行网络和性能比较好,则可以同时送出大小两路画面。
  • SDK 不支持单独开启小画面,小画面必须依附于主画面而存在。
static final int TRTC_VIDEO_STREAM_TYPE_BIG = 0
 
static final int TRTC_VIDEO_STREAM_TYPE_SMALL = 1
 
static final int TRTC_VIDEO_STREAM_TYPE_SUB = 2
 

1.4 视频(或网络)质量常量定义

TRTC SDK 对画质定义了六种不同的级别,Excellent 代表最好,Down 代表不可用。

static final int TRTC_QUALITY_UNKNOWN = 0
 
static final int TRTC_QUALITY_Excellent = 1
 
static final int TRTC_QUALITY_Good = 2
 
static final int TRTC_QUALITY_Poor = 3
 
static final int TRTC_QUALITY_Bad = 4
 
static final int TRTC_QUALITY_Vbad = 5
 
static final int TRTC_QUALITY_Down = 6
 

1.5 视频画面填充模式

如果画面的显示分辨率不等于画面的原始分辨率,就需要您设置画面的填充模式:

  • TRTCVideoFillMode_Fill,图像铺满屏幕,超出显示视窗的视频部分将被裁剪,画面显示可能不完整。
  • TRTCVideoFillMode_Fit,图像长边填满屏幕,短边区域会被填充黑色,画面的内容完整。
static final int TRTC_VIDEO_RENDER_MODE_FILL = 0
 
static final int TRTC_VIDEO_RENDER_MODE_FIT = 1
 

1.6 视频画面旋转方向

TRTC SDK 提供了对本地和远程画面的旋转角度设置 API,下列的旋转角度都是指顺时针方向的。

static final int TRTC_VIDEO_ROTATION_0 = 0
 
static final int TRTC_VIDEO_ROTATION_90 = 1
 
static final int TRTC_VIDEO_ROTATION_180 = 2
 
static final int TRTC_VIDEO_ROTATION_270 = 3
 

1.7 美颜(磨皮)算法

TRTC SDK 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案。

static final int TRTC_BEAUTY_STYLE_SMOOTH = 0
 
static final int TRTC_BEAUTY_STYLE_NATURE = 1
 
static final int TRTC_BEAUTY_STYLE_PITU = 2
 

1.8 视频像素格式

TRTC SDK 提供针对视频的自定义采集和自定义渲染功能,在自定义采集功能中,您可以用下列枚举值描述您采集的视频像素格式。 在自定义渲染功能中,您可以指定您期望 SDK 回调的视频像素格式。

static final int TRTC_VIDEO_PIXEL_FORMAT_UNKNOWN = 0
 
static final int TRTC_VIDEO_PIXEL_FORMAT_I420 = 1
 
static final int TRTC_VIDEO_PIXEL_FORMAT_Texture_2D = 2
 
static final int TRTC_VIDEO_PIXEL_FORMAT_TEXTURE_EXTERNAL_OES = 3
 
static final int TRTC_VIDEO_PIXEL_FORMAT_NV21 = 4
 

1.9 本地视频画面预览镜像类型

TRTC SDK 提供了对本地预览画面的镜像设置功能,默认是AUTO类型。

static final int TRTC_VIDEO_MIRROR_TYPE_AUTO = 0
 
static final int TRTC_VIDEO_MIRROR_TYPE_ENABLE = 1
 
static final int TRTC_VIDEO_MIRROR_TYPE_DISABLE = 2
 

1.10 视频数据包装格式

在自定义采集和自定义渲染功能,您需要用到下列枚举值来指定您希望以什么类型的容器来包装视频数据。

static final int TRTC_VIDEO_BUFFER_TYPE_UNKNOWN = 0
 
static final int TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER = 1
 
static final int TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY = 2
 
static final int TRTC_VIDEO_BUFFER_TYPE_TEXTURE = 3
 

2.1 应用场景

TRTC 可用于视频会议和在线直播等多种应用场景,针对不同的应用场景,TRTC SDK 的内部会进行不同的优化配置:

  • TRTC_APP_SCENE_VIDEOCALL:视频通话场景,适合[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。
  • TRTC_APP_SCENE_LIVE:视频互动直播,适合[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。
  • TRTC_APP_SCENE_AUDIOCALL:语音通话场景,适合[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。
  • TRTC_APP_SCENE_VOICE_CHATROOM:语音互动直播,适合:[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。
static final int TRTC_APP_SCENE_VIDEOCALL = 0
 
static final int TRTC_APP_SCENE_LIVE = 1
 
static final int TRTC_APP_SCENE_AUDIOCALL = 2
 
static final int TRTC_APP_SCENE_VOICE_CHATROOM = 3
 

2.2 角色,仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM)

在直播场景中,多数用户仅为观众,个别用户是主播,这种角色区分有利于 TRTC 进行更好的定向优化。

  • Anchor:主播,可以上行视频和音频,一个房间里最多支持50个主播同时上行音视频。
  • Audience:观众,只能观看,不能上行视频和音频,一个房间里的观众人数没有上限。
static final int TRTCRoleAnchor = 20
 
static final int TRTCRoleAudience = 21
 

2.3 流控模式

TRTC SDK 内部需要时刻根据网络情况调整内部的编解码器和网络模块,以便能够对网络的变化做出反应。 为了支持快速算法升级,SDK 内部设置了两种不同的流控模式:

  • ModeServer:云端控制,默认模式,推荐选择。
  • ModeClient:本地控制,用于 SDK 开发内部调试,客户请勿使用。
注意
推荐您使用云端控制,这样每当我们升级 Qos 算法时,您无需升级 SDK 即可体验更好的效果。
static final int VIDEO_QOS_CONTROL_CLIENT = 0
 
static final int VIDEO_QOS_CONTROL_SERVER = 1
 

2.4 画质偏好

指当 TRTC SDK 在遇到弱网络环境时,您期望“保清晰”或“保流畅”,两种模式均会优先保障声音数据的传输。

  • Smooth:弱网下优先流畅性,当用户网络较差的时候画面也会比较模糊。
  • Clear:默认值,弱网下优先清晰度,当用户网络较差的时候会出现卡顿,但画面清晰度不会大幅缩水。
static final int TRTC_VIDEO_QOS_PREFERENCE_SMOOTH = 1
 
static final int TRTC_VIDEO_QOS_PREFERENCE_CLEAR = 2
 

3.1 音频采样率

音频采样率用来衡量声音的保真程度,采样率越高保真程度越好,如果您的应用场景有音乐的存在,推荐使用 TRTCAudioSampleRate48000。

static final int TRTCAudioSampleRate16000 = 16000
 
static final int TRTCAudioSampleRate32000 = 32000
 
static final int TRTCAudioSampleRate44100 = 44100
 
static final int TRTCAudioSampleRate48000 = 48000
 

3.2 声音音质

音频音质用来衡量声音的保真程度。

static final int TRTC_AUDIO_QUALITY_SPEECH = 1
 
static final int TRTC_AUDIO_QUALITY_DEFAULT = 2
 
static final int TRTC_AUDIO_QUALITY_MUSIC = 3
 

3.3 声音播放模式(音频路由)

微信和手机 QQ 里的视频通话功能,都有一个免提模式,开启后就不用把手机贴在耳朵上,这个功能就是基于音频路由实现的。 一般手机都有两个扬声器,设置音频路由的作用就是要决定声音从哪个扬声器播放出来:

  • Speakerphone:扬声器,位于手机底部,声音偏大,适合外放音乐。
  • Earpiece:听筒,位于手机顶部,声音偏小,适合通话。
static final int TRTC_AUDIO_ROUTE_SPEAKER = 0
 
static final int TRTC_AUDIO_ROUTE_EARPIECE = 1
 

3.4 声音混响模式

static final int TRTC_REVERB_TYPE_0 = 0
 
static final int TRTC_REVERB_TYPE_1 = 1
 
static final int TRTC_REVERB_TYPE_2 = 2
 
static final int TRTC_REVERB_TYPE_3 = 3
 
static final int TRTC_REVERB_TYPE_4 = 4
 
static final int TRTC_REVERB_TYPE_5 = 5
 
static final int TRTC_REVERB_TYPE_6 = 6
 
static final int TRTC_REVERB_TYPE_7 = 7
 

3.5 变声类型

static final int TRTC_VOICE_CHANGER_TYPE_0 = 0
 
static final int TRTC_VOICE_CHANGER_TYPE_1 = 1
 
static final int TRTC_VOICE_CHANGER_TYPE_2 = 2
 
static final int TRTC_VOICE_CHANGER_TYPE_3 = 3
 
static final int TRTC_VOICE_CHANGER_TYPE_4 = 4
 
static final int TRTC_VOICE_CHANGER_TYPE_5 = 5
 
static final int TRTC_VOICE_CHANGER_TYPE_6 = 6
 
static final int TRTC_VOICE_CHANGER_TYPE_7 = 7
 
static final int TRTC_VOICE_CHANGER_TYPE_8 = 8
 
static final int TRTC_VOICE_CHANGER_TYPE_9 = 9
 
static final int TRTC_VOICE_CHANGER_TYPE_10 = 10
 
static final int TRTC_VOICE_CHANGER_TYPE_11 = 11
 

3.6 音频帧的格式

static final int TRTC_AUDIO_FRAME_FORMAT_PCM = 1
 

3.7 系统音量类型

智能手机一般具备两种系统音量类型,即通话音量类型和媒体音量类型。

  • 通话音量:手机专门为通话场景设计的音量类型,使用手机自带的回声抵消功能,音质相比媒体音量类型较差, 无法通过音量按键将音量调成零,但是支持蓝牙耳机上的麦克风。
  • 媒体音量:手机专门为音乐场景设计的音量类型,音质相比于通话音量类型要好,通过通过音量按键可以将音量调成零。 使用媒体音量类型时,如果要开启回声抵消(AEC)功能,SDK 会开启内置的声学处理算法对声音进行二次处理。 在媒体音量模式下,蓝牙耳机无法使用自带的麦克风采集声音,只能使用手机上的麦克风进行声音采集。

SDK 目前提供了三种系统音量类型的控制模式,分别为:

  • Auto:“麦上通话,麦下媒体”,即主播上麦时使用通话音量,观众不上麦则使用媒体音量,适合在线直播场景。 如果您在 enterRoom 时选择的场景为 TRTC_APP_SCENE_LIVE 或 TRTC_APP_SCENE_VOICE_CHATROOM,SDK 会自动选择该模式。
  • VOIP:全程使用通话音量,适合多人会议场景。 如果您在 enterRoom 时选择的场景为 TRTC_APP_SCENE_VIDEOCALL 或 TRTC_APP_SCENE_AUDIOCALL,SDK 会自动选择该模式。
  • Media:通话全程使用媒体音量,不常用,适合个别有特殊需求(如主播外接声卡)的应用场景。
static final int TRTCSystemVolumeTypeAuto = 0
 
static final int TRTCSystemVolumeTypeMedia = 1
 
static final int TRTCSystemVolumeTypeVOIP = 2
 

4.1 界面调试 Log

static final int TRTC_DEBUG_VIEW_LEVEL_GONE = 0
 
static final int TRTC_DEBUG_VIEW_LEVEL_STATUS = 1
 
static final int TRTC_DEBUG_VIEW_LEVEL_ALL = 2
 

4.2 Log 级别

不同的日志等级定义了不同的详实程度和日志数量,推荐一般情况下将日志等级设置为:TRTC_LOG_LEVEL_INFO。

static final int TRTC_LOG_LEVEL_VERBOSE = 0
 
static final int TRTC_LOG_LEVEL_DEBUG = 1
 
static final int TRTC_LOG_LEVEL_INFO = 2
 
static final int TRTC_LOG_LEVEL_WARN = 3
 
static final int TRTC_LOG_LEVEL_ERROR = 4
 
static final int TRTC_LOG_LEVEL_FATAL = 5
 
static final int TRTC_LOG_LEVEL_NULL = 6
 

4.3 重力感应开关

此配置适用于 Phone 和 Pad 等移动设备:

  • Disable:视频上行的画面(也就是房间里的其它用户看到的当前用户的画面)不会跟随重力感应方向而自动调整。
  • UIAutoLayout:默认值,视频上行的画面(也就是房间里的其它用户看到的当前用户的画面)会跟随当前界面的状态栏方向而自动调整。
  • UIFixLayout:待废弃,效果等同于 UIAutoLayout。
static final int TRTC_GSENSOR_MODE_DISABLE = 0
 
static final int TRTC_GSENSOR_MODE_UIAUTOLAYOUT = 1
 
static final int TRTC_GSENSOR_MODE_UIFIXLAYOUT = 2
 

4.4 混流参数配置模式

static final int TRTC_TranscodingConfigMode_Unknown = 0
 
static final int TRTC_TranscodingConfigMode_Manual = 1
 
static final int TRTC_TranscodingConfigMode_Template_PureAudio = 2
 
static final int TRTC_TranscodingConfigMode_Template_PresetLayout = 3
 
static final int TRTC_TranscodingConfigMode_Template_ScreenSharing = 4
 

结构体成员变量说明

◆ TRTC_SDK_VERSION

final String TRTC_SDK_VERSION = "0.0.0.0"
static

◆ TRTC_VIDEO_RESOLUTION_120_120

final int TRTC_VIDEO_RESOLUTION_120_120 = 1
static

[C] 建议码率 VideoCall:80kbps LIVE:120kbps

◆ TRTC_VIDEO_RESOLUTION_160_160

final int TRTC_VIDEO_RESOLUTION_160_160 = 3
static

[C] 建议码率 VideoCall:100kbps LIVE:150kbps

◆ TRTC_VIDEO_RESOLUTION_270_270

final int TRTC_VIDEO_RESOLUTION_270_270 = 5
static

[C] 建议码率 VideoCall:200kbps LIVE:120kbps

◆ TRTC_VIDEO_RESOLUTION_480_480

final int TRTC_VIDEO_RESOLUTION_480_480 = 7
static

[C] 建议码率 VideoCall:350kbps LIVE:120kbps

◆ TRTC_VIDEO_RESOLUTION_160_120

final int TRTC_VIDEO_RESOLUTION_160_120 = 50
static

[C] 建议码率 VideoCall:100kbps LIVE:150kbps

◆ TRTC_VIDEO_RESOLUTION_240_180

final int TRTC_VIDEO_RESOLUTION_240_180 = 52
static

[C] 建议码率 VideoCall:150kbps LIVE:225kbps

◆ TRTC_VIDEO_RESOLUTION_280_210

final int TRTC_VIDEO_RESOLUTION_280_210 = 54
static

[C] 建议码率 VideoCall:200kbps LIVE:300kbps

◆ TRTC_VIDEO_RESOLUTION_320_240

final int TRTC_VIDEO_RESOLUTION_320_240 = 56
static

[C] 建议码率 VideoCall:250kbps LIVE:375kbps

◆ TRTC_VIDEO_RESOLUTION_400_300

final int TRTC_VIDEO_RESOLUTION_400_300 = 58
static

[C] 建议码率 VideoCall:300kbps LIVE:450kbps

◆ TRTC_VIDEO_RESOLUTION_480_360

final int TRTC_VIDEO_RESOLUTION_480_360 = 60
static

[C] 建议码率 VideoCall:400kbps LIVE:600kbps

◆ TRTC_VIDEO_RESOLUTION_640_480

final int TRTC_VIDEO_RESOLUTION_640_480 = 62
static

[C] 建议码率 VideoCall:600kbps LIVE:900kbps

◆ TRTC_VIDEO_RESOLUTION_960_720

final int TRTC_VIDEO_RESOLUTION_960_720 = 64
static

[C] 建议码率 VideoCall:1000kbps LIVE:1500kbps

◆ TRTC_VIDEO_RESOLUTION_160_90

final int TRTC_VIDEO_RESOLUTION_160_90 = 100
static

[C] 建议码率 VideoCall:150kbps LIVE:250kbps

◆ TRTC_VIDEO_RESOLUTION_256_144

final int TRTC_VIDEO_RESOLUTION_256_144 = 102
static

[C] 建议码率 VideoCall:200kbps LIVE:300kbps

◆ TRTC_VIDEO_RESOLUTION_320_180

final int TRTC_VIDEO_RESOLUTION_320_180 = 104
static

[C] 建议码率 VideoCall:250kbps LIVE:400kbps

◆ TRTC_VIDEO_RESOLUTION_480_270

final int TRTC_VIDEO_RESOLUTION_480_270 = 106
static

[C] 建议码率 VideoCall:350kbps LIVE:550kbps

◆ TRTC_VIDEO_RESOLUTION_640_360

final int TRTC_VIDEO_RESOLUTION_640_360 = 108
static

[C] 建议码率 VideoCall:550kbps LIVE:900kbps

◆ TRTC_VIDEO_RESOLUTION_960_540

final int TRTC_VIDEO_RESOLUTION_960_540 = 110
static

[C] 建议码率 VideoCall:850kbps LIVE:1300kbps

◆ TRTC_VIDEO_RESOLUTION_1280_720

final int TRTC_VIDEO_RESOLUTION_1280_720 = 112
static

[C] 建议码率 VideoCall:1200kbps LIVE:1800kbps

◆ TRTC_VIDEO_RESOLUTION_1920_1080

final int TRTC_VIDEO_RESOLUTION_1920_1080 = 114
static

[C] 建议码率 VideoCall:2000kbps LIVE:3000kbps

◆ TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE

final int TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE = 0
static

横屏分辨率

◆ TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT

final int TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT = 1
static

竖屏分辨率

◆ TRTC_VIDEO_STREAM_TYPE_BIG

final int TRTC_VIDEO_STREAM_TYPE_BIG = 0
static

主画面视频流

◆ TRTC_VIDEO_STREAM_TYPE_SMALL

final int TRTC_VIDEO_STREAM_TYPE_SMALL = 1
static

小画面视频流

◆ TRTC_VIDEO_STREAM_TYPE_SUB

final int TRTC_VIDEO_STREAM_TYPE_SUB = 2
static

辅流(屏幕分享)

◆ TRTC_QUALITY_UNKNOWN

final int TRTC_QUALITY_UNKNOWN = 0
static

未定义

◆ TRTC_QUALITY_Excellent

final int TRTC_QUALITY_Excellent = 1
static

最好

◆ TRTC_QUALITY_Good

final int TRTC_QUALITY_Good = 2
static

◆ TRTC_QUALITY_Poor

final int TRTC_QUALITY_Poor = 3
static

一般

◆ TRTC_QUALITY_Bad

final int TRTC_QUALITY_Bad = 4
static

◆ TRTC_QUALITY_Vbad

final int TRTC_QUALITY_Vbad = 5
static

很差

◆ TRTC_QUALITY_Down

final int TRTC_QUALITY_Down = 6
static

不可用

◆ TRTC_VIDEO_RENDER_MODE_FILL

final int TRTC_VIDEO_RENDER_MODE_FILL = 0
static

图像铺满屏幕,超出显示视窗的视频部分将被裁剪

◆ TRTC_VIDEO_RENDER_MODE_FIT

final int TRTC_VIDEO_RENDER_MODE_FIT = 1
static

图像长边填满屏幕,短边区域会被填充黑色

◆ TRTC_VIDEO_ROTATION_0

final int TRTC_VIDEO_ROTATION_0 = 0
static

不旋转

◆ TRTC_VIDEO_ROTATION_90

final int TRTC_VIDEO_ROTATION_90 = 1
static

顺时针旋转90度

◆ TRTC_VIDEO_ROTATION_180

final int TRTC_VIDEO_ROTATION_180 = 2
static

顺时针旋转180度

◆ TRTC_VIDEO_ROTATION_270

final int TRTC_VIDEO_ROTATION_270 = 3
static

顺时针旋转270度

◆ TRTC_BEAUTY_STYLE_SMOOTH

final int TRTC_BEAUTY_STYLE_SMOOTH = 0
static

光滑,适用于美女秀场,效果比较明显。

◆ TRTC_BEAUTY_STYLE_NATURE

final int TRTC_BEAUTY_STYLE_NATURE = 1
static

自然,磨皮算法更多地保留了面部细节,主观感受上会更加自然。

◆ TRTC_BEAUTY_STYLE_PITU

final int TRTC_BEAUTY_STYLE_PITU = 2
static

由上海优图实验室提供的美颜算法,磨皮效果介于光滑和自然之间,比光滑保留更多皮肤细节,比自然磨皮程度更高。

◆ TRTC_VIDEO_PIXEL_FORMAT_UNKNOWN

final int TRTC_VIDEO_PIXEL_FORMAT_UNKNOWN = 0
static

未知

◆ TRTC_VIDEO_PIXEL_FORMAT_I420

final int TRTC_VIDEO_PIXEL_FORMAT_I420 = 1
static

YUV I420

◆ TRTC_VIDEO_PIXEL_FORMAT_Texture_2D

final int TRTC_VIDEO_PIXEL_FORMAT_Texture_2D = 2
static

OpenGL 2D 纹理

◆ TRTC_VIDEO_PIXEL_FORMAT_TEXTURE_EXTERNAL_OES

final int TRTC_VIDEO_PIXEL_FORMAT_TEXTURE_EXTERNAL_OES = 3
static

◆ TRTC_VIDEO_PIXEL_FORMAT_NV21

final int TRTC_VIDEO_PIXEL_FORMAT_NV21 = 4
static

◆ TRTC_VIDEO_MIRROR_TYPE_AUTO

final int TRTC_VIDEO_MIRROR_TYPE_AUTO = 0
static

SDK 决定镜像方式:前置摄像头镜像,后置摄像头不镜像

◆ TRTC_VIDEO_MIRROR_TYPE_ENABLE

final int TRTC_VIDEO_MIRROR_TYPE_ENABLE = 1
static

前置摄像头和后置摄像头都镜像

◆ TRTC_VIDEO_MIRROR_TYPE_DISABLE

final int TRTC_VIDEO_MIRROR_TYPE_DISABLE = 2
static

前置摄像头和后置摄像头都不镜像

◆ TRTC_VIDEO_BUFFER_TYPE_UNKNOWN

final int TRTC_VIDEO_BUFFER_TYPE_UNKNOWN = 0
static

未知

◆ TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER

final int TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER = 1
static

DirectBuffer,装载 I420 等 buffer,在 native 层使用

◆ TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY

final int TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY = 2
static

byte[],装载 I420 等 buffer,在 Java 层使用

◆ TRTC_VIDEO_BUFFER_TYPE_TEXTURE

final int TRTC_VIDEO_BUFFER_TYPE_TEXTURE = 3
static

直接操作纹理 ID,性能最好,画质损失最少

◆ TRTC_APP_SCENE_VIDEOCALL

final int TRTC_APP_SCENE_VIDEOCALL = 0
static

视频通话场景,支持720P、1080P高清画质,单个房间最多支持300人同时在线,最高支持50人同时发言。
适合:[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。

◆ TRTC_APP_SCENE_LIVE

final int TRTC_APP_SCENE_LIVE = 1
static

视频互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。
适合:[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。
注意:此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。

◆ TRTC_APP_SCENE_AUDIOCALL

final int TRTC_APP_SCENE_AUDIOCALL = 2
static

语音通话场景,支持 48kHz,支持双声道。单个房间最多支持300人同时在线,最高支持50人同时发言。
适合:[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。

◆ TRTC_APP_SCENE_VOICE_CHATROOM

final int TRTC_APP_SCENE_VOICE_CHATROOM = 3
static

语音互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。
适合:[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。
注意:此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。

◆ TRTCRoleAnchor

final int TRTCRoleAnchor = 20
static

主播

◆ TRTCRoleAudience

final int TRTCRoleAudience = 21
static

观众

◆ VIDEO_QOS_CONTROL_CLIENT

final int VIDEO_QOS_CONTROL_CLIENT = 0
static

客户端控制(用于 SDK 开发内部调试,客户请勿使用)

◆ VIDEO_QOS_CONTROL_SERVER

final int VIDEO_QOS_CONTROL_SERVER = 1
static

云端控制 (默认)

◆ TRTC_VIDEO_QOS_PREFERENCE_SMOOTH

final int TRTC_VIDEO_QOS_PREFERENCE_SMOOTH = 1
static

弱网下保流畅

◆ TRTC_VIDEO_QOS_PREFERENCE_CLEAR

final int TRTC_VIDEO_QOS_PREFERENCE_CLEAR = 2
static

弱网下保清晰,默认值

◆ TRTCAudioSampleRate16000

final int TRTCAudioSampleRate16000 = 16000
static

16k采样率

◆ TRTCAudioSampleRate32000

final int TRTCAudioSampleRate32000 = 32000
static

32采样率

◆ TRTCAudioSampleRate44100

final int TRTCAudioSampleRate44100 = 44100
static

44.1k采样率

◆ TRTCAudioSampleRate48000

final int TRTCAudioSampleRate48000 = 48000
static

48k采样率

◆ TRTC_AUDIO_QUALITY_SPEECH

final int TRTC_AUDIO_QUALITY_SPEECH = 1
static

流畅音质:采样率:16k;单声道;音频裸码率:16kbps;适合语音通话为主的场景,比如在线会议,语音通话。

◆ TRTC_AUDIO_QUALITY_DEFAULT

final int TRTC_AUDIO_QUALITY_DEFAULT = 2
static

默认音质:采样率:48k;单声道;音频裸码率:50kbps;SDK 默认的音频质量,如无特殊需求推荐选择之。

◆ TRTC_AUDIO_QUALITY_MUSIC

final int TRTC_AUDIO_QUALITY_MUSIC = 3
static

高音质:采样率:48k;双声道 + 全频带;音频裸码率:128kbps;适合需要高保真传输音乐的场景,比如K歌、音乐直播等。

◆ TRTC_AUDIO_ROUTE_SPEAKER

final int TRTC_AUDIO_ROUTE_SPEAKER = 0
static

扬声器

◆ TRTC_AUDIO_ROUTE_EARPIECE

final int TRTC_AUDIO_ROUTE_EARPIECE = 1
static

听筒

◆ TRTC_REVERB_TYPE_0

final int TRTC_REVERB_TYPE_0 = 0
static

关闭混响

◆ TRTC_REVERB_TYPE_1

final int TRTC_REVERB_TYPE_1 = 1
static

KTV

◆ TRTC_REVERB_TYPE_2

final int TRTC_REVERB_TYPE_2 = 2
static

小房间

◆ TRTC_REVERB_TYPE_3

final int TRTC_REVERB_TYPE_3 = 3
static

大会堂

◆ TRTC_REVERB_TYPE_4

final int TRTC_REVERB_TYPE_4 = 4
static

低沉

◆ TRTC_REVERB_TYPE_5

final int TRTC_REVERB_TYPE_5 = 5
static

洪亮

◆ TRTC_REVERB_TYPE_6

final int TRTC_REVERB_TYPE_6 = 6
static

金属声

◆ TRTC_REVERB_TYPE_7

final int TRTC_REVERB_TYPE_7 = 7
static

磁性

◆ TRTC_VOICE_CHANGER_TYPE_0

final int TRTC_VOICE_CHANGER_TYPE_0 = 0
static

关闭变声

◆ TRTC_VOICE_CHANGER_TYPE_1

final int TRTC_VOICE_CHANGER_TYPE_1 = 1
static

熊孩子

◆ TRTC_VOICE_CHANGER_TYPE_2

final int TRTC_VOICE_CHANGER_TYPE_2 = 2
static

萝莉

◆ TRTC_VOICE_CHANGER_TYPE_3

final int TRTC_VOICE_CHANGER_TYPE_3 = 3
static

大叔

◆ TRTC_VOICE_CHANGER_TYPE_4

final int TRTC_VOICE_CHANGER_TYPE_4 = 4
static

重金属

◆ TRTC_VOICE_CHANGER_TYPE_5

final int TRTC_VOICE_CHANGER_TYPE_5 = 5
static

感冒

◆ TRTC_VOICE_CHANGER_TYPE_6

final int TRTC_VOICE_CHANGER_TYPE_6 = 6
static

外国人

◆ TRTC_VOICE_CHANGER_TYPE_7

final int TRTC_VOICE_CHANGER_TYPE_7 = 7
static

困兽

◆ TRTC_VOICE_CHANGER_TYPE_8

final int TRTC_VOICE_CHANGER_TYPE_8 = 8
static

死肥仔

◆ TRTC_VOICE_CHANGER_TYPE_9

final int TRTC_VOICE_CHANGER_TYPE_9 = 9
static

强电流

◆ TRTC_VOICE_CHANGER_TYPE_10

final int TRTC_VOICE_CHANGER_TYPE_10 = 10
static

重机械

◆ TRTC_VOICE_CHANGER_TYPE_11

final int TRTC_VOICE_CHANGER_TYPE_11 = 11
static

空灵

◆ TRTC_AUDIO_FRAME_FORMAT_PCM

final int TRTC_AUDIO_FRAME_FORMAT_PCM = 1
static

PCM

◆ TRTCSystemVolumeTypeAuto

final int TRTCSystemVolumeTypeAuto = 0
static

“麦上通话,麦下媒体”,即主播上麦时使用通话音量,观众不上麦则使用媒体音量,适合在线直播场景。
如果您在 enterRoom 时选择的场景为 TRTC_APP_SCENE_LIVE 或 TRTC_APP_SCENE_VOICE_CHATROOM,SDK 会自动选择该模式。

◆ TRTCSystemVolumeTypeMedia

final int TRTCSystemVolumeTypeMedia = 1
static

通话全程使用媒体音量,不常用,适合个别有特殊需求(如主播外接声卡)的应用场景。

◆ TRTCSystemVolumeTypeVOIP

final int TRTCSystemVolumeTypeVOIP = 2
static

全程使用通话音量,适合多人会议场景。
如果您在 enterRoom 时选择的场景为 TRTC_APP_SCENE_VIDEOCALL 或 TRTC_APP_SCENE_AUDIOCALL,SDK 会自动选择该模式。

◆ TRTC_DEBUG_VIEW_LEVEL_GONE

final int TRTC_DEBUG_VIEW_LEVEL_GONE = 0
static

界面不显示 Log

◆ TRTC_DEBUG_VIEW_LEVEL_STATUS

final int TRTC_DEBUG_VIEW_LEVEL_STATUS = 1
static

界面上半部分显示状态 Log

◆ TRTC_DEBUG_VIEW_LEVEL_ALL

final int TRTC_DEBUG_VIEW_LEVEL_ALL = 2
static

界面上半部分显示状态 Log,下半部分显示关键事件

◆ TRTC_LOG_LEVEL_VERBOSE

final int TRTC_LOG_LEVEL_VERBOSE = 0
static

输出所有级别的 Log

◆ TRTC_LOG_LEVEL_DEBUG

final int TRTC_LOG_LEVEL_DEBUG = 1
static

输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 Log

◆ TRTC_LOG_LEVEL_INFO

final int TRTC_LOG_LEVEL_INFO = 2
static

输出 INFO,WARNING,ERROR 和 FATAL 级别的 Log

◆ TRTC_LOG_LEVEL_WARN

final int TRTC_LOG_LEVEL_WARN = 3
static

输出 WARNING,ERROR 和 FATAL 级别的 Log

◆ TRTC_LOG_LEVEL_ERROR

final int TRTC_LOG_LEVEL_ERROR = 4
static

只输出 ERROR 和 FATAL 级别的 Log

◆ TRTC_LOG_LEVEL_FATAL

final int TRTC_LOG_LEVEL_FATAL = 5
static

只输出 FATAL 级别的 Log

◆ TRTC_LOG_LEVEL_NULL

final int TRTC_LOG_LEVEL_NULL = 6
static

不输出任何 SDK Log

◆ TRTC_GSENSOR_MODE_DISABLE

final int TRTC_GSENSOR_MODE_DISABLE = 0
static

关闭重力感应。

◆ TRTC_GSENSOR_MODE_UIAUTOLAYOUT

final int TRTC_GSENSOR_MODE_UIAUTOLAYOUT = 1
static

开启重力感应,默认值。

◆ TRTC_GSENSOR_MODE_UIFIXLAYOUT

final int TRTC_GSENSOR_MODE_UIFIXLAYOUT = 2
static

待废弃,效果等同于 UIAutoLayout。

◆ TRTC_TranscodingConfigMode_Unknown

final int TRTC_TranscodingConfigMode_Unknown = 0
static

非法值

◆ TRTC_TranscodingConfigMode_Manual

final int TRTC_TranscodingConfigMode_Manual = 1
static

全手动模式,灵活性最高,可以自由组合出各种混流方案,但易用性最差。 此模式下,您需要填写 TRTCTranscodingConfig 中的所有参数,并需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 回调, 以便根据当前房间中各个上麦用户的音视频状态不断地调整 mixUsers 参数,否则会导致混流失败。

◆ TRTC_TranscodingConfigMode_Template_PureAudio

final int TRTC_TranscodingConfigMode_Template_PureAudio = 2
static

纯音频模式,适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频场景。 只需要在进房后通过 setMixTranscodingConfig() 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。 此模式下,您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,只需设置 audioSampleRate、audioBitrate 和 audioChannels 等参数。

◆ TRTC_TranscodingConfigMode_Template_PresetLayout

final int TRTC_TranscodingConfigMode_Template_PresetLayout = 3
static

预排版模式,通过占位符提前对各路画面进行排布 此模式下,您依然需要设置 mixUsers 参数,但可以将 userId 设置为占位符,可选的占位符有:

  • "$PLACE_HOLDER_REMOTE$" : 指代远程用户的画面,可以设置多个。
  • "$PLACE_HOLDER_LOCAL_MAIN$" : 指代本地摄像头画面,只允许设置一个。
  • "$PLACE_HOLDER_LOCAL_SUB$" : 指代本地屏幕分享画面,只允许设置一个。 但是您可以不需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 回调进行实时调整, 只需要在进房成功后调用一次 setMixTranscodingConfig() 即可,之后 SDK 会自动将真实的 userId 补位到您设置的占位符上。

◆ TRTC_TranscodingConfigMode_Template_ScreenSharing

final int TRTC_TranscodingConfigMode_Template_ScreenSharing = 4
static

屏幕分享模式,适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。 SDK 会先根据您(通过 videoWidth 和 videoHeight 参数)设置的目标分辨率构建一张画布, 当老师未开启屏幕分享时,SDK 会将摄像头画面等比例拉伸绘制到该画布上;当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。 这样操作的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。 同时,连麦学生的声音会被默认混合到老师的音视频流中。

由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。 推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。 在该模式下,您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。

您可以将 TRTCTranscodingConfig 中的 width × height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:

  • 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。
  • 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。

◆ TRTCRemoteStatistics

class TRTCRemoteStatistics
成员变量
String userId 用户 ID,指定是哪个用户的视频流
int finalLoss

该线路的总丢包率(%),该值越小越好,例如,丢包率为0表示网络很好, 丢包率是该线路的 userId 从上行到服务器再到下行的总丢包率。 如果 downLoss 为0, 但是 finalLoss 不为0,说明该 userId 在上行就出现了无法恢复的丢包

int width 视频宽度
int height 视频高度
int frameRate 接收帧率(fps)
int videoBitrate 视频码率(Kbps)
int audioSampleRate 音频采样率(Hz)
int audioBitrate 音频码率(Kbps)
int jitterBufferDelay 播放时延(ms)
int streamType 流类型(大画面 | 小画面 | 辅路画面)

◆ TRTCLocalStatistics

class TRTCLocalStatistics
成员变量
int width 视频宽度
int height 视频高度
int frameRate 帧率(fps)
int videoBitrate 视频发送码率(Kbps)
int audioSampleRate 音频采样率(Hz)
int audioBitrate 音频发送码率(Kbps)
int streamType 流类型(大画面 | 小画面 | 辅路画面)

◆ TRTCStatistics

class TRTCStatistics
成员变量
int appCpu

当前 App 的 CPU 使用率(%)

int systemCpu

当前系统的 CPU 使用率(%)

int rtt

延迟(毫秒), 指 SDK 到腾讯云服务器的一次网络往返时间,该值越小越好。 一般低于50ms的 rtt 相对理想,而高于100ms的 rtt 会引入较大的通话延时。 由于数据上下行共享一条网络连接,所以 local 和 remote 的 rtt 相同。

int upLoss

C -> S 上行丢包率(%),该值越小越好,例如,丢包率为0表示网络很好, 丢包率为30%则意味着 SDK 向服务器发送的数据包中会有30%丢失在上行传输中

int downLoss

S -> C 下行丢包率(%),该值越小越好,例如,丢包率为0表示网络很好, 丢包率为30%则意味着 SDK 向服务器发送的数据包中会有30%丢失在下行传输中

long sendBytes 发送字节总数,注意是字节数(bytes),不是比特数(bits)
long receiveBytes 接收字节总数,注意是字节数(bytes),不是比特数(bits)
ArrayList< TRTCLocalStatistics > localArray 自己本地的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组
ArrayList< TRTCRemoteStatistics > remoteArray 远端成员的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组