实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频客户端 API 参考Unity 3.58概览
概览
文档反馈
问问助手方法
引擎管理
| 方法 | 描述 |
|---|---|
| CreateRTCVideo | 创建 RTCVideoEngine 实例。 RTCVideoEngine 实例成功创建后，你才可以使用 SDK 提供的其他能力。 |
| GetSDKVersion | 获取 SDK 当前的版本号。 |
| Feedback | 通话结束，将用户反馈的问题上报到 RTC。 |
| GetErrorDescription | 获取 SDK 内各种错误码、警告码的描述文字 |
| SetBusinessId | 设置业务标识参数。 可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。 |
| SetRuntimeParameters | 设置运行时的参数。 |
房间管理
| 方法 | 描述 |
|---|---|
| CreateRTCRoom | 创建房间 |
| Destroy | 退出并销毁调用 CreateRTCRoom 所创建的房间。 |
| JoinRoom | 加入房间。 调用 CreateRTCRoom 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。 |
| LeaveRoom | 离开房间。 用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。 |
| SetUserVisibility | 设置用户可见性。默认可见。 |
| UpdateToken | 更新 Token。 收到 OnTokenWillExpireEventHandler 时，你必须重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。 |
音频管理
视频管理
| 方法 | 描述 |
|---|---|
| StartVideoCapture | 立即开启内部视频采集。默认为关闭状态。 内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。 调用该方法后，本地用户会收到 OnVideoDeviceStateChangedEventHandler 的回调。 本地用户在非隐身状态下调用该方法后，房间中的其他用户会收到 OnUserStartVideoCaptureEventHandler 的回调。 |
| StopVideoCapture | 立即关闭内部视频采集。默认为关闭状态。 内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。 调用该方法，本地用户会收到 OnVideoDeviceStateChangedEventHandler 的回调。 可见用户进房后调用该方法，房间中的其他用户会收到 OnUserStopVideoCaptureEventHandler 的回调。 |
| SetVideoCaptureConfig | 设置 RTC SDK 内部采集时的视频采集参数。 如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数包括模式、分辨率、帧率。 |
| SetVideoRotationMode | 设置采集视频的旋转模式。默认以 App 方向为旋转参考系。 接收端渲染视频时，将按照和发送端相同的方式进行旋转。 |
| SwitchCamera | 切换视频内部采集时使用的前置/后置摄像头 调用此接口后，在本地会触发 OnVideoDeviceStateChangedEventHandler 回调。 |
| EnumerateVideoCaptureDevices | 获取当前系统内视频采集设备列表。 |
| SetVideoCaptureDevice | 设置当前视频采集设备 |
| GetVideoDeviceManager | 获取视频设备管理接口 |
| GetVideoCaptureDevice | 获取当前 SDK 正在使用的视频采集设备信息 |
| SetVideoEncoderConfig1 | 视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 |
音视频传输
| 方法 | 描述 |
|---|---|
| PublishStream | 在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流 |
| UnpublishStream | 停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中 |
| SubscribeStream | 订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项。 |
| UnsubscribeStream | 取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。 该方法对自动订阅和手动订阅模式均适用。 |
| SubscribeAllStreams | 订阅房间内所有通过摄像头/麦克风采集的媒体流，或更新订阅选项。 |
| UnsubscribeAllStreams | 取消订阅房间内所有的通过摄像头/麦克风采集的媒体流。 自动订阅和手动订阅的流都可以通过本方法取消订阅。 |
| PauseAllSubscribedStream | 暂停接收来自远端的媒体流。 |
| ResumeAllSubscribedStream | 恢复接收来自远端的媒体流 |
| SetDummyCaptureImagePath | 摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。 调用 stopVideoCapture 接口时，会开始推静态图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。可重复调用该接口来更新图片。 |
| StartForwardStreamToRooms | 开始跨房间转发媒体流。 在调用 JoinRoom 后调用本接口，实现向多个房间转发媒体流，适用于跨房间连麦等场景。 |
| StopForwardStreamToRooms | 停止跨房间媒体流转发。 通过 StartForwardStreamToRooms 发起媒体流转发后，可调用本方法停止向所有目标房间转发媒体流。 |
| UpdateForwardStreamToRooms | 更新跨房间媒体流转发信息。 通过 StartForwardStreamToRooms 发起媒体流转发后，可调用本方法增加或者减少目标房间，或更新房间密钥。 调用本方法增加或删减房间后，将在本端触发 OnForwardStreamStateChangedEventHandler 回调，包含发生了变动的目标房间中媒体流转发状态。 |
| PauseForwardStreamToAllRooms | 暂停跨房间媒体流转发。 通过 StartForwardStreamToRooms 发起媒体流转发后，可调用本方法暂停向所有目标房间转发媒体流。 调用本方法暂停向所有目标房间转发后，你可以随时调用 ResumeForwardStreamToAllRooms 快速恢复转发。 |
| ResumeForwardStreamToAllRooms | 恢复跨房间媒体流转发。 调用 PauseForwardStreamToAllRooms 暂停转发之后，调用本方法恢复向所有目标房间转发媒体流。 |
| SetMultiDeviceAVSync | 设置发流端音画同步。 当同一用户同时使用两个通话设备分别采集发送音频和视频时，有可能会因两个设备所处的网络环境不一致而导致发布的流不同步，此时你可以在视频发送端调用该接口，SDK 会根据音频流的时间戳自动校准视频流，以保证接收端听到音频和看到视频在时间上的同步性。 |
视频处理
| 方法 | 描述 |
|---|---|
| SetLocalVideoMirrorType | 为采集到的视频流开启镜像 |
| SetVideoCaptureRotation | 设置本端采集的视频帧的旋转角度。 当摄像头倒置或者倾斜安装时，可调用本接口进行调整。 |
| SetVideoWatermark | 在指定视频流上添加水印。 |
| ClearVideoWatermark | 移除指定视频流的水印。 |
| EnableEffectBeauty | 开启/关闭基础美颜。 |
| SetBeautyIntensity | 调整基础美颜强度。 |
| GetAuthMessage | 从特效 SDK 获取授权消息，用于获取在线许可证。 |
| FreeAuthMessage | 使用完授权消息字符串后，释放内存。 |
| InitCVResource | 检查视频特效证书，设置算法模型路径，并初始化特效模块。 |
| EnableVideoEffect | 开启高级美颜、滤镜等视频特效。 |
| DisableVideoEffect | 关闭视频特效。 |
| SetEffectNodes | 设置视频特效素材包。 |
| UpdateEffectNode | 设置特效强度。 |
| SetColorFilter | 设置颜色滤镜。 |
| SetColorFilterIntensity | 设置已启用颜色滤镜的强度。 |
| EnableVirtualBackground | 将摄像头采集画面中的人像背景替换为指定图片或纯色背景。 |
| DisableVirtualBackground | 关闭虚拟背景。 |
| VideoSDKEnableFaceDetection | 开启人脸识别功能，并设置人脸检测结果回调观察者。 此观察者后，你会周期性收到 OnFaceDetectResultEventHandler 回调。 |
| VideoSDKDisableFaceDetection | 关闭人脸识别功能。 |
| SetVideoDigitalZoomConfig | 设置本地摄像头数码变焦参数，包括缩放倍数，移动步长。 |
| SetVideoDigitalZoomControl | 控制本地摄像头数码变焦，缩放或移动一次。设置对本地预览画面和发布到远端的视频都生效。 |
| StartVideoDigitalZoomControl | 开启本地摄像头持续数码变焦，缩放或移动。设置对本地预览画面和发布到远端的视频都生效。 |
| StopVideoDigitalZoomControl | 停止本地摄像头持续数码变焦。 |
音频处理
| 方法 | 描述 |
|---|---|
| SetVoiceReverbType | 设置混响特效类型 |
| SetVoiceChangerType | 设置变声特效类型 |
| SetLocalVoicePitch | 开启本地语音变调功能，多用于 K 歌场景。 使用该方法，你可以对本地语音的音调进行升调或降调等调整。 |
| SetLocalVoiceEqualization | 设置本地采集语音的均衡效果。包含内部采集和外部采集，但不包含混音音频文件。 |
| SetLocalVoiceReverbParam | 设置本地采集音频的混响效果。包含内部采集和外部采集，但不包含混音音频文件。 |
| EnableLocalVoiceReverb | 开启本地音效混响效果 |
自定义流处理
| 方法 | 描述 |
|---|---|
| SetVideoSourceType | 设置向 SDK 输入的视频源，包括屏幕流。 默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。 |
| PushExternalVideoFrame | 推送外部视频帧。 |
| SetLocalVideoSink | 将本地视频流与自定义渲染器绑定。 |
| SetRemoteVideoSink | 将远端视频流与自定义渲染器绑定。 |
| SetAudioSourceType | 切换音频采集方式 |
| PushExternalAudioFrame | 推送自定义采集的音频数据到 RTC SDK。 |
| EnableAudioProcessor | 设置并开启指定的音频帧回调，进行自定义处理。 |
| DisableAudioProcessor | 关闭自定义音频处理。 |
| EnableAudioFrameCallback | 设置并开启指定的音频数据帧回调 |
| DisableAudioFrameCallback | 关闭音频回调 |
消息
| 方法 | 描述 |
|---|---|
| SendRoomMessage | 给房间内的所有其他用户群发文本消息。 |
| SendUserMessage | 给房间内指定的用户发送点对点文本消息（P2P）。 |
| SendStreamSyncInfo | 发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 OnStreamSyncInfoReceivedEventHandler 回调。 |
| SendSEIMessage | 通过视频帧发送 SEI 数据。 在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。 |
混音
| 方法 | 描述 |
|---|---|
| EnableVocalInstrumentBalance | 开启/关闭音量均衡功能。 开启音量均衡功能后，人声的响度会调整为 -16lufs。 |
屏幕分享
| 方法 | 描述 |
|---|---|
| StartScreenCapture | 使用 RTC SDK 内部采集模块开始采集屏幕音频流和（或）视频流。 |
| GetScreenCaptureSourceList | 获取共享对象(应用窗口和桌面)列表, 使用完之后需要调用对应的 release 接口释放 |
| StartScreenVideoCapture | 使用 RTC SDK 提供的采集模块，采集当前屏幕视频流，用于共享。 |
| UpdateScreenCaptureHighlightConfig | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。 |
| UpdateScreenCaptureMouseCursor | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。 |
| UpdateScreenCaptureFilterConfig | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。 |
| UpdateScreenCaptureRegion | 通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新采集区域。 |
| StopScreenVideoCapture | 停止屏幕视频流采集。 |
| PublishScreen | 在当前所在房间内发布本地屏幕共享音视频流 |
| UnpublishScreen | 停止将本地屏幕共享音视频流发布到当前所在房间中 |
| GetThumbnail | 获取共享对象缩略图 |
| SetScreenAudioSourceType | 在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集） |
| SetScreenAudioStreamIndex | 在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式 |
| PushScreenAudioFrame | 使用自定义采集方式，采集屏幕共享时的屏幕音频时，将音频帧推送至 RTC SDK 处进行编码等处理。 |
| PushScreenVideoFrame | 推送屏幕视频帧 |
| SetScreenVideoEncoderConfig | 为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。 |
| SubscribeScreen | 订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项 |
| UnsubscribeScreen | 取消订阅房间内指定的远端屏幕共享音视频流。 该方法对自动订阅和手动订阅模式均适用。 |
高级功能
| 方法 | 描述 |
|---|---|
| StartAudioRecording | 开始音频录制，并生成录音文件保存到本地。 |
| StopAudioRecording | 停止音频文件录制 |
| SetEarMonitorMode | 打开/关闭耳返功能。 |
| SetEarMonitorVolume | 设置耳返音量。 |
| GetSpatialAudio | 获取空间音频接口。 |
| EnableSpatialAudio | 设置是否开启空间语音 |
| UpdatePosition | 更新本地用户发声时，在房间内空间直角坐标系中的位置坐标。 |
| UpdateSelfOrientation | 更新自己的朝向。本地朝向的设置只影响本地听到的音频效果，不影响本地发出的音频效果。 |
| DisableRemoteOrientation | 关闭本地用户朝向对本地用户发声效果的影响。 调用此接口后，房间内的其他用户收听本地发声时，声源都在收听者正面。 |
| GetRangeAudio | 获取范围语音接口。 |
| EnableRangeAudio | 开启/关闭范围语音功能。 范围语音是指，在同一 RTC 房间中设定的音频接收距离范围内，本地用户收听到的远端用户音频音量会随着远端用户的靠近/远离而放大/衰减；若远端用户在房间内的位置超出设定范围，则本地用户无法接收其音频。音频接收范围设置参看 UpdateReceiveRange。 |
| SetAttenuationModel | 设置范围语音的音量衰减模式。 |
| SetNoAttenuationFlags | 添加标签组，用于标记相互之间通话不衰减的用户组。 在同一个 RTC 房间中，如果多个用户的标签组之间有交集，那么，他们之间互相通话时，通话不衰减。 比如，用户身处多个队伍，队伍成员间通话不衰减。那么，可以为每个队伍绑定专属标签，每个用户的标签组包含用户所属各个队伍的标签。 |
| UpdatePosition | 更新本地用户在房间内空间直角坐标系中的位置坐标。 |
| UpdateReceiveRange | 更新本地用户的音频收听范围。 |
回调
引擎管理
| 回调 | 描述 |
|---|---|
| OnLogReportEventHandler | 上报日志时回调该事件。 |
| OnSysStatsEventHandler | 每 2 秒发生回调，通知当前 CPU 及内存使用的信息。 |
| OnWarningEventHandler | 发生警告回调。 |
| OnErrorEventHandler | 发生错误回调。 |
| OnTokenWillExpireEventHandler | 当 SDK 检测到 Token 的进房权限将在 30 秒内过期时，触发该回调。 调用 UpdateToken 更新 Token。否则 Token 过期后，用户将被移出房间无法继续进行音视频通话。 |
房间管理
| 回调 | 描述 |
|---|---|
| OnRoomStateChangedEventHandler | 房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。 |
| OnCreateRoomStateChangedEventHandler | 创建房间失败回调。 |
| OnLeaveRoomEventHandler | 离开房间成功回调。 用户调用 LeaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。 |
| OnUserJoinedEventHandler | 远端可见用户加入房间，或房内不可见用户切换为可见的回调。 + 远端可见用户调用 SetUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。 + 远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 + 房间内不可见远端用户调用 SetUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。 + 新进房用户也会收到进房前已在房内的可见用户的进房回调通知。 |
| OnUserLeaveEventHandler | 远端用户离开房间，或切至不可见时，本地用户会收到此事件 |
音频管理
| 回调 | 描述 |
|---|---|
| OnAudioDeviceWarningEventHandler | 媒体设备警告回调。媒体设备包括：音频采集设备、音频渲染设备、和视频采集设备。 |
| OnAudioDeviceStateChangedEventHandler | 音频设备状态回调。提示音频采集、音频播放等媒体设备的状态。 |
| OnAudioRouteChangedEventHandler | 音频播放路由变化时，收到该回调。 |
| OnLocalAudioPropertiesReportEventHandler | 调用 EnableAudioPropertiesReport 后，根据设置的 Interval 值，你会周期性地收到此回调，了解本地音频的相关信息。 本地音频包括使用 RTC SDK 内部机制采集的麦克风音频和屏幕音频。 |
| OnRemoteAudioPropertiesReportEventHandler | 远端用户进房后，本地调用 EnableAudioPropertiesReport ，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的瞬时音频信息。 远端用户的音频包括使用 RTC SDK 内部机制/自定义机制采集的麦克风音频和屏幕音频。 |
| OnUserStartAudioCaptureEventHandler | 房间内的可见用户调用 StartAudioCapture 开启音频采集时，房间内其他用户会收到此回调。 |
| OnUserStopAudioCaptureEventHandler | 房间内的可见用户调用 StopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。 |
| OnStreamSyncInfoReceivedEventHandler | 音频流同步信息回调。可以通过此回调，在远端用户调用 SendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。 |
| OnAudioStreamBannedEventHandler | 通过调用服务端 MuteUser/UnmuteUser 方法禁用/解禁指定房间内指定用户视音频流的发送时，触发此回调。 |
| OnLocalAudioStateChangedEventHandler | 本地音频流的状态发生改变时，该回调通知当前的本地音频流状态。 |
视频管理
| 回调 | 描述 |
|---|---|
| OnUserStartVideoCaptureEventHandler | 房间内的可见用户调用 StartVideoCapture 开启内部视频采集时，房间内其他用户会收到此回调。 |
| OnUserStopVideoCaptureEventHandler | 房间内的可见用户调用 StopVideoCapture 关闭内部视频采集时，房间内其他用户会收到此回调。 |
| OnVideoDeviceStateChangedEventHandler | 视频设备状态回调。提示摄像头视频采集、屏幕视频采集等媒体设备的状态。 |
| OnVideoDeviceWarningEventHandler | 视频设备警告回调，包括视频采集等设备。 |
音视频传输
视频处理
| 回调 | 描述 |
|---|---|
| OnFaceDetectResultEventHandler | 特效 SDK 进行人脸检测结果的回调。 调用 VideoSDKEnableFaceDetection 开启本回调，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。 |
自定义流处理
| 回调 | 描述 |
|---|---|
| OnProcessEarMonitorAudioFrameEventHandler | 回调耳返数据的音频帧地址，供自定义音频处理。 |
| OnProcessPlaybackAudioFrameEventHandler | 回调远端音频混音的音频帧地址，供自定义音频处理。 |
| OnProcessRecordAudioFrameEventHandler | 回调本地采集的音频帧地址，供自定义音频处理。 |
| OnProcessRemoteUserAudioFrameEventHandler | 回调单个远端用户的音频帧地址，供自定义音频处理。 |
| OnProcessScreenAudioFrameEventHandler | 屏幕共享的音频帧地址回调。你可根据此回调自定义处理音频。 |
| OnRecordAudioFrameEventHandler | 返回麦克风录制的音频数据 |
| OnPlaybackAudioFrameEventHandler | 返回订阅的所有远端用户混音后的音频数据。 |
| OnRemoteUserAudioFrameEventHandler | 返回远端单个用户的音频数据 |
| OnMixedAudioFrameEventHandler | 返回本地麦克风录制和订阅的所有远端用户混音后的音频数据 |
| OnRecordScreenAudioFrameEventHandler | 返回本地屏幕录制的音频数据 |
| OnLocalVideoSinkOnFrameEventHandler | 自定义渲染器本地视频帧回调。 |
| OnLocalVideoSinkGetRenderElapseEventHandler | 自定义渲染本地视频帧耗时。 |
| OnLocalVideoSinkReleaseEventHandler | 释放本地自定义渲染器。 |
| OnRemoteVideoSinkOnFrameEventHandler | 自定义渲染器远端视频帧回调。 |
| OnRemoteVideoSinkGetRenderElapseEventHandler | 自定义渲染远端视频帧耗时。 |
| OnRemoteVideoSinkReleaseEventHandler | 释放远端自定义渲染器。 |
网络管理
| 回调 | 描述 |
|---|---|
| OnConnectionStateChangedEventHandler | 回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。 |
| OnNetworkTypeChangedEventHandler | SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 |
| OnSEIMessageReceivedEventHandler | 收到通过调用 SendSEIMessage 发送带有 SEI 消息的视频帧时，收到此回调。 |
| OnSEIMessageUpdateEventHandler | 黑帧视频流发布状态回调。 在语音通话场景下，本地用户调用 SendSEIMessage 通过黑帧视频流发送 SEI 数据时，流的发送状态会通过该回调通知远端用户。 你可以通过此回调判断携带 SEI 数据的视频帧为黑帧，从而不对该视频帧进行渲染。 |
消息
| 回调 | 描述 |
|---|---|
| OnRoomMessageReceivedEventHandler | 接收到房间内广播消息的回调。 房间内其他用户调用 SendRoomMessage 发送广播消息时，收到此回调。 |
| OnUserMessageReceivedEventHandler | 收到来自房间中其他用户通过 SendUserMessage 发来的点对点文本消息时，会收到此回调。 |
| OnUserMessageSendResultEventHandler | 向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。 |
| OnRoomMessageSendResultEventHandler | 调用 SendRoomMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 |
屏幕分享
| 回调 | 描述 |
|---|---|
| OnUserPublishScreenEventHandler | 房间内新增远端屏幕共享音视频流的回调。 |
| OnUserUnPublishScreenEventHandler | 房间内远端屏幕共享音视频流移除的回调。 |
| OnScreenVideoFrameSendStateChangedEventHandler | 屏幕共享流的视频首帧发送状态发生改变时，收到此回调。 |
高级功能
| 回调 | 描述 |
|---|---|
| OnAudioRecordingStateUpdateEventHandler | 调用 StartAudioRecording 或 StopAudioRecording 改变音频文件录制状态时，收到此回调。 |
最近更新时间：2025.12.11 17:42:02
这个页面对您有帮助吗？
有用
有用
无用
无用