Global

Members

(constant) TRTCVideoResolution :Number

Properties:
Name Type Description
TRTCVideoResolution_120_120 Number

宽高比 1:1；分辨率 120x120；建议码率（VideoCall）80kbps; 建议码率（LIVE）120kbps
TRTCVideoResolution_160_160 Number

宽高比 1:1 分辨率 160x160；建议码率（VideoCall）100kbps; 建议码率（LIVE）150kbps
TRTCVideoResolution_270_270 Number

宽高比 1:1；分辨率 270x270；建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
TRTCVideoResolution_480_480 Number

宽高比 1:1；分辨率 480x480；建议码率（VideoCall）350kbps; 建议码率（LIVE）500kbps
TRTCVideoResolution_160_120 Number

宽高比4:3；分辨率 160x120；建议码率（VideoCall）100kbps; 建议码率（LIVE）150kbps
TRTCVideoResolution_240_180 Number

宽高比 4:3；分辨率 240x180；建议码率（VideoCall）150kbps; 建议码率（LIVE）250kbps
TRTCVideoResolution_280_210 Number

宽高比 4:3；分辨率 280x210；建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
TRTCVideoResolution_320_240 Number

宽高比 4:3；分辨率 320x240；建议码率（VideoCall）250kbps; 建议码率（LIVE）375kbps
TRTCVideoResolution_400_300 Number

宽高比 4:3；分辨率 400x300；建议码率（VideoCall）300kbps; 建议码率（LIVE）450kbps
TRTCVideoResolution_480_360 Number

宽高比 4:3；分辨率 480x360；建议码率（VideoCall）400kbps; 建议码率（LIVE）600kbps
TRTCVideoResolution_640_480 Number

宽高比 4:3；分辨率 640x480；建议码率（VideoCall）600kbps; 建议码率（LIVE）900kbps
TRTCVideoResolution_960_720 Number

宽高比 4:3；分辨率 960x720；建议码率（VideoCall）1000kbps; 建议码率（LIVE）1500kbps
TRTCVideoResolution_160_90 Number

宽高比 16:9；分辨率 160x90；建议码率（VideoCall）150kbps; 建议码率（LIVE）250kbps
TRTCVideoResolution_256_144 Number

宽高比 16:9；分辨率 256x144；建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
TRTCVideoResolution_320_180 Number

宽高比 16:9；分辨率 320x180；建议码率（VideoCall）250kbps; 建议码率（LIVE）400kbps
TRTCVideoResolution_480_270 Number

宽高比 16:9；分辨率 480x270；建议码率（VideoCall）350kbps; 建议码率（LIVE）550kbps
TRTCVideoResolution_640_360 Number

宽高比 16:9；分辨率 640x360；建议码率（VideoCall）500kbps; 建议码率（LIVE）900kbps
TRTCVideoResolution_960_540 Number

宽高比 16:9；分辨率 960x540；建议码率（VideoCall）850kbps; 建议码率（LIVE）1300kbps
TRTCVideoResolution_1280_720 Number

宽高比 16:9；分辨率 1280x720；建议码率（VideoCall）1200kbps; 建议码率（LIVE）1800kbps
TRTCVideoResolution_1920_1080 Number

宽高比 16:9；分辨率 1920x1080；建议码率（VideoCall）2000kbps; 建议码率（LIVE）3000kbps

视频分辨率
此处仅定义横屏分辨率（如 640 × 360），如需使用竖屏分辨率（如 360 × 640），需要同时指定 VideoResolutionMode 为 Portrait

Type:
  • Number

(constant) TRTCVideoResolutionMode :Number

Properties:
Name Type Description
TRTCVideoResolutionModeLandscape Number

横屏分辨率
TRTCVideoResolutionModePortrait Number

竖屏分辨率

视频分辨率模式
TRTCVideoResolution 中仅定义了横屏分辨率（如 640 × 360），如需使用竖屏分辨率（如 360 × 640），需要同时指定 TRTCVideoResolutionMode 为 Portrait

Type:
  • Number

(constant) TRTCVideoStreamType :Number

Properties:
Name Type Description
TRTCVideoStreamTypeBig Number

大画面视频流
TRTCVideoStreamTypeSmall Number

小画面视频流
TRTCVideoStreamTypeSub Number

辅流（屏幕分享）

视频流类型
TRTC 内部有三种不同的音视频流，分别是：

  • 高清大画面：一般用来传输摄像头的视频数据
  • 低清小画面：小画面和大画面的内容相互，但是分辨率和码率都比大画面低，因此清晰度也更低
  • 辅流画面：一般用于屏幕分享，同一时间在同一个房间中只允许一个用户发布辅流视频，其他用户必须要等该用户关闭之后才能发布自己的辅流

Note:

  • 不支持单独开启低清小画面，小画面必须依附于大画面而存在，SDK 会自动设定低清小画面的分辨率和码率
Type:
  • Number

(constant) TRTCSnapshotSourceType :Number

Properties:
Name Type Description
TRTCSnapshotSourceTypeStream Number

视频流画面
TRTCSnapshotSourceTypeView Number

视频渲染画面

画面来源
TRTC 内部有两种不同的画面来源，分别是：

  • TRTCSnapshotSourceTypeStream: 视频流画面
  • TRTCSnapshotSourceTypeView: 视频渲染画面

Note:

  • 截取视频流画面（TRTCSnapshotSourceTypeStream）一般更清晰。
Type:
  • Number

(constant) TRTCVideoFillMode :Number

Properties:
Name Type Description
TRTCVideoFillMode_Fill Number

图像铺满屏幕，超出显示视窗的视频部分将被截掉
TRTCVideoFillMode_Fit Number

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

缩放填充模式，即无论画面的宽高比，都会被拉伸或压缩以完全填充显示区域

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

  • TRTCVideoFillMode_Fill，图像铺满屏幕，超出显示视窗的视频部分将被截掉，所以画面显示可能不完整。
  • TRTCVideoFillMode_Fit，图像长边填满屏幕，短边区域会被填充黑色，但画面的内容肯定是完整的。
  • TRTCVideoFillMode_ScaleFill，缩放填充模式，即无论画面的宽高比，都会被拉伸或压缩以完全填充显示区域，此模式下画面宽高比可能会被改变，导致渲染画面变形
Type:
  • Number

(constant) TRTCVideoRotation :Number

Properties:
Name Type Description
TRTCVideoRotation_0 Number

顺时针旋转0度
TRTCVideoRotation_90 Number

顺时针旋转90度
TRTCVideoRotation_180 Number

顺时针旋转180度
TRTCVideoRotation_270 Number

顺时针旋转270度

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

Type:
  • Number

(constant) TRTCVideoMirrorType :Number

Properties:
Name Type Description
TRTCVideoMirrorType_Auto Number

只适用于移动端， 本地预览时，前置摄像头镜像，后置摄像头不镜像
TRTCVideoMirrorType_Enable Number

所有画面均镜像
TRTCVideoMirrorType_Disable Number

所有画面均不镜像

画面渲染镜像类型
TRTC 的画面镜像提供下列设置模式

Type:
  • Number

(constant) TRTCBeautyStyle :Number

Properties:
Name Type Description
TRTCBeautyStyleSmooth Number

光滑，算法比较激进，磨皮效果比较明显，适用于秀场直播
TRTCBeautyStyleNature Number

自然，算法更多地保留了面部细节，磨皮效果更加自然，适用于绝大多数直播场景
TRTCBeautyStylePitu Number

优图，由优图实验室提供，磨皮效果介于光滑和自然之间，比光滑保留更多皮肤细节，比自然磨皮程度更高

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

Type:
  • Number

AudioMusicParam :Number

Type:
  • Number

(constant) TRTCAppScene :Number

Properties:
Name Type Description
TRTCAppSceneVideoCall Number

视频通话场景，支持720P、1080P高清画质，单个房间最多支持300人同时在线，最高支持50人同时发言。
适合：[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。
注意：此场景下，您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。
TRTCAppSceneLIVE Number

视频互动直播，支持平滑上下麦，切换过程无需等待，主播延时小于300ms；支持十万级别观众同时播放，播放延时低至1000ms。
在线直播场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。
TRTCAppSceneAudioCall Number

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

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

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

  • TRTCAppSceneVideoCall ：视频通话场景，适合[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。
  • TRTCAppSceneLIVE ：视频互动直播，适合[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。
  • TRTCAppSceneAudioCall ：语音通话场景，适合[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。
  • TRTCAppSceneVoiceChatRoom：语音互动直播，适合：[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。
Type:
  • Number

(constant) TRTCRoleType :Number

Properties:
Name Type Description
TRTCRoleAnchor Number

主播
TRTCRoleAudience Number

观众

角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）
在直播场景中，多数用户只是观众，只有个别用户是主播，这种角色区分可以有利于 TRTC 进行更好的定向优化。

  • Anchor：主播，可以上行视频和音频，一个房间里最多支持50个主播同时上行音视频。
  • Audience：观众，只能观看，不能上行视频和音频，一个房间里的观众人数没有上限。
Type:
  • Number

(constant) TRTCAudioQuality :Number

Properties:
Name Type Description
TRTCAudioQualitySpeech Number

人声模式：适用于以人声沟通为主的应用场景，该模式下音频传输的抗性较强，TRTC 会通过各种人声处理技术保障在弱网络环境下的流畅度最佳
TRTCAudioQualityDefault Number

标准模式（或者默认模式）：介于 Speech 和 Music 之间的档位，对音乐的还原度比人声模式要好，但传输数据量比音乐模式要低很多，对各种场景均有不错的适应性，如无特殊需求推荐选择之。
TRTCAudioQualityMusic Number

音乐模式：适用于对声乐要求很苛刻的场景，该模式下音频传输的数据量很大，TRTC 会通过各项技术确保音乐信号在各频段均能获得高保真的细节还原度

音频质量

Type:
  • Number

(constant) TRTCAudioRoute :Number

Properties:
Name Type Description
TRTCAudioRouteSpeaker Number

使用扬声器播放（即“免提”），扬声器位于手机底部，声音偏大，适合外放音乐
TRTCAudioRouteEarpiece Number

使用听筒播放，听筒位于手机顶部，声音偏小，适合需要保护隐私的通话场景

音频路由（即声音的播放模式）

Type:
  • Number

(constant) TRTCGSensorMode :Number

Properties:
Name Type Description
TRTC_GSENSOR_MODE_DISABLE Number

不适配重力感应，该模式是桌面平台上的默认值，该模式下，当前用户发布出去的视频画面不受重力感应方向变化的影响。
TRTC_GSENSOR_MODE_UIAUTOLAYOUT Number

适配重力感应，该模式是移动平台上的默认值，该模式下，当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面保持方向不变。 SDK 目前支持的一种适配模式是：当手机或 Pad 上下颠倒时，为了保证远端用户看到的画面方向正常，SDK 会自动将发布出去的画面上下旋转180度。如果您的 APP 的界面层开启了重力感应自适应，推荐使用 UIFixLayout 模式。

重力感应开关（仅适用于移动端）

Type:
  • Number

(constant) TXSystemVolumeType :Number

Properties:
Name Type Description
TXSystemVolumeTypeAuto Number

自动切换模式: 也被称为“麦上通话，麦下媒体”，即主播上麦时使用通话音量，观众不上麦则使用媒体音量，适合在线直播场景。 如果您在 enterRoom 时选择的场景为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom，SDK 会自动使用该模式。
TXSystemVolumeTypeMedia Number

全程媒体音量: 通话全程使用媒体音量，并不是非常常用的音量类型，适用于对音质要求比较苛刻的音乐场景中。 如果您的用户大都使用外接设备（比如外接声卡）为主，可以使用该模式，否则请慎用。
TXSystemVolumeTypeVOIP Number

全程通话音量: 该方案的优势在于用户在上下麦时音频模块无需切换工作模式，可以做到无缝上下麦，适合于用户需要频繁上下麦的应用场景。 如果您在 enterRoom 时选择的场景为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，SDK 会自动使用该模式。

系统音量类型（仅适用于移动端）

  • 通话音量：手机专门为接打电话所设计的音量类型，自带回声抵消（AEC）功能，并且支持通过蓝牙耳机上的麦克风进行拾音，缺点是音质比较一般。当您通过手机侧面的音量按键下调手机音量时，如果无法将其调至零（也就是无法彻底静音），说明您的手机当前处于通话音量。
  • 媒体音量：手机专门为音乐场景所设计的音量类型，无法使用系统的 AEC 功能，并且不支持通过蓝牙耳机的麦克风进行拾音，但具备更好的音乐播放效果。当您通过手机侧面的音量按键下调手机音量时，如果能够将手机音量调至彻底静音，说明您的手机当前处于媒体音量。
Type:
  • Number

Methods

onMicDidReady()

麦克风准备就绪

onCameraDidReady()

摄像头准备就绪

onNetworkQuality(localQuality, remoteQuality)

网络质量：该回调每2秒触发一次，统计当前网络的上行和下行质量
userId 为本地用户 ID 代表自己当前的视频质量

Parameters:
Name Type Description
localQuality String

上行网络质量
remoteQuality String

下行网络质量

onStatistics(statics)

技术指标统计回调
如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标。 如果您是首次开发音视频相关项目，可以只关注 onNetworkQuality 回调

Note:

  • 每 2 秒回调一次
Parameters:
Name Type Description
statics Object

状态数据