详细描述

腾讯云视频通话的 Windows C++ 专有废弃接口

结构体说明

◆ liteav::IDeprecatedTRTCCloud

class liteav::IDeprecatedTRTCCloud

弃用接口函数
virtual void	startLocalAudio ()

virtual void	startRemoteView (const char *userId, TXView rendView)

virtual void	stopRemoteView (const char *userId)

virtual void	setLocalViewFillMode (TRTCVideoFillMode mode)

virtual void	setLocalViewRotation (TRTCVideoRotation rotation)

virtual void	setLocalViewMirror (bool mirror)

virtual void	setRemoteViewFillMode (const char *userId, TRTCVideoFillMode mode)

virtual void	setRemoteViewRotation (const char *userId, TRTCVideoRotation rotation)

virtual void	startRemoteSubStreamView (const char *userId, TXView rendView)

virtual void	stopRemoteSubStreamView (const char *userId)

virtual void	setRemoteSubStreamViewFillMode (const char *userId, TRTCVideoFillMode mode)

virtual void	setRemoteSubStreamViewRotation (const char *userId, TRTCVideoRotation rotation)

virtual void	setAudioQuality (TRTCAudioQuality quality)

virtual void	setPriorRemoteVideoStreamType (TRTCVideoStreamType type)

virtual ITRTCDeviceCollection *	getCameraDevicesList ()

virtual void	setCurrentCameraDevice (const char *deviceId)

virtual ITRTCDeviceInfo *	getCurrentCameraDevice ()

virtual ITRTCDeviceCollection *	getMicDevicesList ()

virtual ITRTCDeviceInfo *	getCurrentMicDevice ()

virtual void	setCurrentMicDevice (const char *micId)

virtual uint32_t	getCurrentMicDeviceVolume ()

virtual void	setCurrentMicDeviceVolume (uint32_t volume)

virtual void	setCurrentMicDeviceMute (bool mute)

virtual bool	getCurrentMicDeviceMute ()

virtual ITRTCDeviceCollection *	getSpeakerDevicesList ()

virtual ITRTCDeviceInfo *	getCurrentSpeakerDevice ()

virtual void	setCurrentSpeakerDevice (const char *speakerId)

virtual uint32_t	getCurrentSpeakerVolume ()

virtual void	setCurrentSpeakerVolume (uint32_t volume)

virtual void	setCurrentSpeakerDeviceMute (bool mute)

virtual bool	getCurrentSpeakerDeviceMute ()

virtual void	startCameraDeviceTest (TXView rendView)

virtual void	startCameraDeviceTest (ITRTCVideoRenderCallback *callback)

virtual void	stopCameraDeviceTest ()

virtual void	startMicDeviceTest (uint32_t interval)

virtual void	stopMicDeviceTest ()

virtual void	startSpeakerDeviceTest (const char *testAudioFilePath)

virtual void	stopSpeakerDeviceTest ()

virtual void	setMicVolumeOnMixing (uint32_t volume)

virtual void	startScreenCapture (TXView rendView)

virtual void	playBGM (const char *path)

virtual void	stopBGM ()

virtual void	pauseBGM ()

virtual void	resumeBGM ()

virtual uint32_t	getBGMDuration (const char *path)

virtual void	setBGMPosition (uint32_t pos)

virtual void	setBGMVolume (uint32_t volume)

virtual void	setBGMPlayoutVolume (uint32_t volume)

virtual void	setBGMPublishVolume (uint32_t volume)

virtual void	playAudioEffect (TRTCAudioEffectParam *effect)

virtual void	setAudioEffectVolume (int effectId, int volume)

virtual void	stopAudioEffect (int effectId)

virtual void	stopAllAudioEffects ()

virtual void	setAllAudioEffectsVolume (int volume)

virtual void	pauseAudioEffect (int effectId)

virtual void	resumeAudioEffect (int effectId)

virtual void	selectScreenCaptureTarget (const TRTCScreenCaptureSourceInfo &source, const RECT &captureRect, bool captureMouse=true, bool highlightWindow=true)

virtual void	enableCustomVideoCapture (bool enable)

virtual void	sendCustomVideoData (TRTCVideoFrame *frame)

virtual void	muteLocalVideo (bool mute)

virtual void	muteRemoteVideoStream (const char *userId, bool mute)

virtual void	startSpeedTest (uint32_t sdkAppId, const char userId, const char userSig)

构造及析构函数说明

◆ ~IDeprecatedTRTCCloud()

virtual ~IDeprecatedTRTCCloud ( )

inlineprotectedvirtual

成员函数说明

◆ enableCustomVideoCapture()

virtual void enableCustomVideoCapture ( bool enable )

inlinevirtual

启用视频自定义采集模式

开启该模式后，SDK 不再运行原有的视频采集流程，只保留编码和发送能力。您需要用 sendCustomVideoData() 不断地向 SDK 塞入自己采集的视频画面。

参数

enable 是否启用，默认值：false

被 ITRTCCloud 重载.

◆ getBGMDuration()

virtual uint32_t getBGMDuration ( const char * path )

inlinevirtual

获取音乐文件总时长，单位毫秒

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager getMusicDurationInMS 接口

参数

path	音乐文件路径，如果 path 为空，那么返回当前正在播放的 music 时长

返回: 成功返回时长，失败返回-1

◆ getCameraDevicesList()

virtual ITRTCDeviceCollection* getCameraDevicesList ( )

inlinevirtual

获取摄像头设备列表

示例代码：

 ITRTCDeviceCollection * pDevice = m_pCloud->getCameraDevicesList();
 for (int i{}; i < pDevice->getCount(); i++)
 {
     std::wstring name = UTF82Wide(pDevice->getDeviceName(i));
 }
 pDevice->release();
 pDevice = null;

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getDevicesList 接口

注意: delete ITRTCDeviceCollection* 指针会导致编译错误，SDK 维护 ITRTCDeviceCollection 对象的生命周期，使用完毕后请调用 release 方法释放资源。

返回: 摄像头管理器对象指针 ITRTCDeviceCollection*

◆ getCurrentCameraDevice()

virtual ITRTCDeviceInfo* getCurrentCameraDevice ( )

inlinevirtual

获取当前使用的摄像头

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDevice 接口

返回: ITRTCDeviceInfo 设备信息，能获取设备 ID 和设备名称

◆ getCurrentMicDevice()

virtual ITRTCDeviceInfo* getCurrentMicDevice ( )

inlinevirtual

获取当前选择的麦克风

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDevice 接口

返回: ITRTCDeviceInfo 设备信息，能获取设备 ID 和设备名称

◆ getCurrentMicDeviceMute()

virtual bool getCurrentMicDeviceMute ( )

inlinevirtual

获取系统当前麦克风设备是否静音

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDeviceMute 接口

注意: 查询的是系统硬件静音状态

返回: 静音状态

◆ getCurrentMicDeviceVolume()

virtual uint32_t getCurrentMicDeviceVolume ( )

inlinevirtual

获取系统当前麦克风设备音量

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDeviceVolume 接口

注意: 查询的是系统硬件音量大小。

返回: 音量值，范围是0 - 100

◆ getCurrentSpeakerDevice()

virtual ITRTCDeviceInfo* getCurrentSpeakerDevice ( )

inlinevirtual

获取当前的扬声器设备

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDevice 接口

返回: ITRTCDeviceInfo 设备信息，能获取设备 ID 和设备名称

◆ getCurrentSpeakerDeviceMute()

virtual bool getCurrentSpeakerDeviceMute ( )

inlinevirtual

获取系统当前扬声器设备是否静音

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDeviceMute 接口

注意: 查询的是系统硬件静音状态

返回: 静音状态

◆ getCurrentSpeakerVolume()

virtual uint32_t getCurrentSpeakerVolume ( )

inlinevirtual

获取系统当前扬声器设备音量

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getCurrentDeviceVolume 接口

注意: 查询的是系统硬件音量大小。

返回: 扬声器音量，范围0 - 100

◆ getMicDevicesList()

virtual ITRTCDeviceCollection* getMicDevicesList ( )

inlinevirtual

获取麦克风设备列表

示例代码：

 ITRTCDeviceCollection * pDevice = m_pCloud->getMicDevicesList();
 for (int i{}; i < pDevice->getCount(); i++)
 {
     std::wstring name = UTF82Wide(pDevice->getDeviceName(i));
 }
 pDevice->release();
 pDevice = null;

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getDevicesList 接口

返回: 麦克风管理器对象指针 ITRTCDeviceCollection*

注意: delete ITRTCDeviceCollection* 指针会导致编译错误，SDK 维护 ITRTCDeviceCollection 对象的生命周期，使用完毕后请调用 release 方法释放资源。

◆ getSpeakerDevicesList()

virtual ITRTCDeviceCollection* getSpeakerDevicesList ( )

inlinevirtual

获取扬声器设备列表

示例代码：

 ITRTCDeviceCollection * pDevice = m_pCloud->getSpeakerDevicesList();
 for (int i{}; i < pDevice->getCount(); i++)
 {
     std::wstring name = UTF82Wide(pDevice->getDeviceName(i));
 }
 pDevice->release();
 pDevice = null;

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::getDevicesList 接口

返回: 扬声器管理器对象指针 ITRTCDeviceCollection*

注意: delete ITRTCDeviceCollection* 指针会导致编译错误，SDK 维护 ITRTCDeviceCollection 对象的生命周期，使用完毕后请调用 release 方法释放资源。

◆ muteLocalVideo()

virtual void muteLocalVideo ( bool mute )

inlinevirtual

暂停/恢复发布本地的视频流

该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。该接口等效于 start/stopLocalPreview 这两个接口，但具有更好的性能和响应速度。因为 start/stopLocalPreview 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。相比之下，muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。当暂停发布本地视频后，同一房间中的其他用户将会收到 onUserVideoAvailable(userId, false) 回调通知。当恢复发布本地视频后，同一房间中的其他用户将会收到 onUserVideoAvailable(userId, true) 回调通知。

参数

mute	true：暂停；false：恢复。

被 ITRTCCloud 重载.

◆ muteRemoteVideoStream()

virtual void muteRemoteVideoStream	(	const char *	userId,
		bool	mute
	)

inlinevirtual

暂停/恢复订阅远端用户的视频流

该接口仅暂停/恢复接收指定用户的视频流，但并不释放显示资源，视频画面会被冻屏在接口调用时的最后一帧。

参数

userId	指定远端用户的 ID。
mute	是否暂停接收。

注意: 该接口支持您在进入房间（enterRoom）前调用，暂停状态会在退出房间（exitRoom）在之后会被重置。

被 ITRTCCloud 重载.

◆ pauseAudioEffect()

virtual void pauseAudioEffect ( int effectId )

inlinevirtual

暂停音效

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager pausePlayMusic 接口

参数

effectId 音效 Id

◆ pauseBGM()

virtual void pauseBGM ( )

inlinevirtual

暂停播放背景音乐

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager pausePlayMusic 接口

◆ playAudioEffect()

virtual void playAudioEffect ( TRTCAudioEffectParam * effect )

inlinevirtual

播放音效

每个音效都需要您指定具体的 ID，您可以通过该 ID 对音效的开始、停止、音量等进行设置。支持的文件格式：aac, mp3。

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager startPlayMusic 接口

注意: 若您想同时播放多个音效，请分配不同的 ID 进行播放。因为使用同一个 ID 播放不同音效，SDK 将会停止上一个 ID 对应的音效播放，再启动新的音效播放。

参数

effect 音效

◆ playBGM()

virtual void playBGM ( const char * path )

inlinevirtual

启动播放背景音乐

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager startPlayMusic 接口，支持并发播放多个 BGM

参数

path	音乐文件路径，支持的文件格式：aac, mp3。

◆ resumeAudioEffect()

virtual void resumeAudioEffect ( int effectId )

inlinevirtual

恢复音效

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager resumePlayMusic 接口

参数

effectId 音效 Id

◆ resumeBGM()

virtual void resumeBGM ( )

inlinevirtual

继续播放背景音乐

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager resumePlayMusic 接口

◆ selectScreenCaptureTarget()

virtual void selectScreenCaptureTarget	(	const TRTCScreenCaptureSourceInfo &	source,
		const RECT &	captureRect,
		bool	captureMouse = `true`,
		bool	highlightWindow = `true`
	)

inlinevirtual

设置屏幕共享参数

弃用:: v7.9 版本弃用，请使用 selectScreenCaptureTarget(TRTCScreenCaptureSourceInfo,RECT,TRTCScreenCaptureProperty) 接口

参数

source	指定分享源
captureRect	指定捕获的区域
captureMouse	指定是否捕获鼠标指针
highlightWindow	指定是否高亮正在共享的窗口，以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡

◆ sendCustomVideoData()

virtual void sendCustomVideoData ( TRTCVideoFrame * frame )

inlinevirtual

TRTCVideoFrame 推荐如下填写方式（其他字段不需要填写）：

pixelFormat： Windows、Android平台仅支持 TRTCVideoPixelFormat_I420，iOS、Mac平台支持TRTCVideoPixelFormat_I420和TRTCVideoPixelFormat_BGRA32
bufferType：仅支持 TRTCVideoBufferType_Buffer。
data：视频帧 buffer。
length：视频帧数据长度，I420 格式下，其值等于：width × height × 3 / 2。
width：视频图像长度。
height：视频图像宽度。
timestamp：如果 timestamp 间隔不均匀，会严重影响音画同步和录制出的 MP4 质量。

参考文档：自定义采集和渲染。

参数

frame 视频数据，支持 I420 格式数据。

注意

- SDK 内部有帧率控制逻辑，目标帧率以您在 setVideoEncoderParam 中设置的为准，太快会自动丢帧，太慢则会自动补帧。

可以设置 frame 中的 timestamp 为 0，相当于让 SDK 自己设置时间戳，但请“均匀”地控制 sendCustomVideoData 的调用间隔，否则会导致视频帧率不稳定。
iOS、Mac平台目前仅支持传入TRTCVideoPixelFormat_I420或TRTCVideoPixelFormat_BGRA32格式的视频帧
Windows、Android平台目前仅支持传入TRTCVideoPixelFormat_I420格式的视频帧

被 ITRTCCloud 重载.

◆ setAllAudioEffectsVolume()

virtual void setAllAudioEffectsVolume ( int volume )

inlinevirtual

设置所有音效的音量

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager setMusicPublishVolume / setMusicPlayoutVolume 接口

注意: 该操作会覆盖通过 setAudioEffectVolume 指定的单独音效音量。

参数

volume 音量大小，取值范围为0 - 100；默认值：100

◆ setAudioEffectVolume()

virtual void setAudioEffectVolume	(	int	effectId,
		int	volume
	)

inlinevirtual

设置音效音量

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager setMusicPublishVolume / setMusicPlayoutVolume 接口

注意: 会覆盖通过 setAllAudioEffectsVolume 指定的整体音效音量。

参数

effectId	音效 ID
volume	音量大小，取值范围为0 - 100；默认值：100

◆ setAudioQuality()

virtual void setAudioQuality ( TRTCAudioQuality quality )

inlinevirtual

设置音频质量

主播端的音质越高，观众端的听感越好，但传输所依赖的带宽也就越高，在带宽有限的场景下也更容易出现卡顿。

TRTCCloudDef#TRTCAudioQualitySpeech，流畅：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话。
TRTCCloudDef#TRTCAudioQualityDefault，默认：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。
TRTCCloudDef#TRTCAudioQualityMusic，高音质：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等。

弃用:
v8.0 版本弃用，请使用 startLocalAudio(TRTCAudioQuality) 接口

注意
该方法需要在 startLocalAudio 之前进行设置，否则不会生效。

◆ setBGMPlayoutVolume()

virtual void setBGMPlayoutVolume ( uint32_t volume )

inlinevirtual

设置背景音乐本地播放音量的大小

播放背景音乐混音时使用，用来控制背景音乐在本地播放时的音量大小。

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager::setMusicPlayoutVolume 接口

参数

volume 音量大小，100为正常音量，取值范围为0 - 100；默认值：100

◆ setBGMPosition()

virtual void setBGMPosition ( uint32_t pos )

inlinevirtual

设置 BGM 播放进度

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager seekMusicToPosInMS 接口

参数

pos 单位毫秒

◆ setBGMPublishVolume()

virtual void setBGMPublishVolume ( uint32_t volume )

inlinevirtual

设置背景音乐远端播放音量的大小

播放背景音乐混音时使用，用来控制背景音乐在远端播放时的音量大小。

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager::setMusicPublishVolume 接口

参数

volume 音量大小，100为正常音量，取值范围为0 - 100；默认值：100

◆ setBGMVolume()

virtual void setBGMVolume ( uint32_t volume )

inlinevirtual

设置背景音乐播放音量的大小

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager::setMusicPublishVolume / setMusicPlayoutVolume 接口播放背景音乐混音时使用，用来控制背景音乐播放音量的大小，该接口会同时控制远端播放音量的大小和本地播放音量的大小，因此调用该接口后，setBGMPlayoutVolume和setBGMPublishVolume设置的音量值会被覆盖。

参数

volume 音量大小，100为正常音量，取值范围为0 - 100；默认值：100

◆ setCurrentCameraDevice()

virtual void setCurrentCameraDevice ( const char * deviceId )

inlinevirtual

设置要使用的摄像头

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDevice 接口

参数

deviceId 从 getCameraDevicesList 中得到的设备 ID

◆ setCurrentMicDevice()

virtual void setCurrentMicDevice ( const char * micId )

inlinevirtual

设置要使用的麦克风

选择指定的麦克风作为录音设备，不调用该接口时，默认选择索引为0的麦克风

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDevice 接口

参数

micId 从 getMicDevicesList 中得到的设备 ID

◆ setCurrentMicDeviceMute()

virtual void setCurrentMicDeviceMute ( bool mute )

inlinevirtual

设置系统当前麦克风设备的是否静音

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDeviceMute 接口

注意: 该接口的功能是设置系统麦克风静音，如果用户直接设置 Windows 系统设置的麦克风静音时，该接口的设置结果会被用户的操作所覆盖。

参数

mute	设置为 true 时，则设置麦克风设备静音

◆ setCurrentMicDeviceVolume()

virtual void setCurrentMicDeviceVolume ( uint32_t volume )

inlinevirtual

设置系统当前麦克风设备的音量

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDeviceVolume 接口

注意: 该接口的功能是调节系统采集音量，如果用户直接调节 Windows 系统设置的采集音量时，该接口的设置结果会被用户的操作所覆盖。

参数

volume 麦克风音量值，范围0 - 100

◆ setCurrentSpeakerDevice()

virtual void setCurrentSpeakerDevice ( const char * speakerId )

inlinevirtual

设置要使用的扬声器

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDevice 接口

参数

speakerId 从 getSpeakerDevicesList 中得到的设备 ID

◆ setCurrentSpeakerDeviceMute()

virtual void setCurrentSpeakerDeviceMute ( bool mute )

inlinevirtual

设置系统当前扬声器设备的是否静音

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDeviceMute 接口

注意: 该接口的功能是设置系统扬声器静音，如果用户直接设置 Windows 系统设置的扬声器静音时，该接口的设置结果会被用户的操作所覆盖。

参数

mute	设置为 true 时，则设置扬声器设备静音

◆ setCurrentSpeakerVolume()

virtual void setCurrentSpeakerVolume ( uint32_t volume )

inlinevirtual

设置系统当前扬声器设备音量

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::setCurrentDeviceVolume 接口

注意: 该接口的功能是调节系统播放音量，如果用户直接调节 Windows 系统设置的播放音量时，该接口的设置结果会被用户的操作所覆盖。

参数

volume 设置的扬声器音量，范围0 - 100

◆ setLocalViewFillMode()

virtual void setLocalViewFillMode ( TRTCVideoFillMode mode )

inlinevirtual

设置本地图像的填充模式

弃用:: v8.0 版本弃用，请使用 setLocalRenderParams(TRTCRenderParams) 接口

参数

mode	填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：TRTCVideoFillMode_Fit

◆ setLocalViewMirror()

virtual void setLocalViewMirror ( bool mirror )

inlinevirtual

设置本地摄像头预览画面的镜像模式

弃用:: v8.0 版本弃用，请使用 setLocalRenderParams(TRTCRenderParams) 接口

参数

mirror 镜像模式，默认值：false（非镜像模式）

◆ setLocalViewRotation()

virtual void setLocalViewRotation ( TRTCVideoRotation rotation )

inlinevirtual

设置本地图像的顺时针旋转角度

弃用:: v8.0 版本弃用，请使用 setLocalRenderParams(TRTCRenderParams) 接口

参数

rotation 支持 TRTCVideoRotation90 、 TRTCVideoRotation180 以及 TRTCVideoRotation270 旋转角度，默认值：TRTCVideoRotation0

◆ setMicVolumeOnMixing()

virtual void setMicVolumeOnMixing ( uint32_t volume )

inlinevirtual

设置麦克风的音量大小

弃用:: 从 v6.9 版本开始废弃，请使用 setAudioCaptureVolume 接口替代。

◆ setPriorRemoteVideoStreamType()

virtual void setPriorRemoteVideoStreamType ( TRTCVideoStreamType type )

inlinevirtual

设定观看方优先选择的视频质量

低端设备推荐优先选择低清晰度的小画面。如果对方没有开启双路视频模式，则此操作无效。

弃用:: v8.0 版本弃用，请使用 startRemoteView(userId, streamType, rendView) 接口

参数

type	默认观看大画面还是小画面，默认为 TRTCVideoStreamTypeBig

◆ setRemoteSubStreamViewFillMode()

virtual void setRemoteSubStreamViewFillMode	(	const char *	userId,
		TRTCVideoFillMode	mode
	)

inlinevirtual

设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的显示模式

setRemoteViewFillMode() 用于设置远端主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的显示模式。
setRemoteSubStreamViewFillMode() 用于设置远端辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的显示模式。

弃用:
v8.0 版本弃用，请使用 setRemoteRenderParams(userId,streamType,param) 接口

参数

userId 用户的 ID

mode 填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：TRTCVideoFillMode_Fit

◆ setRemoteSubStreamViewRotation()

virtual void setRemoteSubStreamViewRotation	(	const char *	userId,
		TRTCVideoRotation	rotation
	)

inlinevirtual

设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的顺时针旋转角度

setRemoteViewRotation() 用于设置远端主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的旋转角度。
setRemoteSubStreamViewRotation() 用于设置远端辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的旋转角度。

弃用:
v8.0 版本弃用，请使用 setRemoteRenderParams(userId,streamType,param) 接口

参数

userId 用户 ID

rotation 支持90、180、270旋转角度

◆ setRemoteViewFillMode()

virtual void setRemoteViewFillMode	(	const char *	userId,
		TRTCVideoFillMode	mode
	)

inlinevirtual

设置远端图像的渲染模式

弃用:: v8.0 版本弃用，请使用 setRemoteRenderParams(userId,streamType,param) 接口

参数

userId	用户 ID
mode	填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：TRTCVideoFillMode_Fit

◆ setRemoteViewRotation()

virtual void setRemoteViewRotation	(	const char *	userId,
		TRTCVideoRotation	rotation
	)

inlinevirtual

设置远端图像的顺时针旋转角度

弃用:: v8.0 版本弃用，请使用 setRemoteRenderParams(userId,streamType,param) 接口

参数

userId	用户 ID
rotation	支持 TRTCVideoRotation90 、 TRTCVideoRotation180 以及 TRTCVideoRotation270 旋转角度，默认值：TRTCVideoRotation0

◆ startCameraDeviceTest() [1/2]

virtual void startCameraDeviceTest ( ITRTCVideoRenderCallback * callback )

inlinevirtual

开始进行摄像头测试

会触发 onFirstVideoFrame 回调接口

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::startCameraDeviceTest 接口

注意: 在测试过程中可以使用 setCurrentCameraDevice 接口切换摄像头。

参数

callback 摄像头预览自定义渲染画面回调

◆ startCameraDeviceTest() [2/2]

virtual void startCameraDeviceTest ( TXView rendView )

inlinevirtual

开始进行摄像头测试

会触发 onFirstVideoFrame 回调接口

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::startCameraDeviceTest 接口

注意: 在测试过程中可以使用 setCurrentCameraDevice 接口切换摄像头。

参数

rendView 承载预览画面的 HWND

◆ startLocalAudio()

virtual void startLocalAudio ( )

inlinevirtual

开启本地音频的采集和上行

该函数会启动麦克风采集，并将音频数据传输给房间里的其他用户。 SDK 不会默认开启本地音频采集和上行，您需要调用该函数开启，否则房间里的其他用户将无法听到您的声音。

弃用:: v8.0 版本弃用，请使用 startLocalAudio(quality) 接口

注意: TRTC SDK 并不会默认打开本地的麦克风采集。

◆ startMicDeviceTest()

virtual void startMicDeviceTest ( uint32_t interval )

inlinevirtual

开启麦克风测试

回调接口 onTestMicVolume 获取测试数据

该方法测试麦克风是否能正常工作，volume 的取值范围为0 - 100。

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::startMicDeviceTest 接口

参数

interval 反馈音量提示的时间间隔（ms），建议设置到大于 200 毫秒

◆ startRemoteSubStreamView()

virtual void startRemoteSubStreamView	(	const char *	userId,
		TXView	rendView
	)

inlinevirtual

开始显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）

startRemoteView() 用于显示主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）。
startRemoteSubStreamView() 用于显示辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。

弃用:
v8.0 版本弃用，请使用 startRemoteView(userId,streamType,rendView) 接口

参数

userId 对方的用户标识

rendView 渲染画面的 TXView

注意
请在 onUserSubStreamAvailable 回调后再调用这个接口。

◆ startRemoteView()

virtual void startRemoteView	(	const char *	userId,
		TXView	rendView
	)

inlinevirtual

开始显示远端视频画面

在收到 SDK 的 onUserVideoAvailable(userId, true) 通知时，可以获知该远程用户开启了视频，此后调用 startRemoteView(userId) 接口加载该用户的远程画面时，可以用 loading 动画优化加载过程中的等待体验。待该用户的首帧画面开始显示时，您会收到 onFirstVideoFrame(userId) 事件回调。

弃用:: v8.0 版本弃用，请使用 startRemoteView(userId, streamType, rendView) 接口

参数

userId	对方的用户标识
rendView	承载预览画面的窗口句柄

◆ startScreenCapture()

virtual void startScreenCapture ( TXView rendView )

inlinevirtual

启动屏幕分享

弃用:: 从 v7.2 版本开始废弃，请使用 startScreenCapture(rendView, type, params) 接口替代。

◆ startSpeakerDeviceTest()

virtual void startSpeakerDeviceTest ( const char * testAudioFilePath )

inlinevirtual

开启扬声器测试

回调接口 onTestSpeakerVolume 获取测试数据

该方法播放指定的音频文件测试播放设备是否能正常工作。如果能听到声音，说明播放设备能正常工作。

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::startSpeakerDeviceTest 接口

参数

testAudioFilePath 音频文件的绝对路径，路径字符串使用 UTF-8 编码格式，支持文件格式：WAV、MP3

◆ startSpeedTest()

virtual void startSpeedTest	(	uint32_t	sdkAppId,
		const char *	userId,
		const char *	userSig
	)

inlinevirtual

开始进行网络测速（进入房间前使用）

弃用:: v9.2 版本开始不推荐使用，建议使用 startSpeedTest(params) 接口替代之。

被 ITRTCCloud , 以及 ITRTCCloud 重载.

◆ stopAllAudioEffects()

virtual void stopAllAudioEffects ( )

inlinevirtual

停止所有音效

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager stopPlayMusic 接口

◆ stopAudioEffect()

virtual void stopAudioEffect ( int effectId )

inlinevirtual

停止音效

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager stopPlayMusic 接口

参数

effectId 音效 ID

◆ stopBGM()

virtual void stopBGM ( )

inlinevirtual

停止播放背景音乐

弃用:: v7.3 版本弃用，请使用 TXAudioEffectManager stopPlayMusic 接口

◆ stopCameraDeviceTest()

virtual void stopCameraDeviceTest ( )

inlinevirtual

停止摄像头测试

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::stopCameraDeviceTest 接口

◆ stopMicDeviceTest()

virtual void stopMicDeviceTest ( )

inlinevirtual

停止麦克风测试

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::stopMicDeviceTest 接口

◆ stopRemoteSubStreamView()

virtual void stopRemoteSubStreamView ( const char * userId )

inlinevirtual

停止显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。

弃用:: v8.0 版本弃用，请使用 stopRemoteView(userId,streamType) 接口

参数

userId 对方的用户标识

◆ stopRemoteView()

virtual void stopRemoteView ( const char * userId )

inlinevirtual

停止显示远端视频画面，同时不再拉取该远端用户的视频数据流

调用此接口后，SDK 会停止接收该用户的远程视频流，同时会清理相关的视频显示资源。

弃用:: v8.0 版本弃用，请使用 stopRemoteView(userId,streamType) 接口

参数

userId 对方的用户标识

◆ stopSpeakerDeviceTest()

virtual void stopSpeakerDeviceTest ( )

inlinevirtual

停止扬声器测试

弃用:: v8.0 版本弃用，请使用 ITXDeviceManager::stopSpeakerDeviceTest 接口

userId	用户的 ID
mode	填充（画面可能会被拉伸裁剪）或适应（画面可能会有黑边），默认值：TRTCVideoFillMode_Fit

详细描述

结构体说明

◆ liteav::IDeprecatedTRTCCloud

弃用接口函数

构造及析构函数说明

◆ ~IDeprecatedTRTCCloud()

成员函数说明

◆ enableCustomVideoCapture()

◆ getBGMDuration()

◆ getCameraDevicesList()

◆ getCurrentCameraDevice()

◆ getCurrentMicDevice()

◆ getCurrentMicDeviceMute()

◆ getCurrentMicDeviceVolume()

◆ getCurrentSpeakerDevice()

◆ getCurrentSpeakerDeviceMute()

◆ getCurrentSpeakerVolume()

◆ getMicDevicesList()

◆ getSpeakerDevicesList()

◆ muteLocalVideo()

◆ muteRemoteVideoStream()

◆ pauseAudioEffect()

◆ pauseBGM()

◆ playAudioEffect()

◆ playBGM()

◆ resumeAudioEffect()

◆ resumeBGM()

◆ selectScreenCaptureTarget()

◆ sendCustomVideoData()

◆ setAllAudioEffectsVolume()

◆ setAudioEffectVolume()

◆ setAudioQuality()

◆ setBGMPlayoutVolume()

◆ setBGMPosition()

◆ setBGMPublishVolume()

◆ setBGMVolume()

◆ setCurrentCameraDevice()

◆ setCurrentMicDevice()

◆ setCurrentMicDeviceMute()

◆ setCurrentMicDeviceVolume()

◆ setCurrentSpeakerDevice()

◆ setCurrentSpeakerDeviceMute()

◆ setCurrentSpeakerVolume()

◆ setLocalViewFillMode()

◆ setLocalViewMirror()

◆ setLocalViewRotation()

◆ setMicVolumeOnMixing()

◆ setPriorRemoteVideoStreamType()

◆ setRemoteSubStreamViewFillMode()

◆ setRemoteSubStreamViewRotation()

◆ setRemoteViewFillMode()

◆ setRemoteViewRotation()

◆ startCameraDeviceTest() [1/2]

◆ startCameraDeviceTest() [2/2]

◆ startLocalAudio()

◆ startMicDeviceTest()

◆ startRemoteSubStreamView()

◆ startRemoteView()

◆ startScreenCapture()

◆ startSpeakerDeviceTest()

◆ startSpeedTest()

◆ stopAllAudioEffects()

◆ stopAudioEffect()

◆ stopBGM()

◆ stopCameraDeviceTest()

◆ stopMicDeviceTest()

◆ stopRemoteSubStreamView()

◆ stopRemoteView()

◆ stopSpeakerDeviceTest()