API 概览

最后更新时间:2021-06-15 19:46:51

    TRTC Unity Api概览

    基础方法

    API 描述
    getTRTCShareInstance 创建 TRTCCloud 单例。
    destroyTRTCShareInstance 释放 ITRTCCloud 单例对象。
    addCallback 设置回调接口 TRTCCloudCallback。
    removeCallback 移除事件回调。

    房间相关接口函数

    API 描述
    enterRoom 进入房间,若房间不存在,系统将自动创建一个新房间。
    exitRoom 离开房间。
    switchRole 切换角色,仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM)。
    setDefaultStreamRecvMode 设置音视频数据接收模式,需要在进房前设置才能生效。
    connectOtherRoom 请求跨房通话(主播 PK)。
    disconnectOtherRoom 退出跨房通话。
    switchRoom 切换房间。

    CDN 相关接口函数

    API 描述
    startPublishing 开始向腾讯云的直播 CDN 推流。
    stopPublishing 停止向腾讯云的直播 CDN 推流。
    startPublishCDNStream 开始向友商云的直播 CDN 转推。
    stopPublishCDNStream 停止向非腾讯云地址转推。
    setMixTranscodingConfig 设置云端的混流转码参数。

    视频相关接口函数

    API 描述
    startLocalPreview 开启本地视频的预览画面,目前仅支持自定义渲染。
    stopLocalPreview 停止本地视频采集及预览。
    muteLocalVideo 暂停/恢复推送本地的视频数据。
    startRemoteView 开始拉取并显示指定用户的远端画面,目前仅支持自定义渲染。
    stopRemoteView 停止显示远端视频画面,同时不再拉取该远端用户的视频数据流。
    stopAllRemoteView 停止显示所有远端视频画面,同时不再拉取远端用户的视频数据流。
    muteRemoteVideoStream 暂停/恢复接收指定的远端视频流。
    muteAllRemoteVideoStreams 暂停/恢复接收所有远端视频流。
    setVideoEncoderParam 设置视频编码器相关参数。
    setNetworkQosParam 设置网络流控相关参数。
    setVideoEncoderMirror 设置编码器输出的画面镜像模式。

    音频相关接口函数

    API 描述
    startLocalAudio 开启本地音频的采集和上行。
    stopLocalAudio 关闭本地音频的采集和上行。
    muteLocalAudio 静音/取消静音本地的音频。
    muteRemoteAudio 静音/取消静音指定的远端用户的声音。
    muteAllRemoteAudio 静音/取消静音所有用户的声音。
    setRemoteAudioVolume 设置某个远程用户的播放音量。
    setAudioCaptureVolume 设置 SDK 采集音量。
    getAudioCaptureVolume 获取 SDK 采集音量。
    setAudioPlayoutVolume 设置 SDK 播放音量。
    getAudioPlayoutVolume 获取 SDK 播放音量。
    enableAudioVolumeEvaluation 启用音量大小提示。
    startAudioRecording 开始录音。
    stopAudioRecording 停止录音。

    设备管理接口

    API 描述
    getDeviceManager 获取设备管理模块。接口详情请参见 设备管理详细接口

    音乐特效和人声特效

    API 描述
    getAudioEffectManager 获取音效管理类 TXAudioEffectManager,用于管理BGM,短音效和人声特效。接口详情见 音效管理详细接口

    自定义视频渲染

    API 描述
    setLocalVideoRenderCallback 设置本地视频自定义渲染。
    setRemoteVideoRenderCallback 设置远端视频自定义渲染。

    自定义消息发送

    API 描述
    sendSEIMsg 将小数据量的自定义数据嵌入视频帧中。

    网络测试

    API 描述
    startSpeedTest 开始进行网络测速(视频通话期间请勿测试,以免影响通话质量)。
    stopSpeedTest 停止服务器测速。

    Log 相关接口函数

    API 描述
    getSDKVersion 获取 SDK 版本信息。
    setLogLevel 设置 Log 输出级别。
    setLogDirPath 修改日志保存路径。
    setLogCompressEnabled 启用或禁用 Log 的本地压缩。
    callExperimentalAPI 启用或禁用 Log 的本地压缩。

    ITRTCCloudCallback

    腾讯云音频通话功能的事件回调接口。

    错误事件和警告事件

    API 描述
    onError 错误回调,表示 SDK 不可恢复的错误,一定要监听并分情况给用户适当的界面提示。
    onWarning 警告回调,用于告知您一些非严重性问题,例如出现卡顿或者可恢复的解码失败。

    房间事件回调

    API 描述
    onEnterRoom 已加入房间的回调。
    onExitRoom 离开房间的事件回调。
    onSwitchRole 切换角色的事件回调。
    onConnectOtherRoom 请求跨房通话(主播 PK)的结果回调。
    onDisConnectOtherRoom 结束跨房通话(主播 PK)的结果回调。
    onSwitchRoom 切换房间 (switchRoom) 的结果回调。

    成员事件回调

    API 描述
    onRemoteUserEnterRoom 有用户加入当前房间。
    onRemoteUserLeaveRoom 有用户离开当前房间。
    onUserVideoAvailable 用户是否开启摄像头视频。
    onUserAudioAvailable 远端用户是否存在可播放的音频数据。
    onFirstVideoFrame 开始渲染本地或远程用户的首帧画面。
    onFirstAudioFrame 开始播放远程用户的首帧音频(本地声音暂不通知)。
    onSendFirstLocalVideoFrame 首帧本地视频数据已经被送出。
    onSendFirstLocalAudioFrame 首帧本地音频数据已经被送出。

    统计和质量回调

    API 描述
    onNetworkQuality 网络质量,该回调每2秒触发一次,统计当前网络的上行和下行质量。
    onStatistics 技术指标统计回调。

    服务器事件回调

    API 描述
    onConnectionLost SDK 跟服务器的连接断开。
    onTryToReconnect SDK 尝试重新连接到服务器。
    onConnectionRecovery SDK 跟服务器的连接恢复。
    onSpeedTest 服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知。

    硬件设备事件回调

    API 描述
    onCameraDidReady 摄像头准备就绪。
    onMicDidReady 麦克风准备就绪。
    onUserVoiceVolume 用于提示音量大小的回调,包括每个 userId 的音量和远端总音量。
    onDeviceChange 本地设备通断回调。

    自定义消息的接收回调

    API 描述
    onRecvSEIMsg 收到 SEI 消息的回调。

    CDN 旁路转推回调

    API 描述
    onStartPublishing 开始向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 startPublishing() 接口。
    onStopPublishing 停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 stopPublishing() 接口。
    onStartPublishCDNStream 启动旁路推流到 CDN 完成的回调。
    onStopPublishCDNStream 停止旁路推流到 CDN 完成的回调。
    onSetMixTranscodingConfig 设置云端的混流转码参数的回调,对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。

    关键类型定义

    类名 描述
    TRTCParams 进房参数。
    TRTCVideoEncParam 视频编码参数。
    TRTCTranscodingConfig 云端混流(转码)配置。
    TRTCSwitchRoomConfig 切换房间参数参数。
    TRTCNetworkQosParam 网络流控相关参数。
    TXVoiceReverbType 混响类型定义(KTV、小房间、大会堂、低沉、洪亮...)。
    AudioMusicParam 音乐和人声设置接口参数。
    TRTCAudioRecordingParams 录音参数。

    设备管理详细接口

    API 描述
    isFrontCamera 判断当前是否为前置摄像头。
    switchCamera 切换摄像头。
    getCameraZoomMaxRatio 查询当前摄像头支持的最大缩放比例。
    setCameraZoomRatio 设置当前摄像头的缩放比例。
    isAutoFocusEnabled 查询是否支持自动识别人脸位置。
    enableCameraAutoFocus 设置人脸自动识别。
    setCameraFocusPosition 设置摄像头焦点。
    enableCameraTorch 开关闪光灯。
    setSystemVolumeType 设置通话时使用的系统音量类型。
    setAudioRoute 设置音频路由。

    音乐特效和人声特效详细接口

    API 描述
    setVoiceReverbType 设置人声的混响效果(KTV、小房间、大会堂、低沉、洪亮...)。
    setMusicObserver 设置背景音乐的播放进度回调接口。
    startPlayMusic 开始播放背景音乐。
    stopPlayMusic 停止播放背景音乐。
    pausePlayMusic 暂停播放背景音乐。
    resumePlayMusic 恢复播放背景音乐。
    setMusicPublishVolume 设置背景音乐的远端音量大小,即主播可以通过此接口设置远端观众能听到的背景音乐的音量大小。
    setMusicPlayoutVolume 设置背景音乐的本地音量大小,即主播可以通过此接口设置主播自己本地的背景音乐的音量大小。
    setAllMusicVolume 设置全局背景音乐的本地和远端音量的大小。
    setMusicPitch 调整背景音乐的音调高低。
    setMusicSpeedRate 调整背景音乐的变速效果。
    getMusicCurrentPosInMS 获取背景音乐当前的播放进度(单位:毫秒)
    seekMusicToPosInMS 设置背景音乐的播放进度(单位:毫秒)
    getMusicDurationInMS 获取景音乐文件的总时长(单位:毫秒)