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

详细描述

腾讯云 TRTC 主功能接口

Module: TRTCCloud @ TXLiteAVSDK Function: 腾讯云 TRTC 主功能接口 Version: <:Version:>


结构体说明

◆ TRTCCloud

class TRTCCloud

构造函数

(instancetype) - init
 

类方法

(instancetype) + new
 

创建实例和事件回调

id< TRTCCloudDelegatedelegate
 
dispatch_queue_t delegateQueue
 
(instancetype) + sharedInstance
 
(void) + destroySharedIntance
 

房间相关接口函数

(void) - enterRoom:appScene:
 
(void) - exitRoom
 
(void) - switchRole:
 
(void) - switchRoom:
 
(void) - connectOtherRoom:
 
(void) - disconnectOtherRoom
 
(void) - setDefaultStreamRecvMode:video:
 
(TRTCCloud *) - createSubCloud
 
(void) - destroySubCloud:
 
(void) - startPublishing:type:
 
(void) - stopPublishing
 
(void) - startPublishCDNStream:
 
(void) - stopPublishCDNStream
 
(void) - setMixTranscodingConfig:
 

视频相关接口函数

(void) - startLocalPreview:view:
 
(void) - startLocalPreview:
 
(void) - updateLocalView:
 
(void) - stopLocalPreview
 
(void) - muteLocalVideo:mute:
 
(void) - setVideoMuteImage:fps:
 
(void) - startRemoteView:streamType:view:
 
(void) - updateRemoteView:streamType:forUser:
 
(void) - stopRemoteView:streamType:
 
(void) - stopAllRemoteView
 
(void) - muteRemoteVideoStream:streamType:mute:
 
(void) - muteAllRemoteVideoStreams:
 
(void) - setVideoEncoderParam:
 
(void) - setNetworkQosParam:
 
(void) - setLocalRenderParams:
 
(void) - setRemoteRenderParams:streamType:params:
 
(void) - setVideoEncoderRotation:
 
(void) - setVideoEncoderMirror:
 
(void) - setGSensorMode:
 
(int) - enableEncSmallVideoStream:withQuality:
 
(void) - setRemoteVideoStreamType:type:
 
(void) - snapshotVideo:type:sourceType:completionBlock:
 

音频相关接口函数

(void) - startLocalAudio:
 
(void) - stopLocalAudio
 
(void) - muteLocalAudio:
 
(void) - muteRemoteAudio:mute:
 
(void) - muteAllRemoteAudio:
 
(void) - setAudioRoute:
 
(void) - setRemoteAudioVolume:volume:
 
(void) - setAudioCaptureVolume:
 
(NSInteger) - getAudioCaptureVolume
 
(void) - setAudioPlayoutVolume:
 
(NSInteger) - getAudioPlayoutVolume
 
(void) - enableAudioVolumeEvaluation:
 
(int) - startAudioRecording:
 
(void) - stopAudioRecording
 
(void) - startLocalRecording:
 
(void) - stopLocalRecording
 

设备管理相关接口

(TXDeviceManager *) - getDeviceManager
 

美颜特效和图像水印

(TXBeautyManager *) - getBeautyManager
 
(void) - setWatermark:streamType:rect:
 

背景音乐和声音特效

(TXAudioEffectManager *) - getAudioEffectManager
 
(void) - startSystemAudioLoopback
 
(void) - stopSystemAudioLoopback
 
(void) - setSystemAudioLoopbackVolume:
 

屏幕分享相关接口

(void) - startScreenCaptureInApp:encParam:
 
(void) - startScreenCaptureByReplaykit:encParam:appGroup:
 
(void) - startScreenCapture:streamType:encParam:
 
(int) - stopScreenCapture
 
(int) - pauseScreenCapture
 
(int) - resumeScreenCapture
 
(NSArray< TRTCScreenCaptureSourceInfo * > *) - getScreenCaptureSourcesWithThumbnailSize:iconSize:
 
(void) - selectScreenCaptureTarget:rect:capturesCursor:highlight:
 
(void) - setSubStreamEncoderParam:
 
(void) - setSubStreamMixVolume:
 
(void) - addExcludedShareWindow:
 
(void) - removeExcludedShareWindow:
 
(void) - removeAllExcludedShareWindows
 
(void) - addIncludedShareWindow:
 
(void) - removeIncludedShareWindow:
 
(void) - removeAllIncludedShareWindows
 

自定义采集和自定义渲染

(uint64_t) + generateCustomPTS
 
(void) - enableCustomVideoCapture:enable:
 
(void) - sendCustomVideoData:frame:
 
(void) - enableCustomAudioCapture:
 
(void) - sendCustomAudioData:
 
(void) - enableMixExternalAudioFrame:playout:
 
(int) - mixExternalAudioFrame:
 
(void) - setMixExternalAudioVolume:playoutVolume:
 
(int) - setLocalVideoProcessDelegete:pixelFormat:bufferType:
 
(int) - setLocalVideoRenderDelegate:pixelFormat:bufferType:
 
(int) - setRemoteVideoRenderDelegate:delegate:pixelFormat:bufferType:
 
(void) - setAudioFrameDelegate:
 
(int) - setCapturedRawAudioFrameDelegateFormat:
 
(int) - setLocalProcessedAudioFrameDelegateFormat:
 
(int) - setMixedPlayAudioFrameDelegateFormat:
 
(void) - enableCustomAudioRendering:
 
(void) - getCustomAudioRenderingFrame:
 

自定义消息发送接口

(BOOL) - sendCustomCmdMsg:data:reliable:ordered:
 
(BOOL) - sendSEIMsg:repeatCount:
 

网络测试接口

(void) - startSpeedTest:userId:userSig:completion:
 
(void) - stopSpeedTest
 

调试相关接口

(NSString *) + getSDKVersion
 
(void) + setLogLevel:
 
(void) + setConsoleEnabled:
 
(void) + setLogCompressEnabled:
 
(void) + setLogDirPath:
 
(void) + setLogDelegate:
 
(void) - showDebugView:
 
(void) - setDebugViewMargin:margin:
 
(void) - callExperimentalAPI:
 

弃用接口(建议使用对应的新接口)

(void) - setMicVolumeOnMixing:
 
(void) - setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:
 
(void) - setEyeScaleLevel:
 
(void) - setFaceScaleLevel:
 
(void) - setFaceVLevel:
 
(void) - setChinLevel:
 
(void) - setFaceShortLevel:
 
(void) - setNoseSlimLevel:
 
(void) - selectMotionTmpl:
 
(void) - setMotionMute:
 
(void) - startScreenCapture:
 
(void) - setFilter:
 
(void) - setFilterConcentration:
 
(void) - setGreenScreenFile:
 
(void) - playBGM:withBeginNotify:withProgressNotify:andCompleteNotify:
 
(void) - stopBGM
 
(void) - pauseBGM
 
(void) - resumeBGM
 
(NSInteger) - getBGMDuration:
 
(int) - setBGMPosition:
 
(void) - setBGMVolume:
 
(void) - setBGMPlayoutVolume:
 
(void) - setBGMPublishVolume:
 
(void) - setReverbType:
 
(void) - setVoiceChangerType:
 
(void) - playAudioEffect:
 
(void) - setAudioEffectVolume:volume:
 
(void) - stopAudioEffect:
 
(void) - stopAllAudioEffects
 
(void) - setAllAudioEffectsVolume:
 
(void) - pauseAudioEffect:
 
(void) - resumeAudioEffect:
 
(void) - enableAudioEarMonitoring:
 
(void) - startRemoteView:view:
 
(void) - stopRemoteView:
 
(void) - setRemoteViewFillMode:mode:
 
(void) - setRemoteViewRotation:rotation:
 
(void) - setLocalViewFillMode:
 
(void) - setLocalViewRotation:
 
(void) - setLocalViewMirror:
 
(void) - setLocalViewMirror:
 
(void) - startRemoteSubStreamView:view:
 
(void) - stopRemoteSubStreamView:
 
(void) - setRemoteSubStreamViewFillMode:mode:
 
(void) - setRemoteSubStreamViewRotation:rotation:
 
(void) - setPriorRemoteVideoStreamType:
 
(void) - setAudioQuality:
 
(void) - startLocalAudio
 
(void) - switchCamera
 
(BOOL) - isCameraZoomSupported
 
(void) - setZoom:
 
(BOOL) - isCameraTorchSupported
 
(BOOL) - enbaleTorch:
 
(BOOL) - isCameraFocusPositionInPreviewSupported
 
(void) - setFocusPosition:
 
(BOOL) - isCameraAutoFocusFaceModeSupported
 
(void) - enableAutoFaceFoucs:
 
(void) - startCameraDeviceTestInView:
 
(void) - stopCameraDeviceTest
 
(void) - startMicDeviceTest:testEcho:
 
(void) - stopMicDeviceTest
 
(void) - startSpeakerDeviceTest:onVolumeChanged:
 
(void) - stopSpeakerDeviceTest
 
(NSArray< TRTCMediaDeviceInfo * > *) - getMicDevicesList
 
(TRTCMediaDeviceInfo *) - getCurrentMicDevice
 
(int) - setCurrentMicDevice:
 
(float) - getCurrentMicDeviceVolume
 
(void) - setCurrentMicDeviceVolume:
 
(BOOL) - getCurrentMicDeviceMute
 
(void) - setCurrentMicDeviceMute:
 
(NSArray< TRTCMediaDeviceInfo * > *) - getSpeakerDevicesList
 
(TRTCMediaDeviceInfo *) - getCurrentSpeakerDevice
 
(int) - setCurrentSpeakerDevice:
 
(float) - getCurrentSpeakerDeviceVolume
 
(int) - setCurrentSpeakerDeviceVolume:
 
(BOOL) - getCurrentSpeakerDeviceMute
 
(void) - setCurrentSpeakerDeviceMute:
 
(NSArray< TRTCMediaDeviceInfo * > *) - getCameraDevicesList
 
(TRTCMediaDeviceInfo *) - getCurrentCameraDevice
 
(int) - setCurrentCameraDevice:
 
(void) - setSystemVolumeType:
 
(void) - snapshotVideo:type:completionBlock:
 
(void) - enableCustomVideoCapture:
 
(void) - sendCustomVideoData:
 
(void) - startScreenCaptureInApp:
 
(void) - startScreenCaptureByReplaykit:appGroup:
 
(void) - muteLocalVideo:
 
(void) - muteRemoteVideoStream:mute:
 

函数文档

◆ addExcludedShareWindow:()

- (void) addExcludedShareWindow: (NSInteger)  windowID

将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)

加入排除列表中的窗口不会被分享出去,常见的用法是将某个应用的窗口加入到排除列表中以避免隐私问题。 支持启动屏幕分享前设置过滤窗口,也支持屏幕分享过程中动态添加过滤窗口。

参数
windowID不希望分享出去的窗口
注意
  1. 该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效,即只有在分享整个屏幕内容时,排除指定窗口的功能才生效。
  2. 使用该接口添加到排除列表中的窗口会在退出房间后被 SDK 自动清除。
  3. Mac 平台下请传入窗口 ID(即 CGWindowID),您可以通过 TRTCScreenCaptureSourceInfo 中的 sourceId 成员获得。

◆ addIncludedShareWindow:()

- (void) addIncludedShareWindow: (NSInteger)  windowID

将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)

该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。即只有在分享窗口内容时,额外包含指定窗口的功能才生效。 您在 startScreenCapture 之前和之后调用均可。

参数
windowID希望被分享出去的窗口(Windows 平台下为窗口句柄: HWND)
注意
通过该方法添加到包含列表中的窗口,会在退出房间后被 SDK 自动清除。

◆ callExperimentalAPI:()

- (void) callExperimentalAPI: (NSString *)  jsonStr

调用实验性接口

◆ connectOtherRoom:()

- (void) connectOtherRoom: (NSString *)  param

请求跨房通话

默认情况下,只有同一个房间中的用户之间可以进行音视频通话,不同的房间之间的音视频流是相互隔离的。 但您可以通过调用该接口,将另一个房间中某个主播音视频流发布到自己所在的房间中,与此同时,该接口也会将自己的音视频流发布到目标主播的房间中。 也就是说,您可以使用该接口让身处两个不同房间中的主播进行跨房间的音视频流分享,从而让每个房间中的观众都能观看到这两个主播的音视频。该功能可以用来实现主播之间的 PK 功能。 跨房通话的请求结果会通过 TRTCCloudDelegate 中的 onConnectOtherRoom() 回调通知给您。 例如:当房间“101”中的主播 A 通过 connectOtherRoom() 跟房间“102”中的主播 B 建立跨房通话后,

  • 房间“101”中的用户都会收到主播 B 的 onRemoteUserEnterRoom(B) 和 onUserVideoAvailable(B,YES) 这两个事件回调,即房间“101”中的用户都可以订阅主播 B 的音视频。
  • 房间“102”中的用户都会收到主播 A 的 onRemoteUserEnterRoom(A) 和 onUserVideoAvailable(A,YES) 这两个事件回调,即房间“102”中的用户都可以订阅主播 A 的音视频。
                房间 101                     房间 102
              -------------               ------------
 跨房通话前:| 主播 A      |             | 主播 B     |
             | 观众 U V W  |             | 观众 X Y Z |
              -------------               ------------
                房间 101                     房间 102
              -------------               ------------
 跨房通话后:| 主播 A B    |             | 主播 B A   |
             | 观众 U V W  |             | 观众 X Y Z |
              -------------               ------------

跨房通话的参数考虑到后续扩展字段的兼容性问题,暂时采用了 JSON 格式的参数:

【情况一:数字房间号】 如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦,那么主播 A 调用该接口时需要传入:{"roomId": 102, "userId": "userB"} 示例代码如下:

  NSMutableDictionaryjsonDict = [[NSMutableDictionary alloc] init];
  [jsonDict setObject:@(102) forKey:"roomId"];
  [jsonDict setObject:@"userB" forKey:@"userId"];
  NSData* jsonData = [NSJSONSerialization dataWithJSONObject:jsonDict options:NSJSONWritingPrettyPrinted error:nil];
  NSString* jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
  [trtc connectOtherRoom:jsonString];

【情况二:字符串房间号】 如果您使用的是字符串房间号,务必请将 json 中的 “roomId” 替换成 “strRoomId”: {"strRoomId": "102", "userId": "userB"} 示例代码如下:

  NSMutableDictionaryjsonDict = [[NSMutableDictionary alloc] init];
  [jsonDict setObject:"102" forKey:@"strRoomId"];
  [jsonDict setObject:@"userB" forKey:@"userId"];
  NSData* jsonData = [NSJSONSerialization dataWithJSONObject:jsonDict options:NSJSONWritingPrettyPrinted error:nil];
  NSString* jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
  [trtc connectOtherRoom:jsonString];
参数
param需要你传入 JSON 格式的字符串参数,roomId 代表数字格式的房间号,strRoomId 代表字符串格式的房间号,userId 代表目标主播的用户ID。

◆ createSubCloud()

- (TRTCCloud *) createSubCloud

创建子房间示例(用于多房间并发观看)

TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的能力。 通过调用该接口,您可以创建出多个 TRTCCloud 实例,以便同时进入多个不同的房间观看音视频流。 但需要注意的是,由于摄像头和麦克风还是只有一份,因此您只能同时在一个 TRTCCloud 实例中以“主播”的身份存在,也就是您只能同时在一个 TRTCCloud 实例中发布自己的音视频流。 该功能主要用于在线教育场景中一种被称为“超级小班课”的业务场景中,用于解决“每个 TRTC 的房间中最多只能有 50 人同时发布自己音视频流”的限制。 示例代码如下:

    TRTCCloud *mainCloud = [TRTCCloud sharedInstance];
    [mainCloud enterRoom:params1 appScene:TRTCAppSceneLIVE)];
    //...
    //Switch the role from "anchor" to "audience" in your own room
    [mainCloud switchRole:TRTCRoleAudience];
    [mainCloud muteLocalVideo:true];
    [mainCloud muteLocalAudio:true];
    //...
    //Use subcloud to enter another room and switch the role from "audience" to "anchor"
    TRTCCloud *subCloud = [mainCloud createSubCloud];
    [subCloud enterRoom:params2 appScene:TRTCAppSceneLIVE)];
    [subCloud switchRole:TRTCRoleAnchor];
    [subCloud muteLocalVideo:false];
    [subCloud muteLocalAudio:false];
    //...
    //Exit from new room and release it.
    [subCloud exitRoom];
    [mainCloud destroySubCloud:subCloud];
注意
  • 同一个用户,可以使用同一个 userId 进入多个不同 roomId 的房间。
  • 两台不同的终端设备不可以同时使用同一个 userId 进入同一个 roomId 的房间。
  • 同一个用户,同时只能在一个 TRTCCloud 实例中推流,在不同房间同时推流会引发云端的状态混乱,导致各种 bug。
  • 通过 createSubCloud 接口创建出来的 TRTCCloud 实例有一个能力限制:不能调用子实例中与本地音视频相关的接口(除 switchRole、muteLocalVideo 和 muteLocalAudio 之外), 设置美颜等接口请使用原 TRTCCloud 实例对象。
返回
子 TRTCCloud 实例

◆ destroySharedIntance()

+ (void) destroySharedIntance

销毁 TRTCCloud 实例(单例模式)

◆ destroySubCloud:()

- (void) destroySubCloud: (TRTCCloud *)  subCloud

销毁子房间示例

参数
subCloud

◆ disconnectOtherRoom()

- (void) disconnectOtherRoom

退出跨房通话

退出结果会通过 TRTCCloudDelegate 中的 onDisconnectOtherRoom() 回调通知给您。

◆ enableAudioEarMonitoring:()

- (void) enableAudioEarMonitoring: (BOOL)  enable

开启(或关闭)耳返

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setVoiceEarMonitor 替代之。

◆ enableAudioVolumeEvaluation:()

- (void) enableAudioVolumeEvaluation: (NSUInteger)  interval

启用音量大小提示

开启此功能后,SDK 会在 TRTCCloudDelegate 中的 onUserVoiceVolume 回调中反馈远端音频的音量大小。

注意
如需打开此功能,请在 startLocalAudio 之前调用才可以生效。
参数
interval设置 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于 0 则会关闭回调,建议设置为300ms;

◆ enableAutoFaceFoucs:()

- (void) enableAutoFaceFoucs: (BOOL)  enable

开启/关闭人脸跟踪对焦

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 enableCameraAutoFocus 接口替代之。

◆ enableCustomAudioCapture:()

- (void) enableCustomAudioCapture: (BOOL)  enable

启用音频自定义采集模式

开启该模式后,SDK 不在运行原有的音频采集流程,即不再继续从麦克风采集音频数据,而是只保留音频编码和发送能力。 您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。

参数
enable是否启用,默认值:false。
注意
由于回声抵消(AEC)需要严格的控制声音采集和播放的时间,所以开启自定义音频采集后,AEC 能力可能会失效。

◆ enableCustomAudioRendering:()

- (void) enableCustomAudioRendering: (BOOL)  enable

开启音频自定义播放

如果您需要外接一些特定的音频设备,或者希望自己掌控音频的播放逻辑,您可以通过该接口启用音频自定义播放。 启用音频自定义播放后,SDK 将不再调用系统的音频接口播放数据,您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。

参数
enable是否启用音频自定义播放,默认为关闭状态。
注意
需要您在进入房间前设置才能生效,暂不支持进入房间后再设置。

◆ enableCustomVideoCapture:()

- (void) enableCustomVideoCapture: (BOOL)  enable

启用视频自定义采集模式

弃用:
v8.5 版本开始不推荐使用,建议使用 enableCustomVideoCapture(streamType,enable) 接口替代之。

◆ enableCustomVideoCapture:enable:()

- (void) enableCustomVideoCapture: (TRTCVideoStreamType streamType
enable: (BOOL)  enable 

启用/关闭视频自定义采集模式

开启该模式后,SDK 不在运行原有的视频采集流程,即不再继续从摄像头采集数据和美颜,而是只保留视频编码和发送能力。 您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。

参数
streamType用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。
enable是否启用,默认值:false。

◆ enableEncSmallVideoStream:withQuality:()

- (int) enableEncSmallVideoStream: (BOOL)  enable
withQuality: (TRTCVideoEncParam *)  smallVideoEncParam 

开启大小画面双路编码模式

开启双路编码模式后,当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流(但只有一路音频流)。 如此以来,房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。

注意
双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以 Mac、Windows 或者高性能 Pad 可以考虑开启,不建议手机端开启。
参数
enable是否开启小画面编码,默认值:false
smallVideoEncParam小流的视频参数
返回
0:成功;-1:当前大画面已被设置为较低画质,开启双路编码已无必要。

◆ enableMixExternalAudioFrame:playout:()

- (void) enableMixExternalAudioFrame: (BOOL)  enablePublish
playout: (BOOL)  enablePlayout 

启用/关闭自定义音轨

开启后,您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数,您可以控制该音轨是否要在远端和本地播放。

参数
enablePublish控制混入的音轨是否要在远端播放,默认值:false。
enablePlayout控制混入的音轨是否要在本地播放,默认值:false。
注意
如果您指定参数 enablePublish 和 enablePlayout 均为 false,代表完全关闭您的自定义音轨。

◆ enbaleTorch:()

- (BOOL) enbaleTorch: (BOOL)  enable

开关/关闭闪光灯

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 enableCameraTorch 接口替代之。

◆ enterRoom:appScene:()

- (void) enterRoom: (TRTCParams *)  param
appScene: (TRTCAppScene scene 

进入房间

TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流,“发布”是指将自己的音频和视频推送到云端,“订阅”是指从云端拉取房间里其他用户的音视频流。 调用该接口时,您需要指定您的应用场景 TRTCAppScene 以获取最佳的音视频传输体验,这些场景可以分成两大类:

【直播场景(Live)】

  • 包括 TRTCAppSceneLIVETRTCAppSceneVoiceChatRoom
  • 此类场景下,每一个房间最多同时容纳 10 万人,但需要您通过 TRTCParams 中的 “role” 字段设定用户是“主播”(TRTCRoleAnchor)还是“观众”(TRTCRoleAudience)。
  • 主播可以“发布”自己的音视频流,观众只能“订阅”别人的音视频流,每一个用户都可以在主播和观众两种角色间通过 switchRole 接口进行切换。
  • 适用于[视频低延时直播]、[十万人互动课堂]、[直播PK]、[音乐直播间]、[在线K歌]、[远程培训]、[超大型会议]等业务形态。

【实时场景(RTC)】

  • 包括 TRTCAppSceneVideoCallTRTCAppSceneAudioCall
  • 此类场景下,每一个房间最多同时容纳 300 人在线,最高支持 50 人同时发言。
  • 适用于 [1对1视频通话]、[300人视频会议]、[在线问诊]、[语音聊天]、[教育小班课]、[远程面试]、[在线狼人杀]等业务形态。

调用该接口后,您会收到来自 TRTCCloudDelegate 中的 onEnterRoom(result) 回调:

  • 如果进房成功,参数 result 会是一个正数(result > 0),表示从函数调用到进入房间所花费的时间,单位是毫秒(ms)。
  • 如果进房失败,参数 result 会是一个负数(result < 0),表示进房失败的错误码
参数
param进房参数,用于指定用户的身份、角色和安全票据等信息,详情请参考 TRTCParams
scene应用场景,用于指定您的业务场景,同一个房间内的所有用户需要设定相同的 TRTCAppScene
注意
  1. 同一个房间内的所有用户需要设定相同的 scene。不同的 scene 会导致偶现的异常问题。
  2. 当您指定参数 scene 为 TRTCAppSceneLIVETRTCAppSceneVoiceChatRoom 时,您必须通过 TRTCParams 中的 “role” 字段为当前用户设定他/她在房间中的角色。
  3. 请您尽量保证 enterRoomexitRoom 前后配对使用,即保证”先退出前一个房间再进入下一个房间”,否则会导致很多异常问题。

◆ exitRoom()

- (void) exitRoom

离开房间

调用该接口会让用户离开自己所在的音视频房间,并释放摄像头、麦克风、扬声器等设备资源。 等资源释放完毕之后,SDK 会通过 TRTCCloudDelegate 中的 onExitRoom() 回调向您通知。 如果您要再次调用 enterRoom 或者切换到其他的供应商的 SDK,建议等待 onExitRoom() 回调到来之后再执行之后的操作,以避免摄像头或麦克风被占用的问题。

◆ generateCustomPTS()

+ (uint64_t) generateCustomPTS

生成自定义采集时的时间戳

本接口仅适用于自定义采集模式,用于解决音视频帧的采集时间(capture time)和投送时间(send time)不一致所导致的音画不同步问题。 当您通过 sendCustomVideoDatasendCustomAudioData 等接口进行自定义视频或音频采集时,请按照如下操作使用该接口:

  1. 首先,在采集到一帧视频或音频帧时,通过调用本接口获得当时的 PTS 时间戳。
  2. 之后可以将该视频或音频帧送入您使用的前处理模块(如第三方美颜组件,或第三方音效组件)。
  3. 在真正调用 sendCustomVideoDatasendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrameTRTCAudioFrame 中的 timestamp 字段。
返回
时间戳(单位:ms)

◆ getAudioCaptureVolume()

- (NSInteger) getAudioCaptureVolume

获取本地音频的采集音量

◆ getAudioEffectManager()

- (TXAudioEffectManager *) getAudioEffectManager

获取音效管理类(TXAudioEffectManager)

TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如下功能:

  • 背景音乐:支持在线音乐和本地音乐,支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
  • 耳机耳返:麦克风捕捉的声音实时通过耳机播放,常用于音乐直播。
  • 混响效果:KTV、小房间、大会堂、低沉、洪亮...
  • 变声特效:萝莉、大叔、重金属...
  • 短音效:鼓掌声、欢笑声等简短的音效文件(对于小于10秒的文件,请将 isShortFile 参数设置为 true)。

◆ getAudioPlayoutVolume()

- (NSInteger) getAudioPlayoutVolume

获取远端音频的播放音量

◆ getBeautyManager()

- (TXBeautyManager *) getBeautyManager

获取美颜管理类(TXBeautyManager)

通过美颜管理,您可以使用以下功能:

  • 设置"磨皮"、“美白”、“红润”等美颜特效。
  • 设置“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等修脸特效。
  • 设置“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”等修脸特效。
  • 设置"眼影"、“腮红”等美妆特效。
  • 设置动态贴纸和人脸挂件等动画特效。

◆ getBGMDuration:()

- (NSInteger) getBGMDuration: (NSString *)  path

获取背景音乐总时长(单位:毫秒)

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#getMusicDurationInMS 替代之。

◆ getCameraDevicesList()

- (NSArray<TRTCMediaDeviceInfo *> *) getCameraDevicesList

获取摄像头设备列表

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getDevicesList 接口替代之。

◆ getCurrentCameraDevice()

- (TRTCMediaDeviceInfo *) getCurrentCameraDevice

获取当前使用的摄像头

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDevice 接口替代之。

◆ getCurrentMicDevice()

- (TRTCMediaDeviceInfo *) getCurrentMicDevice

获取当前的麦克风设备

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDevice 接口替代之。

◆ getCurrentMicDeviceMute()

- (BOOL) getCurrentMicDeviceMute

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

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDeviceMute 接口替代之。

◆ getCurrentMicDeviceVolume()

- (float) getCurrentMicDeviceVolume

获取当前麦克风的设备音量

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDeviceVolume 接口替代之。

◆ getCurrentSpeakerDevice()

- (TRTCMediaDeviceInfo *) getCurrentSpeakerDevice

获取当前的扬声器设备

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDevice 接口替代之。

◆ getCurrentSpeakerDeviceMute()

- (BOOL) getCurrentSpeakerDeviceMute

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

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDeviceMute 接口替代之。

◆ getCurrentSpeakerDeviceVolume()

- (float) getCurrentSpeakerDeviceVolume

获取当前扬声器的设备音量

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getCurrentDeviceVolume 接口替代之。

◆ getCustomAudioRenderingFrame:()

- (void) getCustomAudioRenderingFrame: (TRTCAudioFrame *)  audioFrame

获取可播放的音频数据

调用该接口之前,您需要先通过 enableCustomAudioRendering 开启音频自定义播放。 参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):

  • sampleRate:采样率,必填,支持 16000、24000、32000、44100、48000。
  • channel:声道数,必填,单声道请填1,双声道请填2,双声道时数据是交叉的。
  • data:用于获取音频数据的 buffer。需要您根据一阵音频帧的帧长度分配好 date 的内存大小。 获取的 PCM 数据支持 10ms 或 20ms 两种帧长,推荐使用 20ms 的帧长。 计算公式为:48000采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节。
参数
audioFrame音频数据帧。
注意
  1. 参数 audioFrame 中的 sampleRate、channel 需提前设置好,同时分配好所需读取帧长的 data 空间。
  2. SDK 内部会根据 sampleRate 和 channel 自动填充 data 数据。
  3. 建议由系统的音频播放线程直接驱动该函数的调用,在播放完一帧音频之后,即调用该接口获取下一帧可播放的音频数据。

◆ getDeviceManager()

- (TXDeviceManager *) getDeviceManager

获取设备管理类(TXDeviceManager)

◆ getMicDevicesList()

- (NSArray<TRTCMediaDeviceInfo *> *) getMicDevicesList

获取麦克风设备列表

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getDevicesList 接口替代之。

◆ getScreenCaptureSourcesWithThumbnailSize:iconSize:()

- (NSArray<TRTCScreenCaptureSourceInfo *> *) getScreenCaptureSourcesWithThumbnailSize: (CGSize)  thumbnailSize
iconSize: (CGSize)  iconSize 

枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)

当您在对接桌面端系统的屏幕分享功能时,一般都需要展示一个选择分享目标的界面,这样用户能够使用这个界面选择是分享整个屏幕还是某个窗口。 通过本接口,您就可以查询到当前系统中可用于分享的窗口的 ID、名称以及缩略图。我们在 Demo 中提供了一份默认的界面实现供您参考。

注意
返回的列表中包含屏幕和应用窗口,屏幕是列表中的第一个元素。如果用户有多个显示器,那么每个显示器都是一个分享目标。
参数
thumbnailSize指定要获取的窗口缩略图大小,缩略图可用于绘制在窗口选择界面上
iconSize指定要获取的窗口图标大小
返回
窗口列表包括屏幕

◆ getSDKVersion()

+ (NSString *) getSDKVersion

获取 SDK 版本信息

◆ getSpeakerDevicesList()

- (NSArray<TRTCMediaDeviceInfo *> *) getSpeakerDevicesList

获取扬声器设备列表

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 getDevicesList 接口替代之。

◆ init()

- (instancetype) init

◆ isCameraAutoFocusFaceModeSupported()

- (BOOL) isCameraAutoFocusFaceModeSupported

查询是否支持自动识别人脸位置

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 isAutoFocusEnabled 接口替代之。

◆ isCameraFocusPositionInPreviewSupported()

- (BOOL) isCameraFocusPositionInPreviewSupported

查询摄像头是否支持设置焦点

弃用:
v8.0 版本开始不推荐使用。

◆ isCameraTorchSupported()

- (BOOL) isCameraTorchSupported

查询是否支持开关闪光灯

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 isCameraTorchSupported 接口替代之。

◆ isCameraZoomSupported()

- (BOOL) isCameraZoomSupported

查询当前摄像头是否支持缩放

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 isCameraZoomSupported 接口替代之。

◆ mixExternalAudioFrame:()

- (int) mixExternalAudioFrame: (TRTCAudioFrame *)  frame

向 SDK 混入自定义音轨

调用该接口之前,您需要先通过 enableMixExternalAudioFrame 开启自定义音轨,之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。 理想情况下,我们期望您的代码能够以非常均匀的速度向 SDK 提供音轨数据。但我们也非常清楚,完美的调用间隔是一个巨大的挑战。 所以 SDK 内部会开启一个音轨数据的缓冲区,该缓冲区的作用类似一个“蓄水池”,它能够暂存您传入的音轨数据,平抑由于接口调用间隔的抖动问题。 本接口的返回值代表这个音轨缓冲区的大小,单位是毫秒(ms),比如:如果该接口返回 50,则代表当前的音轨缓冲区有 50ms 的音轨数据。因此只要您在 50ms 内再次调用本接口,SDK 就能保证您混入的音轨数据是连续的。 当您调用该接口后,如果发现返回值 > 100ms,则可以等待一帧音频帧的播放时间之后再次调用;如果返回值 < 100ms,则代表缓冲区比较小,您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。 参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):

  • data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持[5ms ~ 100ms]帧长,推荐使用 20ms 帧长,长度计算方法:【48000采样率、单声道的帧长度:48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
  • sampleRate:采样率,支持:16000、24000、32000、44100、48000。
  • channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
  • timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在获得一帧音频帧之后,通过调用 generateCustomPTS 获得时间戳)。
参数
frame音频数据
返回
>= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用 mixExternalAudioFrame)
注意
请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。

◆ muteAllRemoteAudio:()

- (void) muteAllRemoteAudio: (BOOL)  mute

暂停/恢复播放所有远端用户的音频流

当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。

参数
mutetrue:静音;false:取消静音。
注意
在进入房间(enterRoom)之前或之后调用本接口均生效,静音状态在退出房间(exitRoom) 之后会被重置为 false。

◆ muteAllRemoteVideoStreams:()

- (void) muteAllRemoteVideoStreams: (BOOL)  mute

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

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

参数
mute是否暂停接收
注意
该接口支持您在进入房间(enterRoom)前调用,暂停状态会在退出房间(exitRoom)在之后会被重置。

◆ muteLocalAudio:()

- (void) muteLocalAudio: (BOOL)  mute

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

当您暂停发布本地音频流之后,房间中的其他他用户会收到 onUserAudioAvailable(userId, false) 的通知。 当您恢复发布本地音频流之后,房间中的其他他用户会收到 onUserAudioAvailable(userId, true) 的通知。 与 stopLocalAudio 的不同之处在于,muteLocalAudio(true) 并不会释放麦克风权限,而是继续发送码率极低的静音包。 这对于需要云端录制的场景非常适用,因为 MP4 等格式的视频文件,对于音频数据的连续性要求很高,使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。 因此在对录制文件的质量要求较高的场景中,建议选择 muteLocalAudio 而不建议使用 stopLocalAudio。

参数
mutetrue:静音;false:恢复。

◆ muteLocalVideo:()

- (void) muteLocalVideo: (BOOL)  mute

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

弃用:
v8.9 版本开始不推荐使用,建议使用 muteLocalVideo(streamType, mute) 接口替代之。

◆ muteLocalVideo:mute:()

- (void) muteLocalVideo: (TRTCVideoStreamType streamType
mute: (BOOL)  mute 

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

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

参数
streamType要暂停/恢复的视频流类型(仅支持 TRTCVideoStreamTypeBigTRTCVideoStreamTypeSub
mutetrue:暂停;false:恢复。

◆ muteRemoteAudio:mute:()

- (void) muteRemoteAudio: (NSString *)  userId
mute: (BOOL)  mute 

暂停/恢复播放远端的音频流

当您静音某用户的远端音频时,SDK 会停止播放指定用户的声音,同时也会停止拉取该用户的音频数据数据。

参数
userId用于指定远端用户的 ID。
mutetrue:静音;false:取消静音。
注意
在进入房间(enterRoom)之前或之后调用本接口均生效,静音状态在退出房间(exitRoom) 之后会被重置为 false。

◆ muteRemoteVideoStream:mute:()

- (void) muteRemoteVideoStream: (NSString *)  userId
mute: (BOOL)  mute 

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

弃用:
v8.9 版本开始不推荐使用,建议使用 muteRemoteVideoStream(userId, streamType, mute) 接口替代之。

◆ muteRemoteVideoStream:streamType:mute:()

- (void) muteRemoteVideoStream: (NSString *)  userId
streamType: (TRTCVideoStreamType streamType
mute: (BOOL)  mute 

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

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

参数
userId指定远端用户的 ID。
streamType要暂停/恢复的视频流类型(仅支持 TRTCVideoStreamTypeBigTRTCVideoStreamTypeSub)。
mute是否暂停接收。
注意
该接口支持您在进入房间(enterRoom)前调用,暂停状态会在退出房间(exitRoom)在之后会被重置。

◆ new()

+ (instancetype) new

◆ pauseAudioEffect:()

- (void) pauseAudioEffect: (int)  effectId

暂停音效

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#pauseAudioEffect 替代之。

◆ pauseBGM()

- (void) pauseBGM

停止播放背景音乐

弃用:
v7.3 版本开始不推荐使用,建议使用 getAudioEffectManager 替代之。

◆ pauseScreenCapture()

- (int) pauseScreenCapture

暂停屏幕分享

◆ playAudioEffect:()

- (void) playAudioEffect: (TRTCAudioEffectParam *)  effect

播放音效

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#startPlayMusic 替代之。

◆ playBGM:withBeginNotify:withProgressNotify:andCompleteNotify:()

- (void) playBGM: (NSString *)  path
withBeginNotify: (void(^)(NSInteger errCode))  beginNotify
withProgressNotify: (void(^)(NSInteger progressMS, NSInteger durationMS))  progressNotify
andCompleteNotify: (void(^)(NSInteger errCode))  completeNotify 

启动播放背景音乐

弃用:
v7.3 版本开始不推荐使用,建议使用 getAudioEffectManager 替代之。

◆ removeAllExcludedShareWindows()

- (void) removeAllExcludedShareWindows

将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)

◆ removeAllIncludedShareWindows()

- (void) removeAllIncludedShareWindows

将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)

该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。 即只有在分享窗口内容时,额外包含指定窗口的功能才生效。

◆ removeExcludedShareWindow:()

- (void) removeExcludedShareWindow: (NSInteger)  windowID

将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)

参数
windowID

◆ removeIncludedShareWindow:()

- (void) removeIncludedShareWindow: (NSInteger)  windowID

将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)

该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。 即只有在分享窗口内容时,额外包含指定窗口的功能才生效。

参数
windowID希望被分享出去的窗口(Mac 平台: 窗口 ID;Windows 平台: HWND)

◆ resumeAudioEffect:()

- (void) resumeAudioEffect: (int)  effectId

暂停音效

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#resumePlayMusic 替代之。

◆ resumeBGM()

- (void) resumeBGM

停止播放背景音乐

弃用:
v7.3 版本开始不推荐使用,建议使用 getAudioEffectManager 替代之。

◆ resumeScreenCapture()

- (int) resumeScreenCapture

恢复屏幕分享

◆ selectMotionTmpl:()

- (void) selectMotionTmpl: (NSString *)  tmplPath

设置动效贴纸

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ selectScreenCaptureTarget:rect:capturesCursor:highlight:()

- (void) selectScreenCaptureTarget: (TRTCScreenCaptureSourceInfo *)  screenSource
rect: (CGRect)  rect
capturesCursor: (BOOL)  capturesCursor
highlight: (BOOL)  highlight 

选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)

当您通过 getScreenCaptureSources 获取到可以分享的屏幕和窗口之后,您可以调用该接口选定期望分享的目标屏幕或目标窗口。 在屏幕分享的过程中,您也可以随时调用该接口以切换分享目标。

参数
screenSource指定分享源
rect指定捕获的区域(设定该参数为 CGRectZero:当分享目标是某个窗口时则分享整个窗口,当分享目标是桌面时则分享整个桌面)
capturesCursor是否捕获鼠标光标
highlight是否高亮正在分享的窗口

◆ sendCustomAudioData:()

- (void) sendCustomAudioData: (TRTCAudioFrame *)  frame

向 SDK 投送自己采集的音频数据

参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):

  • audioFormat:音频数据格式,仅支持 TRTCAudioFrameFormatPCM。
  • data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持[5ms ~ 100ms]帧长,推荐使用 20ms 帧长,长度计算方法:【48000采样率、单声道的帧长度:48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
  • sampleRate:采样率,支持:16000、24000、32000、44100、48000。
  • channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
  • timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在采集到一帧音频帧之后,通过调用 generateCustomPTS 获取时间戳)。

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

参数
frame音频数据
注意
请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。

◆ sendCustomCmdMsg:data:reliable:ordered:()

- (BOOL) sendCustomCmdMsg: (NSInteger)  cmdID
data: (NSData *)  data
reliable: (BOOL)  reliable
ordered: (BOOL)  ordered 

使用 UDP 通道发送自定义消息给房间内所有用户

该接口可以让您借助 TRTC 的 UDP 通道,向当前房间里的其他用户广播自定义数据,已达到传输信令的目的。 TRTC 中的 UDP 通道原本设计用来传输音视频数据的,该接口的原理是将您要发送的信令伪装成音视频数据包,与原本要发送的音视频数据一并发送出去。 房间中的其他用户可以通过 TRTCCloudDelegate 中的 onRecvCustomCmdMsg 回调接收消息。

参数
cmdID消息 ID,取值范围为1 - 10。
data待发送的消息,单个消息的最大长度被限制为 1KB。
reliable是否可靠发送,可靠发送可以获得更高的发送成功率,但可靠发送比不可靠发送会带来更大的接收延迟。
ordered是否要求有序,即是否要求接收端的数据包顺序和发送端的数据包顺序一致(这会带来一定的接收延时)。
返回
true:消息已经发出;false:消息发送失败。
注意
  1. 发送消息到房间内所有用户(暂时不支持 Web/小程序端),每秒最多能发送30条消息。
  2. 每个包最大为 1KB,超过则很有可能会被中间路由器或者服务器丢弃。
  3. 每个客户端每秒最多能发送总计 8KB 数据。
  4. 请将 reliable 和 ordered 同时设置为 true 或同时设置为 flase,暂不支持交叉设置。
  5. 强烈建议您将不同类型的消息设定为不同的 cmdID,这样可以在要求有序的情况下减小消息时延。

◆ sendCustomVideoData:()

- (void) sendCustomVideoData: (TRTCVideoFrame *)  frame

投送自己采集的视频数据

弃用:
v8.5 版本开始不推荐使用,建议使用 sendCustomVideoData(streamType, TRTCVideoFrame) 接口替代之。

◆ sendCustomVideoData:frame:()

- (void) sendCustomVideoData: (TRTCVideoStreamType streamType
frame: (TRTCVideoFrame *)  frame 

向 SDK 投送自己采集的视频帧

使用此接口可以向 SDK 投送自己采集的视频帧,SDK 会将视频帧进行编码并通过自身的网络模块传输出去。 参数 TRTCVideoFrame 推荐下列填写方式(其他字段不需要填写):

  • pixelFormat:推荐选择 TRTCVideoPixelFormat_NV12
  • bufferType:推荐选择 TRTCVideoBufferType_PixelBuffer
  • pixelBuffer:iOS/Mac OS 平台上常用的视频数据格式。
  • data:视频裸数据格式,bufferType 为 NSData 时使用。
  • timestamp:时间戳,单位为毫秒(ms),请使用视频帧在采集时被记录下来的时间戳(可以在采集到一帧视频帧之后,通过调用 generateCustomPTS 获取时间戳)。
  • width:视频图像长度,bufferType 为 NSData 时填写。
  • height:视频图像宽度,bufferType 为 NSData 时填写。

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

参数
streamType用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。
frame视频数据,支持 PixelBuffer NV12,BGRA 以及 I420 格式数据。
注意
  1. 推荐您在采集到的一帧视频帧后,即调用 generateCustomPTS 接口获取该帧的 timestamp 数值,这样可以获得最佳的音画同步效果。
  2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的,而是由您在 setVideoEncoderParam 中所设置的 FPS 决定的。
  3. 请尽量保持本接口的调用间隔是均匀的,否则会导致编码器输出帧率不稳或者音画不同步等问题。

◆ sendSEIMsg:repeatCount:()

- (BOOL) sendSEIMsg: (NSData *)  data
repeatCount: (int)  repeatCount 

使用 SEI 通道发送自定义消息给房间内所有用户

该接口可以让您借助 TRTC 的 SEI 通道,向当前房间里的其他用户广播自定义数据,已达到传输信令的目的。 视频帧的头部有一个叫做 SEI 的头部数据块,该接口的原理就是利用这个被称为 SEI 的头部数据块,将您要发送的自定义信令嵌入其中,使其同视频帧一并发送出去。 因此,与 sendCustomCmdMsg 相比,SEI 通道传输的信令具有更好的兼容性:信令可以伴随着视频帧一直传输到直播 CDN 上。 不过,由于视频帧头部的数据块不能太大,建议您使用该接口时,尽量将信令控制在几个字节的大小。 最常见的用法是把自定义的时间戳(timestamp)用本接口嵌入视频帧中,实现消息和画面的完美对齐(比如:教育场景下的课件和视频信号的对齐)。 房间中的其他用户可以通过 TRTCCloudDelegate 中的 onRecvSEIMsg 回调接收消息。

参数
data待发送的数据,最大支持 1KB(1000字节)的数据大小
repeatCount发送数据次数
返回
YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制发送
注意
本接口有以下限制:
  1. 数据在接口调用完后不会被即时发送出去,而是从下一帧视频帧开始带在视频帧中发送。
  2. 发送消息到房间内所有用户,每秒最多能发送 30 条消息(与 sendCustomCmdMsg 共享限制)。
  3. 每个包最大为 1KB,若发送大量数据,会导致视频码率增大,可能导致视频画质下降甚至卡顿(与 sendCustomCmdMsg 共享限制)。
  4. 每个客户端每秒最多能发送总计8KB数据(与 sendCustomCmdMsg 共享限制)。
  5. 若指定多次发送(repeatCount > 1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。
  6. 如果 repeatCount > 1,多次发送,接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。

◆ setAllAudioEffectsVolume:()

- (void) setAllAudioEffectsVolume: (int)  volume

设置所有音效音量

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setMusicPublishVolumeTXAudioEffectManager#setMusicPlayoutVolume 替代之。

◆ setAudioCaptureVolume:()

- (void) setAudioCaptureVolume: (NSInteger)  volume

设定本地音频的采集音量

参数
volume音量大小,取值范围为0 - 100;默认值:100
注意
如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。

◆ setAudioEffectVolume:volume:()

- (void) setAudioEffectVolume: (int)  effectId
volume: (int)  volume 

设置音效音量

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setMusicPublishVolumeTXAudioEffectManager#setMusicPlayoutVolume 替代之。

◆ setAudioFrameDelegate:()

- (void) setAudioFrameDelegate: (id< TRTCAudioFrameDelegate >)  delegate

设置音频数据自定义回调

设置该回调之后,SDK 内部会把音频数据(PCM 格式)回调出来,包括:

注意
设置回调为空即代表停止自定义音频回调,反之,设置回调不为空则代表启动自定义音频回调。

◆ setAudioPlayoutVolume:()

- (void) setAudioPlayoutVolume: (NSInteger)  volume

设定远端音频的播放音量

该接口会控制 SDK 最终交给系统播放的声音音量,调节效果会影响到本地音频录制文件的音量大小,但不会影响到耳返的音量大小。

参数
volume音量大小,取值范围为0 - 100,默认值:100。
注意
如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。

◆ setAudioQuality:()

- (void) setAudioQuality: (TRTCAudioQuality quality

设置音频质量

弃用:
v8.0 版本开始不推荐使用,建议使用 startLocalAudio:(quality) 替代之。

◆ setAudioRoute:()

- (void) setAudioRoute: (TRTCAudioRoute route

设置音频路由

设置“音频路由”,即设置声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。 手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。

参数
route音频路由,即声音由哪里输出(扬声器、听筒),默认值:TRTCAudioModeSpeakerphone。

◆ setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:()

- (void) setBeautyStyle: (TRTCBeautyStyle beautyStyle
beautyLevel: (NSInteger)  beautyLevel
whitenessLevel: (NSInteger)  whitenessLevel
ruddinessLevel: (NSInteger)  ruddinessLevel 

设置美颜、美白以及红润效果级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setBGMPlayoutVolume:()

- (void) setBGMPlayoutVolume: (NSInteger)  volume

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

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setMusicPlayoutVolume 替代之。

◆ setBGMPosition:()

- (int) setBGMPosition: (NSInteger)  pos

设置背景音乐的播放进度

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#seekMusicToPosInMS 替代之。

◆ setBGMPublishVolume:()

- (void) setBGMPublishVolume: (NSInteger)  volume

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

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setBGMPublishVolume 替代之。

◆ setBGMVolume:()

- (void) setBGMVolume: (NSInteger)  volume

设置背景音乐的音量大小

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setMusicVolume 替代之。

◆ setCapturedRawAudioFrameDelegateFormat:()

- (int) setCapturedRawAudioFrameDelegateFormat: (TRTCAudioFrameDelegateFormat *)  format

设置本地麦克风采集出的原始音频帧回调格式

本接口用于设置 onCapturedRawAudioFrame 回调出来的 AudioFrame 的格式:

  • sampleRate:采样率,支持:16000、32000、44100、48000。
  • channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
  • samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。

如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:采样点数 = 毫秒数 * 采样率 / 1000; 举例:48000 采样率希望回调 20ms 帧长的数据,则采样点数应该填: 960 = 20 * 48000 / 1000; 注意,最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:字节数 = 采样点数 * channel * 2(位宽) 举例:48000 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 3840 = 960 * 2 * 2

参数
format音频数据回调格式。
返回
0:成功;<0:错误

◆ setChinLevel:()

- (void) setChinLevel: (float)  chinLevel

设置下巴拉伸或收缩幅度

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setConsoleEnabled:()

+ (void) setConsoleEnabled: (BOOL)  enabled

启用/禁用控制台日志打印

参数
enabled指定是否启用,默认:禁止状态

◆ setCurrentCameraDevice:()

- (int) setCurrentCameraDevice: (NSString *)  deviceId

选定当前要使用的摄像头

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDevice 接口替代之。

◆ setCurrentMicDevice:()

- (int) setCurrentMicDevice: (NSString *)  deviceId

选定当前使用的麦克风

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDevice 接口替代之。

◆ setCurrentMicDeviceMute:()

- (void) setCurrentMicDeviceMute: (BOOL)  mute

设置系统当前麦克风设备的静音状态

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDeviceMute 接口替代之。

◆ setCurrentMicDeviceVolume:()

- (void) setCurrentMicDeviceVolume: (NSInteger)  volume

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

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDeviceVolume 接口替代之。

◆ setCurrentSpeakerDevice:()

- (int) setCurrentSpeakerDevice: (NSString *)  deviceId

设置要使用的扬声器

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDevice 接口替代之。

◆ setCurrentSpeakerDeviceMute:()

- (void) setCurrentSpeakerDeviceMute: (BOOL)  mute

设置系统当前扬声器设备的静音状态

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDeviceMute 接口替代之。

◆ setCurrentSpeakerDeviceVolume:()

- (int) setCurrentSpeakerDeviceVolume: (NSInteger)  volume

设置当前扬声器的设备音量

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCurrentDeviceVolume 接口替代之。

◆ setDebugViewMargin:margin:()

- (void) setDebugViewMargin: (NSString *)  userId
margin: (TXEdgeInsets margin 

设置仪表盘的边距

用于调整仪表盘在视频渲染控件中的位置,必须在 showDebugView 之前调用才能生效。

参数
userId用户 ID
margin仪表盘内边距,注意这里是基于 parentView 的百分比,margin 的取值范围是0 - 1。

◆ setDefaultStreamRecvMode:video:()

- (void) setDefaultStreamRecvMode: (BOOL)  autoRecvAudio
video: (BOOL)  autoRecvVideo 

设置订阅模式(需要在进入房前设置才能生效)

您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换:

  • 自动订阅:默认模式,用户在进入房间后会立刻接收到该房间中的音视频流,音频会自动播放,视频会自动开始解码(依然需要您通过 startRemoteView 接口绑定渲染控件)。
  • 手动订阅:在用户进入房间后,需要手动调用 {@startRemoteView} 接口才能启动视频流的订阅和解码,需要手动调用 {@muteRemoteAudio} (false) 接口才能启动声音的播放。

在绝大多数场景下,用户进入房间后都会订阅房间中所有主播的音视频流,因此 TRTC 默认采用了自动订阅模式,以求得最佳的“秒开体验”。 如果您的应用场景中每个房间同时会有很多路音视频流在发布,而每个用户只想选择性地订阅其中的 1-2 路,则推荐使用“手动订阅”模式以节省流量费用。

参数
autoRecvAudioYES:自动订阅音频;NO:需手动调用 muteRemoteAudio(false) 订阅音频。默认值:YES。
autoRecvVideoYES:自动订阅视频;NO:需手动调用 startRemoteView 订阅视频。默认值:YES。
注意
  1. 需要在进入房间(enterRoom)前调用该接口,设置才能生效。
  2. 在自动订阅模式下,如果用户在进入房间后没有调用 {@startRemoteView} 订阅视频流,SDK 会自动停止订阅视频流,以便达到节省流量的目的。

◆ setEyeScaleLevel:()

- (void) setEyeScaleLevel: (float)  eyeScaleLevel

设置大眼级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFaceScaleLevel:()

- (void) setFaceScaleLevel: (float)  faceScaleLevel

设置瘦脸级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFaceShortLevel:()

- (void) setFaceShortLevel: (float)  faceShortlevel

设置短脸级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFaceVLevel:()

- (void) setFaceVLevel: (float)  faceVLevel

设置 V 脸级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFilter:()

- (void) setFilter: (TXImage *)  image

设置色彩滤镜效果

弃用:
v7.2 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFilterConcentration:()

- (void) setFilterConcentration: (float)  concentration

设置色彩滤镜浓度

弃用:
v7.2 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setFocusPosition:()

- (void) setFocusPosition: (CGPoint)  touchPoint

设置摄像头焦点坐标位置

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCameraFocusPosition 接口替代之。

◆ setGreenScreenFile:()

- (void) setGreenScreenFile: (NSURL *)  file

设置绿幕背景视频

弃用:
v7.2 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setGSensorMode:()

- (void) setGSensorMode: (TRTCGSensorMode mode

设置重力感应的适配模式

您可以通过本接口实现如下这种友好的交互体验: 当用户将手机或 Pad 上下颠倒时,由于摄像头的采集方向没有变,所以房间中其他用户所看到的画面会变成上下颠倒的, 在这种情况下,您可以通过调用该接口让 SDK 根据设备陀螺仪的朝向自动调整本地画面和编码器输出画面的旋转方向,以使远端观众可以看到正常朝向的画面。

参数
mode重力感应模式,详情请参考 TRTCGSensorMode,默认值:TRTCGSensorMode_UIAutoLayout。

◆ setLocalProcessedAudioFrameDelegateFormat:()

- (int) setLocalProcessedAudioFrameDelegateFormat: (TRTCAudioFrameDelegateFormat *)  format

设置经过前处理后的本地音频帧回调格式

本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式:

  • sampleRate:采样率,支持:16000、32000、44100、48000。
  • channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
  • samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。

如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:采样点数 = 毫秒数 * 采样率 / 1000; 举例:48000 采样率希望回调20ms帧长的数据,则采样点数应该填: 960 = 20 * 48000 / 1000; 注意,最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:字节数 = 采样点数 * channel * 2(位宽) 举例:48000 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 3840 = 960 * 2 * 2

参数
format音频数据回调格式。
返回
0:成功;<0:错误

◆ setLocalRenderParams:()

- (void) setLocalRenderParams: (TRTCRenderParams *)  params

设置本地画面的渲染参数

可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。

参数
params画面渲染参数,详情请参考 TRTCRenderParams

◆ setLocalVideoProcessDelegete:pixelFormat:bufferType:()

- (int) setLocalVideoProcessDelegete: (id< TRTCVideoFrameDelegate >)  delegate
pixelFormat: (TRTCVideoPixelFormat pixelFormat
bufferType: (TRTCVideoBufferType bufferType 

设置第三方美颜的视频数据回调

设置该回调之后,SDK 会把采集到的视频帧通过您设置的 delegate 回调出来,用于第三方美颜组件进行二次处理,之后 SDK 会将处理后的视频帧进行编码和发送。

参数
delegate自定义预处理回调,详见 TRTCVideoFrameDelegate
pixelFormat指定回调的像素格式,目前仅支持 TRTCVideoPixelFormat_Texture_2D
bufferType指定回调的数据格式,目前仅支持 TRTCVideoBufferType_Texture
返回
0:成功;<0:错误

◆ setLocalVideoRenderDelegate:pixelFormat:bufferType:()

- (int) setLocalVideoRenderDelegate: (id< TRTCVideoRenderDelegate >)  delegate
pixelFormat: (TRTCVideoPixelFormat pixelFormat
bufferType: (TRTCVideoBufferType bufferType 

设置本地视频自定义渲染回调

设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。

  • pixelFormat 指定回调的数据格式,例如 NV12、i420 以及 32BGRA。
  • bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。 参考文档:自定义采集和渲染
    参数
    delegate自定义渲染回调
    pixelFormat指定回调的像素格式
    bufferTypePixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。
    返回
    0:成功;<0:错误

◆ setLocalViewFillMode:()

- (void) setLocalViewFillMode: (TRTCVideoFillMode mode

设置本地图像的渲染模式

弃用:
v8.0 版本开始不推荐使用,建议使用 setLocalRenderParams 替代之。

◆ setLocalViewMirror:() [1/2]

- (void) setLocalViewMirror: (BOOL)  mirror

◆ setLocalViewMirror:() [2/2]

- (void) setLocalViewMirror: (TRTCLocalVideoMirrorType mirror

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

弃用:
v8.0 版本开始不推荐使用,建议使用 setLocalRenderParams 替代之。

◆ setLocalViewRotation:()

- (void) setLocalViewRotation: (TRTCVideoRotation rotation

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

弃用:
v8.0 版本开始不推荐使用,建议使用 setLocalRenderParams 替代之。

◆ setLogCompressEnabled:()

+ (void) setLogCompressEnabled: (BOOL)  enabled

启用/禁用日志的本地压缩

开启压缩后,Log 存储体积明显减小,但需要腾讯云提供的 Python 脚本解压后才能阅读。 禁用压缩后,Log 采用明文存储,可以直接用记事本打开阅读,但占用空间较大。

参数
enabled指定是否启用,默认为启动状态

◆ setLogDelegate:()

+ (void) setLogDelegate: (id< TRTCLogDelegate >)  logDelegate

设置日志回调

◆ setLogDirPath:()

+ (void) setLogDirPath: (NSString *)  path

设置本地日志的保存路径

通过该接口您可以更改 SDK 本地日志的默认存储路径,SDK 默认的本地日志的存储位置:

  • Windows 平台:在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log,即 appdata%/liteav/log 下。
  • iOS 或 Mac 平台:在 sandbox Documents/log 下。
  • Android 平台:在 /app私有目录/files/log/liteav/ 下。
注意
请务必在所有其他接口之前调用,并且保证您指定的目录是存在的,并且您的应用程序拥有对该目录的读写权限。
参数
path存储日志的路径

◆ setLogLevel:()

+ (void) setLogLevel: (TRTCLogLevel level

设置 Log 输出级别

参数
level参见 TRTCLogLevel,默认值:TRTCLogLevelNone

◆ setMicVolumeOnMixing:()

- (void) setMicVolumeOnMixing: (NSInteger)  volume

设置麦克风的音量大小

弃用:
v6.9 版本开始不推荐使用,建议使用 setAudioCaptureVolume 替代之。

◆ setMixedPlayAudioFrameDelegateFormat:()

- (int) setMixedPlayAudioFrameDelegateFormat: (TRTCAudioFrameDelegateFormat *)  format

设置最终要由系统播放出的音频帧回调格式

本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式:

  • sampleRate:采样率,支持:16000、32000、44100、48000。
  • channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
  • samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。

如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:采样点数 = 毫秒数 * 采样率 / 1000; 举例:48000 采样率希望回调20ms帧长的数据,则采样点数应该填: 960 = 20 * 48000 / 1000; 注意,最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:字节数 = 采样点数 * channel * 2(位宽) 举例:48000 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 3840 = 960 * 2 * 2

参数
format音频数据回调格式。
返回
0:成功;<0:错误

◆ setMixExternalAudioVolume:playoutVolume:()

- (void) setMixExternalAudioVolume: (NSInteger)  publishVolume
playoutVolume: (NSInteger)  playoutVolume 

设置推流时混入外部音频的推流音量和播放音量

参数
publishVolume设置的推流音量大小,范围0 - 100, -1表示不改变
playoutVolume设置的播放音量大小,范围0 - 100, -1表示不改变

◆ setMixTranscodingConfig:()

- (void) setMixTranscodingConfig: (TRTCTranscodingConfig *)  config

设置云端混流的排版布局和转码参数

在一个直播间中可能同时会有多个主播发布自己的音视频流,但对于直播 CDN 上的观众而言,只需要观看一条 HTTP-FLV 或 HLS 格式的视频流即可。 当您调用本接口函数时,SDK 会向腾讯云的 TRTC 混流服务器发送一条指令,混流服务器会将房间里的多路音视频流混合成一路。 您可以通过 TRTCTranscodingConfig 参数来调整每一路画面的排版布局,也可以设置混合后的音视频流的各项编码参数。 参考文档:云端混流转码

    【画面1】=> 解码 ====> \
                            \
    【画面2】=> 解码 =>  画面混合 => 编码 => 【混合后的画面】
                            //
    【画面3】=> 解码 ====> //
    【声音1】=> 解码 ====> \
                            \
    【声音2】=> 解码 =>  声音混合 => 编码 => 【混合后的声音】
                            //
    【声音3】=> 解码 ====> //
参数
config如果 config 不为空,则开启云端混流,如果 config 为空则停止云端混流。详情请参考 TRTCTranscodingConfig
注意
关于云端混流的注意事项:
  • 调用该接口的用户,如果没设定 config 参数中的 streamId 字段,TRTC 会将房间中的多路画面混合到当前用户所对应的音视频流上,即 A + B => A。
  • 调用该接口的用户,如果设定了 config 参数中的 streamId 字段,TRTC 会将房间中的多路画面混合到您指定的 streamId 上,即 A + B => streamId。
  • 请注意,若您还在房间中且不再需要混流,请务必再次调用本接口并将 config 设置为空以进行取消,不及时取消混流可能会引起不必要的计费损失。
  • 请放心,当您退房时 TRTC 会自动取消混流状态。

◆ setMotionMute:()

- (void) setMotionMute: (BOOL)  motionMute

设置动效静音

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setNetworkQosParam:()

- (void) setNetworkQosParam: (TRTCNetworkQosParam *)  param

设置网络质量控制的相关参数

该设置决定在差网络环境下的质量调控策略,如“画质优先”或“流畅优先”等策略。

参数
param用于设置网络质量控制的相关参数,详情请参考 TRTCNetworkQosParam

◆ setNoseSlimLevel:()

- (void) setNoseSlimLevel: (float)  noseSlimLevel

设置瘦鼻级别

弃用:
v6.9 版本开始不推荐使用,建议使用 getBeautyManager 替代之。

◆ setPriorRemoteVideoStreamType:()

- (void) setPriorRemoteVideoStreamType: (TRTCVideoStreamType streamType

设定优先观看大画面还是小画面

弃用:
v8.0 版本开始不推荐使用,建议使用 startRemoteView:streamType:view: 替代之。

◆ setRemoteAudioVolume:volume:()

- (void) setRemoteAudioVolume: (NSString *)  userId
volume: (int)  volume 

设定某一个远端用户的声音播放音量

您可以通过 setRemoteAudioVolume(userId, 0) 将某一个远端用户的声音静音。

参数
userId用于指定远端用户的 ID。
volume音量大小,取值范围为0 - 100,默认值:100。
注意
如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。

◆ setRemoteRenderParams:streamType:params:()

- (void) setRemoteRenderParams: (NSString *)  userId
streamType: (TRTCVideoStreamType streamType
params: (TRTCRenderParams *)  params 

设置远端画面的渲染模式

可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。

参数
userId指定远端用户的 ID。
streamType可以设置为主路画面(TRTCVideoStreamTypeBig)或辅路画面(TRTCVideoStreamTypeSub)
params画面渲染参数,详情请参考 TRTCRenderParams

◆ setRemoteSubStreamViewFillMode:mode:()

- (void) setRemoteSubStreamViewFillMode: (NSString *)  userId
mode: (TRTCVideoFillMode mode 

设置辅路画面的填充模式

弃用:
v8.0 版本开始不推荐使用,建议使用 setRemoteRenderParams:streamType:params: 替代之。

◆ setRemoteSubStreamViewRotation:rotation:()

- (void) setRemoteSubStreamViewRotation: (NSString *)  userId
rotation: (TRTCVideoRotation rotation 

设置辅路画面的顺时针旋转角度

弃用:
v8.0 版本开始不推荐使用,建议使用 setRemoteRenderParams:streamType:params: 替代之。

◆ setRemoteVideoRenderDelegate:delegate:pixelFormat:bufferType:()

- (int) setRemoteVideoRenderDelegate: (NSString *)  userId
delegate: (id< TRTCVideoRenderDelegate >)  delegate
pixelFormat: (TRTCVideoPixelFormat pixelFormat
bufferType: (TRTCVideoBufferType bufferType 

设置远端视频自定义渲染回调

设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。

  • pixelFormat 指定回调的数据格式,例如 NV12、i420 以及 32BGRA。
  • bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。

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

注意
调用此函数之前,需要先调用 startRemoteView(nil) 来获取远端用户的视频流(view 设置为 nil 即可),否则不会有数据回调出来。
参数
userId指定远端用户的 ID
delegate自定义渲染回调
pixelFormat指定回调的像素格式
bufferTypePixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。
返回
0:成功;<0:错误

◆ setRemoteVideoStreamType:type:()

- (void) setRemoteVideoStreamType: (NSString *)  userId
type: (TRTCVideoStreamType streamType 

切换指定远端用户的大小画面

当房间中某个主播开启了双路编码之后,房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。 您可以通过此接口选定希望订阅的画面是大画面还是小画面,该接口在 startRemoteView 之前和之后调用均可生效。

注意
此功能需要目标用户已经通过 enableEncSmallVideoStream 提前开启了双路编码模式,否则此调用无实际效果。
参数
userId指定远端用户的 ID。
streamType视频流类型,即选择看大画面还是小画面,默认为大画面。

◆ setRemoteViewFillMode:mode:()

- (void) setRemoteViewFillMode: (NSString *)  userId
mode: (TRTCVideoFillMode mode 

设置远端图像的渲染模式

弃用:
v8.0 版本开始不推荐使用,建议使用 setRemoteRenderParams:streamType:params: 替代之。

◆ setRemoteViewRotation:rotation:()

- (void) setRemoteViewRotation: (NSString *)  userId
rotation: (TRTCVideoRotation rotation 

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

弃用:
v8.0 版本开始不推荐使用,建议使用 setRemoteRenderParams:streamType:params: 替代之。

◆ setReverbType:()

- (void) setReverbType: (TRTCReverbType reverbType

设置混响效果

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setVoiceReverbType 替代之。

◆ setSubStreamEncoderParam:()

- (void) setSubStreamEncoderParam: (TRTCVideoEncParam *)  param

设置屏幕分享(即辅路)的视频编码参数(该接口仅支持桌面系统)

该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。 请注意如下两个接口的差异:

参数
param辅流编码参数,详情请参考 TRTCVideoEncParam
注意
即使您使用主路传输屏幕分享(在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig),依然要使用 setSubStreamEncoderParam 设定屏幕分享的编码参数,而不要使用 setVideoEncoderParam

◆ setSubStreamMixVolume:()

- (void) setSubStreamMixVolume: (NSInteger)  volume

设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)

这个数值越高,屏幕分享音量的占比就越高,麦克风音量占比就越小,所以不推荐设置得太大,否则麦克风的声音就被压制了。

参数
volume设置的混音音量大小,范围0 - 100。

◆ setSystemAudioLoopbackVolume:()

- (void) setSystemAudioLoopbackVolume: (uint32_t)  volume

设置系统声音的采集音量

参数
volume设置的音量大小,范围是:[0 ~ 150],默认值为100。

◆ setSystemVolumeType:()

- (void) setSystemVolumeType: (TRTCSystemVolumeType type

设置系统音量类型

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setSystemVolumeType 接口替代之。

◆ setVideoEncoderMirror:()

- (void) setVideoEncoderMirror: (BOOL)  mirror

设置编码器输出的画面镜像模式

该设置不影响本地画面的镜像模式,但会影响房间中其他用户所观看到(以及云端录制文件)的镜像模式。

参数
mirror是否开启远端镜像,true:开启远端画面镜像;false:关闭远端画面镜像,默认值:false。

◆ setVideoEncoderParam:()

- (void) setVideoEncoderParam: (TRTCVideoEncParam *)  param

设置视频编码器的编码参数

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

参数
param用于设置视频编码器的相关参数,详情请参考 TRTCVideoEncParam

◆ setVideoEncoderRotation:()

- (void) setVideoEncoderRotation: (TRTCVideoRotation rotation

设置视频编码器输出的画面方向

该设置不影响本地画面的预览方向,但会影响房间中其他用户所观看到(以及云端录制文件)的画面方向。 当用户将手机或 Pad 上下颠倒时,由于摄像头的采集方向没有变,所以房间中其他用户所看到的画面会变成上下颠倒的, 在这种情况下,您可以通过调用该接口将 SDK 编码出的画面方向旋转180度,如此一来,房间中其他用户所看到的画面可保持正常的方向。 如果您希望实现上述这种友好的交互体验,我们更推荐您直接调用 setGSensorMode 实现更加智能的方向适配,无需您手动调用本接口。

参数
rotation目前支持0和180两个旋转角度,默认值:TRTCVideoRotation_0,即不旋转。

◆ setVideoMuteImage:fps:()

- (void) setVideoMuteImage: (TXImage *)  image
fps: (NSInteger)  fps 

设置本地画面被暂停期间的替代图片

当您调用 muteLocalVideo(true) 暂停本地画面时,您可以通过调用本接口设置一张替代图片,设置后,房间中的其他用户会看到这张替代图片,而不是黑屏画面。

参数
image设置替代图片,空值代表在 muteLocalVideo 之后不再发送视频流数据,默认值为空。
fps设置替代图片帧率,最小值为5,最大值为10,默认5。

◆ setVoiceChangerType:()

- (void) setVoiceChangerType: (TRTCVoiceChangerType voiceChangerType

设置变声类型

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#setVoiceChangerType 替代之。

◆ setWatermark:streamType:rect:()

- (void) setWatermark: (TXImage *)  image
streamType: (TRTCVideoStreamType streamType
rect: (CGRect)  rect 

添加水印

水印的位置是通过 rect 参数来指定的,rect 是一个四元组参数,其格式为 (x,y,width,height)

  • x:水印的坐标,取值范围为0 - 1的浮点数。
  • y:水印的坐标,取值范围为0 - 1的浮点数。
  • width:水印的宽度,取值范围为0 - 1的浮点数。
  • height:是不用设置的,SDK 内部会根据水印图片的宽高比自动计算一个合适的高度。

参数设置举例: 如果当前视频的编码分辨率是 540 × 960,且 rect 参数被您设置为(0.1,0.1,0.2,0.0), 那么水印的左上坐标点就是(540 × 0.1,960 × 0.1)即(54,96),水印的宽度是 540 × 0.2 = 108px,水印的高度会根据水印图片的宽高比由 SDK 自动算出。

参数
image水印图片,**必须使用透明底色的 png 格式**
streamType指定给哪一路画面设置水印,详情请参考TRTCVideoStreamType
rect水印相对于编码分辨率的归一化坐标,x,y,width,height 取值范围0 - 1。
注意
如果您要给主画面(一般为摄像头)和辅路画面(一般用作屏幕分享)同时设置水印,需要调用该接口两次,并设定不同的 streamType。

◆ setZoom:()

- (void) setZoom: (CGFloat)  distance

设置摄像头缩放倍数(焦距)

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 setCameraZoomRatio 接口替代之。

◆ sharedInstance()

+ (instancetype) sharedInstance

创建 TRTCCloud 实例(单例模式)

◆ showDebugView:()

- (void) showDebugView: (NSInteger)  showType

显示仪表盘

“仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层,用于展示音视频信息和事件信息,便于对接和调试。

参数
showType0:不显示;1:显示精简版(仅显示音视频信息);2:显示完整版(包含音视频信息和事件信息)。

◆ snapshotVideo:type:completionBlock:()

- (void) snapshotVideo: (NSString *)  userId
type: (TRTCVideoStreamType streamType
completionBlock: (void(^)(TXImage *image))  completionBlock 

视频截图

弃用:
v8.2 版本开始不推荐使用,建议使用 snapshotVideo:type:sourceType:completionBlock 替代之。

◆ snapshotVideo:type:sourceType:completionBlock:()

- (void) snapshotVideo: (NSString *)  userId
type: (TRTCVideoStreamType streamType
sourceType: (TRTCSnapshotSourceType sourceType
completionBlock: (void(^)(TXImage *image))  completionBlock 

视频画面截图

您可以通过本接口截取本地的视频画面,远端用户的主路画面以及远端用户的辅路(屏幕分享)画面。

参数
userId用户 ID,如指定空置表示截取本地的视频画面。
streamType视频流类型,可选择截取主路画面(TRTCVideoStreamTypeBig,常用于摄像头)或辅路画面(TRTCVideoStreamTypeSub,常用于屏幕分享)。
sourceType画面来源,可选择截取视频流画面(TRTCSnapshotSourceTypeStream)或视频渲染画面(TRTCSnapshotSourceTypeView),前者一般更清晰。
注意
Windows 平台目前仅支持截取 TRTCSnapshotSourceTypeStream 来源的视频画面。

◆ startAudioRecording:()

- (int) startAudioRecording: (TRTCAudioRecordingParams *)  param

开始录音

当您调用改接口后, SDK 会将本地和远端的所有音频(包括本地音频,远端音频,背景音乐和音效等)混合并录制到一个本地文件中。 该接口在进入房间前后调用均可生效,如果录制任务在退出房间前尚未通过 stopAudioRecording 停止,则退出房间后录制任务会自动被停止。

参数
param录音参数,请参考 TRTCAudioRecordingParams
返回
0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持。

◆ startCameraDeviceTestInView:()

- (void) startCameraDeviceTestInView: (NSView *)  view

开始进行摄像头测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 startCameraDeviceTest 接口替代之。

◆ startLocalAudio()

- (void) startLocalAudio

设置音频质量

弃用:
v8.0 版本开始不推荐使用,建议使用 startLocalAudio:(quality) 替代之。

◆ startLocalAudio:()

- (void) startLocalAudio: (TRTCAudioQuality quality

开启本地音频的采集和发布

SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调用该接口开启麦克风采集,并将音频编码并发布到当前的房间中。 开启本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。

参数
quality声音音质
  • TRTCAudioQualitySpeech,流畅:采样率:16k;单声道;音频裸码率:16kbps;适合语音通话为主的场景,比如在线会议,语音通话。
  • TRTCAudioQualityDefault,默认:采样率:48k;单声道;音频裸码率:50kbps;SDK 默认的音频质量,如无特殊需求推荐选择之。
  • TRTCAudioQualityMusic,高音质:采样率:48k;双声道 + 全频带;音频裸码率:128kbps;适合需要高保真传输音乐的场景,比如在线K歌、音乐直播等。
注意
该函数会检查麦克风的使用权限,如果当前 App 没有麦克风权限,SDK 会自动向用户申请麦克风使用权限。

◆ startLocalPreview:()

- (void) startLocalPreview: (TXView *)  view

开启本地摄像头的预览画面(桌面端)

在调用该接口之前,您可以先调用 setCurrentCameraDevice 选择使用 Mac 自带摄像头或外接摄像头。 在 enterRoom 之前调用此函数,SDK 只会开启摄像头,并一直等到您调用 enterRoom 之后才开始推流。 在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。 当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onCameraDidReady 回调通知。

参数
view承载视频画面的控件
注意
如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数,您可以:
  • 方案一:在调用 enterRoom 之前调用 startLocalPreview
  • 方案二:在调用 enterRoom 之后调用 startLocalPreview + muteLocalVideo(true)

◆ startLocalPreview:view:()

- (void) startLocalPreview: (BOOL)  frontCamera
view: (TXView *)  view 

开启本地摄像头的预览画面(移动端)

在 enterRoom 之前调用此函数,SDK 只会开启摄像头,并一直等到您调用 enterRoom 之后才开始推流。 在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。 当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onCameraDidReady 回调通知。

参数
frontCameraYES:前置摄像头;NO:后置摄像头。
view承载视频画面的控件
注意
如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数,您可以:
  • 方案一:在调用 enterRoom 之前调用 startLocalPreview
  • 方案二:在调用 enterRoom 之后调用 startLocalPreview + muteLocalVideo(true)

◆ startLocalRecording:()

- (void) startLocalRecording: (TRTCLocalRecordingParams *)  params

开启本地媒体录制

开启后把直播过程中的音视和视频内容录制到本地的一个文件中。

参数
params录制参数,请参考 TRTCLocalRecordingParams

◆ startMicDeviceTest:testEcho:()

- (void) startMicDeviceTest: (NSInteger)  interval
testEcho: (void(^)(NSInteger volume))  testEcho 

开始进行麦克风测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 startMicDeviceTest 接口替代之。

◆ startPublishCDNStream:()

- (void) startPublishCDNStream: (TRTCPublishCDNParam *)  param

开始向非腾讯云 CDN 上发布音视频流

该接口跟 startPublishing 功能类似,不同之处在于,startPublishing 仅支持向腾讯云的 CDN 发布,而本接口支持向非腾讯云的直播 CDN 上转推音视频流。

参数
paramCDN 转推参数,详情请参考 TRTCPublishCDNParam
注意
  • 使用 startPublishing 接口向腾讯云的直播 CDN 上发布音视频流不会收取额外费用
  • 使用 startPublishCDNStream 接口向非腾讯云的直播 CDN 上发布音视频流,需要收取额外的转推带宽费用。

◆ startPublishing:type:()

- (void) startPublishing: (NSString *)  streamId
type: (TRTCVideoStreamType streamType 

开始向腾讯云直播 CDN 上发布音视频流

该接口会向 TRTC 服务器发送指令,要求其将当前用户的音视频流旁路到直播 CDN 上。 您可以通过参数 streamId 设定直播流的 StreamId,从而可以指定该用户的音视频流对应在直播 CDN 上的播放地址。 例如:您可以通过该接口将当前用户的直播流 ID 指定为 user_stream_001,那么该用户音视频流对应的 CDN 播放地址为: “http://yourdomain/live/user_stream_001.flv”,其中 yourdomain 为您自己备案的播放域名, 您可以在直播控制台 配置您的播放域名,腾讯云不提供默认的播放域名。

TRTCCloud *trtcCloud = [TRTCCloud sharedInstance];
[trtcCloud enterRoom:params appScene:TRTCAppSceneLIVE];
[trtcCloud startLocalPreview:frontCamera view:localView];
[trtcCloud startLocalAudio];
[trtcCloud startPublishing: "user_stream_001" type:TRTCVideoStreamTypeBig];

您也可以在设置 enterRoom 的参数 TRTCParams 时指定 streamId, 而且我们更推荐您采用这种方案。

参数
streamId自定义流 ID。
streamType仅支持 TRTCVideoStreamTypeBigTRTCVideoStreamTypeSub
注意
您需要提前在 实时音视频控制台 中的功能配置页面上开启“启用旁路推流”才能生效。
  • 若您选择“指定流旁路”,则您可以通过该接口将对应音视频流推送到腾讯云 CDN 且指定为填写的流 ID。
  • 若您选择“全局自动旁路”,则您可以通过该接口调整默认的流 ID。

◆ startRemoteSubStreamView:view:()

- (void) startRemoteSubStreamView: (NSString *)  userId
view: (TXView *)  view 

开始显示远端用户的辅路画面

弃用:
v8.0 版本开始不推荐使用,建议使用 startRemoteView:streamType:view 替代之。

◆ startRemoteView:streamType:view:()

- (void) startRemoteView: (NSString *)  userId
streamType: (TRTCVideoStreamType streamType
view: (TXView *)  view 

订阅远端用户的视频流,并绑定视频渲染控件

调用该接口可以让 SDK 拉取指定 userid 的视频流,并渲染到参数 view 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。

  • 如果您已经知道房间中有视频流的用户的 userid,可以直接调用 startRemoteView 订阅该用户的画面。
  • 如果您不知道房间中有哪些用户在发布视频,您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。

调用本接口只是启动视频流的拉取,此时画面还需要加载和缓冲,当缓冲完毕后您会收到来自 onFirstVideoFrame 的通知。

参数
userId指定远端用户的 ID。
streamType指定要观看 userId 的视频流类型:
view用于承载视频画面的渲染控件
注意
注意几点规则需要您关注:
  1. SDK 支持同时观看某 userid 的大画面和辅路画面,或者同时观看某 userid 的小画面和辅路画面,但不支持同时观看大画面和小画面。
  2. 只有当指定的 userid 通过 enableEncSmallVideoStream 开启双路编码后,才能观看该用户的小画面。
  3. 当指定的 userid 的小画面不存在时,SDK 默认切换到该用户的大画面。

◆ startRemoteView:view:()

- (void) startRemoteView: (NSString *)  userId
view: (TXView *)  view 

开始显示远端视频画面

弃用:
v8.0 版本开始不推荐使用,建议使用 startRemoteView:streamType:view 替代之。

◆ startScreenCapture:()

- (void) startScreenCapture: (NSView *)  view

启动屏幕分享

弃用:
v7.2 版本开始不推荐使用,建议使用 startScreenCapture:streamType:encParam: 替代之。

◆ startScreenCapture:streamType:encParam:()

- (void) startScreenCapture: (NSView *)  view
streamType: (TRTCVideoStreamType streamType
encParam: (TRTCVideoEncParam *)  encParam 

开始桌面端屏幕分享(该接口仅支持桌面系统)

该接口可以抓取整个 Mac OS 系统的屏幕内容,或抓取您指定的某个应用的窗口内容,并将其分享给同房间中的其他用户。

参数
view渲染控件所在的父控件,可以设置为空值,表示不显示屏幕分享的预览效果。
streamType屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub),推荐使用辅路。
encParam屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:
  • 如果您设置 encParam 为 nil,且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将使用您设置过的辅路编码参数进行屏幕分享。
  • 如果您设置 encParam 为 nil,且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将自动选择一个最佳的编码参数进行屏幕分享。
注意
  1. 同一个用户同时最多只能发布一路主路(TRTCVideoStreamTypeBig)画面和一路辅路(TRTCVideoStreamTypeSub)画面。
  2. 默认情况下,屏幕分享使用辅路画面。如果使用主路做屏幕分享,您需要提前停止摄像头采集(stopLocalPreview)以避免相互冲突。
  3. 同一个房间中同时只能有一个用户使用辅路做屏幕分享,也就是说,同一个房间中同时只允许一个用户开启辅路。
  4. 当房间中已经有其他用户在使用辅路分享屏幕时,此时调用该接口会收到来自 TRTCCloudDelegate 的 onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) 回调。

◆ startScreenCaptureByReplaykit:appGroup:()

- (void) startScreenCaptureByReplaykit: (TRTCVideoEncParam *)  encParams
appGroup: (NSString *)  appGroup 

开始全系统的屏幕分享(iOS)

弃用:
v8.6 版本开始不推荐使用,建议使用 startScreenCaptureByReplaykit:encParam:appGroup:接口替代之。

◆ startScreenCaptureByReplaykit:encParam:appGroup:()

- (void) startScreenCaptureByReplaykit: (TRTCVideoStreamType streamType
encParam: (TRTCVideoEncParam *)  encParams
appGroup: (NSString *)  appGroup 

开始全系统的屏幕分享(仅支持 iOS 11.0 及以上系统)

该接口支持抓取整个 iOS 系统的屏幕,可以实现类似腾讯会议的全系统级的屏幕分享。 但对接步骤要比 startScreenCaptureInApp 略繁琐一些,需要为您的应用实现一个 Replaykit 扩展模块。 参考文档:实时屏幕分享(iOS) iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):

  • 分辨率(videoResolution): 1280 x 720
  • 帧率(videoFps): 10 FPS
  • 码率(videoBitrate): 1600 kbps
  • 分辨率自适应(enableAdjustRes): NO
参数
streamType屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub)。
encParams设置屏幕分享时的视频编码参数,推荐采用上述推荐配置。如果您指定 encParams 为 nil,SDK 会使用您在调用 startScreenCapture 接口之前所设置的视频编码参数。
appGroup用于指定您的应用与录屏进程共享的 Application Group Identifier,您可以指定该参数为 nil,但推荐您按照文档指示进行设置,从而获得更好的可靠性。

◆ startScreenCaptureInApp:()

- (void) startScreenCaptureInApp: (TRTCVideoEncParam *)  encParams

开始应用内的屏幕分享(iOS)

弃用:
v8.6 版本开始不推荐使用,建议使用 startScreenCaptureInApp:encParam: 接口替代之。

◆ startScreenCaptureInApp:encParam:()

- (void) startScreenCaptureInApp: (TRTCVideoStreamType streamType
encParam: (TRTCVideoEncParam *)  encParams 

开始应用内的屏幕分享(仅支持 iOS 13.0 及以上系统)

该接口会抓取当前应用内的实时屏幕内容并将其分享给同房间中的其他用户,适用于 13.0 以上的 iOS 系统。 如果您希望抓取整个 iOS 系统的屏幕内容(而不受当前应用的限制),推荐使用 startScreenCaptureByReplaykit。 iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):

  • 分辨率(videoResolution): 1280 x 720
  • 帧率(videoFps): 10 FPS
  • 码率(videoBitrate): 1600 kbps
  • 分辨率自适应(enableAdjustRes): NO
参数
streamType屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub)。
encParams设置屏幕分享时的视频编码参数,推荐采用上述推荐配置。 如果您指定 encParams 为 nil,SDK 会使用您在调用 startScreenCapture 接口之前所设置的视频编码参数。

◆ startSpeakerDeviceTest:onVolumeChanged:()

- (void) startSpeakerDeviceTest: (NSString *)  audioFilePath
onVolumeChanged: (void(^)(NSInteger volume, BOOL isLastFrame))  volumeBlock 

开始进行扬声器测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 startSpeakerDeviceTest 接口替代之。

◆ startSpeedTest:userId:userSig:completion:()

- (void) startSpeedTest: (uint32_t)  sdkAppId
userId: (NSString *)  userId
userSig: (NSString *)  userSig
completion: (void(^)(TRTCSpeedTestResult *result, NSInteger completedCount, NSInteger totalCount))  completion 

开始进行网络测速(进入房间前使用)

TRTC 由于涉及的是对传输时延要求很苛刻的实时音视频传输服务,因此对网络的稳定性要求会比较高。 很多用户在网络环境达不到 TRTC 的最低使用门槛时,直接进入房间可能会导致非常不好的用户体验。 推荐的做法是在用户进入房间前进行网络测速,当用户网络较差时通过 UI 交互提醒用户切换到更加稳定的网络(比如 WiFi 切换到 4G )后再进入房间。

注意
  1. 测速本身会消耗一定的流量,所以也会产生少量额外的流量费用。
  2. 请在进入房间前进行测速,在房间中测速会影响正常的音视频传输效果,而且由于干扰过多,测速结果也不准确。
参数
sdkAppId应用标识,请参考 TRTCParams 中的相关说明。
userId用户标识,请参考 TRTCParams 中的相关说明。
userSig用户签名,请参考 TRTCParams 中的相关说明。

◆ startSystemAudioLoopback()

- (void) startSystemAudioLoopback

开启系统声音采集(仅适用于 Mac 系统)

该接口会从电脑的声卡中采集音频数据,并将其混入到 SDK 当前的音频数据流中,从而使房间中的其他用户也能听到主播的电脑所播放出的声音。 在线教育场景中,老师可以使用此功能让 SDK 采集教学影片中的声音,并广播给同房间中的学生。 音乐直播场景中,主播可以使用此功能让 SDK 采集音乐播放器中的音乐,从而为自己的直播间增加背景音乐。

注意
  1. 此功能需要为用户的 Mac 系统安装虚拟音频设备插件,安装完成后,SDK 会从已经安装的虚拟音频设备中采集声音。
  2. SDK 会自动从网络上下载合适的插件进行安装,但是下载速度可能比较慢,如果您希望加速这个过程,可以将虚拟音频插件文件打包到您 App Bundle 的 Resources 目录下。

◆ stopAllAudioEffects()

- (void) stopAllAudioEffects

停止所有音效

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#stopPlayMusic 替代之。

◆ stopAllRemoteView()

- (void) stopAllRemoteView

停止订阅所有远端用户的视频流,并释放全部渲染资源

调用此接口会让 SDK 停止接收所有来自远端的视频流,并释放全部的解码和渲染资源。

注意
如果当前有正在显示的辅路画面(屏幕分享)也会一并被停止。

◆ stopAudioEffect:()

- (void) stopAudioEffect: (int)  effectId

停止播放音效

弃用:
v7.3 版本开始不推荐使用,建议使用 TXAudioEffectManager#stopPlayMusic 替代之。

◆ stopAudioRecording()

- (void) stopAudioRecording

停止录音

如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。

◆ stopBGM()

- (void) stopBGM

停止播放背景音乐

弃用:
v7.3 版本开始不推荐使用,建议使用 getAudioEffectManager 替代之。

◆ stopCameraDeviceTest()

- (void) stopCameraDeviceTest

开始进行摄像头测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 stopCameraDeviceTest 接口替代之。

◆ stopLocalAudio()

- (void) stopLocalAudio

停止本地音频的采集和发布

停止本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。

◆ stopLocalPreview()

- (void) stopLocalPreview

停止摄像头预览

◆ stopLocalRecording()

- (void) stopLocalRecording

停止本地媒体录制

如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。

◆ stopMicDeviceTest()

- (void) stopMicDeviceTest

开始进行麦克风测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 stopMicDeviceTest 接口替代之。

◆ stopPublishCDNStream()

- (void) stopPublishCDNStream

停止向非腾讯云 CDN 上发布音视频流

◆ stopPublishing()

- (void) stopPublishing

停止向腾讯云直播 CDN 上发布音视频流

◆ stopRemoteSubStreamView:()

- (void) stopRemoteSubStreamView: (NSString *)  userId

停止显示远端用户的辅路画面

弃用:
v8.0 版本开始不推荐使用,建议使用 stopRemoteView:streamType: 替代之。

◆ stopRemoteView:()

- (void) stopRemoteView: (NSString *)  userId

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

弃用:
v8.0 版本开始不推荐使用,建议使用 stopRemoteView:streamType: 替代之。

◆ stopRemoteView:streamType:()

- (void) stopRemoteView: (NSString *)  userId
streamType: (TRTCVideoStreamType streamType 

停止订阅远端用户的视频流,并释放渲染控件

调用此接口会让 SDK 停止接收该用户的视频流,并释放该路视频流的解码和渲染资源。

参数
userId指定远端用户的 ID。
streamType指定要观看 userId 的视频流类型:

◆ stopScreenCapture()

- (int) stopScreenCapture

停止屏幕分享

◆ stopSpeakerDeviceTest()

- (void) stopSpeakerDeviceTest

停止进行扬声器测试

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 stopSpeakerDeviceTest 接口替代之。

◆ stopSpeedTest()

- (void) stopSpeedTest

停止网络测速

◆ stopSystemAudioLoopback()

- (void) stopSystemAudioLoopback

停止系统声音采集(仅适用于桌面系统)

◆ switchCamera()

- (void) switchCamera

切换摄像头

弃用:
v8.0 版本开始不推荐使用,建议使用 TXDeviceManager 中的 switchCamera 接口替代之。

◆ switchRole:()

- (void) switchRole: (TRTCRoleType role

切换角色

调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。 由于视频直播和语音聊天室需要支持多达10万名观众同时观看,所以设定了“只有主播才能发布自己的音视频”的规则。 因此,当有些观众希望发布自己的音视频流(以便能跟主播互动)时,就需要先把自己的角色切换成“主播”。 您可以在进入房间时通过 TRTCParams 中的 role 字段事先确定用户的角色,也可以在进入房间后通过 switchRole 接口动态切换角色。

参数
role角色,默认为“主播”:
  • TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。
  • TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成“主播”,同一个房间内同时最多可以容纳 10 万名观众。
注意
  1. 该接口仅适用于视频直播(TRTCAppSceneLIVE)和语音聊天室(TRTCAppSceneVoiceChatRoom)这两个场景。
  2. 如果您在 enterRoom 时指定的 scene 为 TRTCAppSceneVideoCallTRTCAppSceneAudioCall,请不要调用这个接口。

◆ switchRoom:()

- (void) switchRoom: (TRTCSwitchRoomConfig *)  config

切换房间

使用该接口可以让用户可以快速从一个房间切换到另一个房间。

  • 如果用户的身份是“观众”,该接口的调用效果等同于 exitRoom(当前房间) + enterRoom(新的房间)。
  • 如果用户的身份是“主播”,该接口在切换房间的同时还会保持自己的音视频发布状态,因此在房间切换过程中,摄像头的预览和声音的采集都不会中断。

该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用 switchRoom 可以获得比 exitRoom+enterRoom 更好的流畅性和更少的代码量。 接口调用结果会通过 TRTCCloudDelegate 中的 onSwitchRoom(errCode, errMsg) 回调。

参数
config房间参数,详情请参考 TRTCSwitchRoomConfig
注意
由于对老版本 SDK 兼容的需求,参数 config 中同时包含 roomId 与 strRoomId 两个参数,这两个参数的填写格外讲究,请注意如下事项:
  1. 若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,将优先选用 roomId。
  2. 所有房间需要同时使用 strRoomId 或同时使用 roomId,不可混用,否则将会出现很多预期之外的 bug。

◆ updateLocalView:()

- (void) updateLocalView: (TXView *)  view

更新本地摄像头的预览画面

◆ updateRemoteView:streamType:forUser:()

- (void) updateRemoteView: (TXView *)  view
streamType: (TRTCVideoStreamType streamType
forUser: (NSString *)  userId 

更新远端用户的视频渲染控件

该接口可用于更新远端视频画面的渲染控件,常被用于切换显示区域的交互场景中。

参数
view承载视频画面的控件
streamType要设置预览窗口的流类型(仅支持 TRTCVideoStreamTypeBigTRTCVideoStreamTypeSub
userId指定远端用户的 ID。

属性说明

◆ delegate

- (id<TRTCCloudDelegate>) delegate
readwritenonatomicweak

设置 TRTC 事件回调

您可以通过 TRTCCloudDelegate 获得来自 SDK 的各类事件通知(比如:错误码,警告码,音视频状态参数等)。

◆ delegateQueue

- (dispatch_queue_t) delegateQueue
readwritenonatomicstrong

设置驱动 TRTCCloudDelegate 事件回调的队列

如果您不指定自己的 delegateQueue,SDK 默认会采用 MainQueue 作为驱动 TRTCCloudDelegate 事件回调的队列。 也就是当您不设置 delegateQueue 属性时,TRTCCloudDelegate 中的所有回调函数都是由 MainQueue 来驱动的。

注意
如果您指定了自己的 delegateQueue,请不要在 TRTCCloudDelegate 回调函数中操作 UI,否则会引发线程安全问题。