Namespace trtc

Classes

ITRTCCloud

Module: ITRTCCloud @ TXLiteAVSDK

SDK VERSION 6.0

Function: 腾讯云视频通话功能的主要接口类

Nouns[1]: 主流 - TRTC 里称摄像头这一路的画面叫做“主流”（或主路）画面。

Nouns[2]: 辅流(substream) - TRTC 里称屏幕分享或者播片这一路的画面叫做“辅流”（或辅路）画面。

Nouns[3]: 播片(vodplay) - TRTC 的 Windows 版本支持将本地的一个视频文件分享出去，这个功能成为“播片”。

ITXAudioEffectManager

腾讯云视频通话功能音乐和人声设置接口

ITXDeviceManager

腾讯云实时音视频设备管理接口

TRTCScreenCaptureProperty

屏幕采集属性

Structs

AudioMusicParam

音乐和人声设置接口参数

RECT

图层位置坐标以及大小，左上角为坐标原点(0,0) （绝对像素值）

TRTCAudioFrame

6.7 音频帧数据

TRTCAudioRecordingParams

录音参数

【字段含义】文件路径（必填），录音文件的保存路径。该路径需要用户自行指定，请确保路径存在且可写。

【特别说明】该路径需精确到文件名及格式后缀，格式后缀决定录音文件的格式，目前支持的格式有 PCM、WAV 和 AAC。 例如，指定路径为 path/to/audio.aac，则会生成一个 AAC 格式的文件。 请指定一个有读写权限的合法路径，否则录音文件无法生成。

TRTCLocalRecordingParams

录制参数

TRTCLocalStatistics

自己本地的音视频统计信息

TRTCMixUser

5.10 云端混流中每一路子画面的位置信息

TRTCMixUser 用于指定每一路（即每一个 userId）视频画面的具体摆放位置

TRTCNetworkQosParam

6.3 网络流控相关参数

网络流控相关参数，该设置决定了SDK在各种网络环境下的调控方向（例如弱网下是“保清晰”或“保流畅”）

TRTCParams

6.1 进房相关参数

只有该参数填写正确，才能顺利调用 enterRoom 进入 roomId 所指定的音视频房间。

TRTCPublishCDNParam

5.13 CDN 旁路推流参数

TRTCQualityInfo

6.4 视频质量

表示视频质量的好坏，通过这个数值，您可以在 UI 界面上用图标表征 userId 的通话线路质量

TRTCRemoteStatistics

远端成员的音视频统计信息

TRTCRenderParams

5.3 画面渲染参数

TRTCScreenCaptureSourceInfo

屏幕采集信息

TRTCSpeedTestResult

6.8 网络测速结果

您可以在用户进入房间前通过 TRTCCloud 的 startSpeedTest 接口进行测速 （注意：请不要在通话中调用）， 测速结果会每2 - 3秒钟返回一次，每次返回一个 IP 地址的测试结果。

TRTCStatistics

统计数据

TRTCSwitchRoomConfig

切换房间配置

TRTCTranscodingConfig

5.12 云端混流（转码）配置

包括最终编码质量和各路画面的摆放位置

TRTCVideoEncParam

6.2 视频编码参数

该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）。

TRTCVideoFrame

6.6 视频帧数据

TRTCVolumeInfo

6.5 音量大小

表示语音音量的评估大小，通过这个数值，您可以在 UI 界面上用图标表征 userId 是否有在说话。

Interfaces

ITRTCCloudCallback

腾讯云视频通话功能的回调接口类

ITRTCLogCallback

日志相关回调

ITRTCVideoRenderCallback

视频数据帧的自定义处理回调

ITXMusicPlayObserver

背景音乐的播放进度回调

Enums

TRTCAppScene

2.1 应用场景

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

- TRTCAppSceneVideoCall ：视频通话场景，适合[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。

- TRTCAppSceneLIVE ：视频互动直播，适合[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。

- TRTCAppSceneAudioCall ：语音通话场景，适合[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。

- TRTCAppSceneVoiceChatRoom：语音互动直播，适合：[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。

TRTCAudioFrameFormat

3.1 音频帧的格式

TRTCAudioQuality

3.2 声音音质

TRTCBeautyStyle

1.6 美颜（磨皮）算法

TRTCDeviceState

5.2 设备操作

TRTCDeviceType

5.3 设备类型

TRTCLocalRecordType

本地录制参数

TRTCLogLevel

5.1 Log 级别

TRTCMixInputType

2.6 混流输入类型

TRTCQosControlMode

2.3 流控模式

TRTC SDK 内部需要时刻根据网络情况调整内部的编解码器和网络模块，以便能够对网络的变化做出反应。

为了支持快速算法升级，SDK 内部设置了两种不同的流控模式：

- ModeServer： 云端控制，默认模式，推荐选择。

- ModeClient： 本地控制，用于 SDK 开发内部调试，客户请勿使用。

TRTCQuality

1.4 画质级别

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

TRTCRoleType

2.2 角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）

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

- Anchor：主播，可以上行视频和音频，一个房间里最多支持50个主播同时上行音视频。

- Audience：观众，只能观看，不能上行视频和音频，一个房间里的观众人数没有上限。

TRTCScreenCaptureSourceType

采集源类型

您可以通过 getScreenCaptureSources() 枚举可共享的屏幕列表信息

TRTCSnapshotSourceType

1.10 视频截图来源

TRTCTranscodingConfigMode

5.11 混流参数配置模式

TRTCVideoBufferType

1.9 视频数据包装格式

TRTCVideoFillMode

1.5 视频画面填充模式

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

- TRTCVideoFillMode_Fill，超出显示视窗的视频部分将被裁剪，画面显示可能不完整。

- TRTCVideoFillMode_Fit，图像长边填满屏幕，短边区域会被填充黑色，但画面的内容肯定是完整的。

TRTCVideoMirrorType

1.9 画面渲染镜像类型

TRTCVideoPixelFormat

1.8 视频像素格式

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

在自定义渲染功能中，您可以指定您期望 SDK 回调的视频像素格式。

TRTCVideoQosPreference

2.4 画质偏好

指当 TRTC SDK 在遇到弱网络环境时，您期望“保清晰”或“保流畅”：

- Smooth：弱网下保流畅。即在遭遇弱网环境时首先确保声音的流畅和优先发送，画面会变得模糊且会有较多马赛克，但可以保持流畅不卡顿。

- Clear：弱网下保清晰。即在遭遇弱网环境时，画面会尽可能保持清晰，但可能会更容易出现卡顿。

TRTCVideoResolution

1.1 视频分辨率

TRTCVideoResolutionMode

1.2 视频分辨率模式

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

- 竖屏分辨率：TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640

TRTCVideoRotation

1.6 视频画面旋转方向

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

TRTCVideoStreamType

1.3 视频流类型

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

-主画面：最常用的一条线路，一般用来传输摄像头的视频数据。

-小画面：跟主画面的内容相同，但是分辨率和码率更低。

TRTCWaterMarkSrcType

4.4 水印图片的源类型

TXAudioRoute

声音播放路由（仅适用于移动端设备）

一般手机都有两个扬声器，设置音频路由的作用就是要决定声音从哪个扬声器播放出来：

  • Speakerphone：扬声器，位于手机底部，声音偏大，适合外放音乐。
  • Earpiece：听筒，位于手机顶部，声音偏小，适合通话。

TXLiteAVError

错误码（严重）

TXLiteAVWarning

错误码（警告）

TXSystemVolumeType

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

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

  • 通话音量：手机专门为通话场景设计的音量类型，使用手机自带的回声抵消功能，音质相比媒体音量类型较差， 无法通过音量按键将音量调成零，但是支持蓝牙耳机上的麦克风。

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

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

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

  • VOIP：全程使用通话音量，适合多人会议场景。 如果您在 enterRoom 时选择的场景为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，SDK 会自动选择该模式。

  • Media：通话全程使用媒体音量，不常用，适合个别有特殊需求（如主播外接声卡）的应用场景。

TXVoiceChangeType

变声类型

TXVoiceReverbType

混响类型