# 视频基础功能 (/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## disableVideo [#disablevideo] 关闭视频模块。 ```cpp virtual int disableVideo() = 0; ``` 该方法用于关闭视频模块。 ### 调用时机 [#调用时机] 加入频道前后均可调用: - 如果在加入频道前调用,则开启纯音频模式。 - 如果在加入频道后调用,则由视频模式切换为纯音频模式,然后再调用 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 方法可开启视频模式。 ### 调用限制 [#调用限制] - 该方法设置的是内部引擎为禁用状态,在离开频道后仍然有效。 - 调用该方法会重置整个引擎,响应时间较慢。你可以根据实际需求用以下方法来独立控制视频模块的某一项功能: - [enableLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablelocalvideo): 是否启动摄像头采集并创建本地视频流。 - [muteLocalVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_mutelocalvideostream): 是否发布本地视频流。 - [muteRemoteVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_muteremotevideostream): 是否接收并播放远端视频流。 - [muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_muteallremotevideostreams): 是否接收并播放所有远端视频流。 ### 相关回调 [#相关回调] 成功调用该方法后,远端会触发 [onUserEnableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onuserenablevideo) (`false`) 回调。 ### 返回值 [#返回值] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## enableLocalVideo [#enablelocalvideo] 开关本地视频采集。 ```cpp virtual int enableLocalVideo(bool enabled) = 0; ``` ### 详情 [#详情] 该方法禁用或重新启用本地视频采集,不影响接收远端视频。 调用 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后,本地视频采集即默认开启。 如果你在频道内调用 [enableLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablelocalvideo)(`false`) 关闭本地视频采集,也会同时停止在频道内发布视频流。如果想要重新开启,则可调用 enableLocalVideo(`true`),然后调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_updatechannelmediaoptions) 并设置 options 参数,将本地采集的视频流发布到频道中。 成功禁用或启用本地视频采集后,远端会触发 [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) 回调。 :::caution 注意: - 该方法在加入频道前后均可调用,但加入频道前调用的设置,在加入频道后才会生效。 - 该方法设置内部引擎为启用状态,在离开频道后仍然有效。 ::: ### 参数 [#参数] 是否开启本地视频采集。 - `true`:(默认)开启本地视频采集。 - `false`: 关闭本地视频采集。关闭后,远端用户会接收不到本地用户的视频流;但本地用户依然可以接收远端用户的视频流。设置为 `false` 时,该方法不需要本地有摄像头。 ### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## enableVideo [#enablevideo] 启用视频模块。 ```cpp virtual int enableVideo() = 0; ``` 视频模块默认为关闭状态,需要调用该方法启用。如果后续需要关闭视频模块,需调用 [disableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_disablevideo) 方法。 ### 调用时机 [#调用时机-1] 该方法可以在加入频道前或者频道内调用: - 如果在加入频道前调用,则开启视频模块。 - 如果在纯音频通话中调用,则音频通话将自动切换为视频通话。 ### 调用限制 [#调用限制-1] - 该方法设置的是内部引擎为启用状态,在离开频道后仍然有效。 - 调用该方法会重置整个引擎,响应时间较慢。你可以根据实际需求用以下方法来独立控制视频模块的某一项功能: - [enableLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablelocalvideo): 是否启动摄像头采集并创建本地视频流。 - [muteLocalVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_mutelocalvideostream): 是否发布本地视频流。 - [muteRemoteVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_muteremotevideostream): 是否接收并播放远端视频流。 - [muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_muteallremotevideostreams): 是否接收并播放所有远端视频流。 - 在频道内调用该方法时,会重置 enableLocalVideo、muteRemoteVideoStream 和 muteAllRemoteVideoStreams 的设置,需谨慎使用。 ### 相关回调 [#相关回调-1] 成功调用该方法后,远端会触发 [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) 回调。 ### 返回值 [#返回值-2] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## setVideoEncoderConfiguration [#setvideoencoderconfiguration] 设置视频编码属性。 ```cpp virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0; ``` 设置本地视频的编码属性。每一种视频编码属性对应一系列视频相关参数设置,包含分辨率、帧率和码率。 ### 调用时机 [#调用时机-2] 该方法在加入频道前后都能调用。如果用户在加入频道后不需要重新设置视频编码属性,则建议在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 前调用该方法,可以加快首帧出图的时间。 ### 调用限制 [#调用限制-2] - 该方法和 [getMirrorApplied](/zh-CN/api-reference/rtc/unreal-cpp/video/video-raw#callback_ivideoframeobserver_getmirrorapplied) 方法均支持设置镜像效果,声网建议你仅选择一种方法进行设置,同时使用两种方法会导致镜像效果叠加从而造成设置镜像失败。 - 该方法的 config 参数设置是在理想网络状态下能达到的最大值。如果网络状态不好,视频引擎便不能使用该 config 渲染本地视频,它会自动降低到一个合适的视频参数设置。 ### 参数 [#参数-1] 视频编码参数配置。详见 [VideoEncoderConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/class-videoencoderconfiguration)。 ### 返回值 [#返回值-3] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## setVideoEncoderConfigurationEx [#setvideoencoderconfigurationex] 设置视频编码属性。 ```cpp virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration& config, const RtcConnection& connection) = 0; ``` 设置本地视频的编码属性。每一种视频编码属性对应一系列视频相关参数设置,包含分辨率、帧率和码率。 ### 调用时机 [#调用时机-3] 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 之后调用。 ### 调用限制 [#调用限制-3] 该方法的 config 参数设置是在理想网络状态下能达到的最大值。如果网络状态不好,视频引擎便不能使用该 config 渲染本地视频,它会自动降低到一个合适的视频参数设置。 ### 参数 [#参数-2] 视频编码参数配置。详见 [VideoEncoderConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/class-videoencoderconfiguration)。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 ### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## setVideoScenario [#setvideoscenario] 设置视频业务场景。 ```cpp virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType) = 0; ``` ### 详情 [#详情-1] 成功调用该方法设置视频业务场景后,SDK 会基于指定场景启用最佳实践策略,自动调整关键性能指标,进而优化视频体验质量。 :::caution 注意: 该方法需要在加入频道前调用。 ::: ### 参数 [#参数-3] 视频业务场景。详见 [VIDEO_APPLICATION_SCENARIO_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videoapplicationscenariotype)。 APPLICATION_SCENARIO_MEETING (1) 适用于会议场景。SDK 会针对该场景启用以下策略: - 针对会议场景对小流码率要求较高的情况,自动启用多项抗弱网技术,提升小流的抗弱网能力,确保多路流订阅时接收端的流畅性。 - 实时监测接收端大流的订阅人数,根据订阅人数动态调节大流配置: - 无人订阅大流时,会自动降低大流的码率和帧率,节省上行带宽和消耗。 - 有人订阅大流时,大流会重置为用户最近一次调用 [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_setvideoencoderconfiguration) 时的 [VideoEncoderConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/class-videoencoderconfiguration) 配置。如果用户此前没有进行设置,则使用如下值: - 视频分辨率:桌面端为 1280 × 720;移动端为 960 × 540 - 视频帧率:15 fps - 码率:桌面端为 1600 Kbps;移动端为 1000 Kbps - 实时监测接收端小流的订阅人数,根据订阅人数动态开启和关闭小流: :::note 注: 如果用户已调用 [setDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_setdualstreammode2) 将小流设置为始终不发送 (DISABLE_SIMULCAST_STREAM),会议场景对小流的动态开关不生效。 ::: - 无人订阅小流时,自动关闭小流,节省上行带宽和消耗。 - 有人订阅小流时,开启小流并重置为用户最近一次调用 setDualStreamMode [2/2] 时的 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-simulcaststreamconfig) 配置。如果用户此前没有进行设置,则使用如下值: - 视频分辨率:480 × 272 - 视频帧率:15 fps - 码率:500 Kbps APPLICATION_SCENARIO_1V1 (2) 适用于[视频 1v1 通话](/zh-CN/solutions/one-to-one-live/rtm)场景。针对该场景低延迟、高画质的体验要求,SDK 进行了策略调优,提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。 APPLICATION_SCENARIO_LIVESHOW (3) 适用于秀场直播场景。针对该场景对首帧出图时间和画质清晰度的高要求,SDK 进行了策略调优,例如,默认开启音视频帧加速渲染来提升首帧出图体验,无需再额外调用 [enableInstantMediaRendering](/zh-CN/api-reference/rtc/unreal-cpp/video/video-rendering#api_irtcengine_enableinstantmediarendering),同时会默认开启 B 帧来确保较高的图像质量、提高传输效率。此外,也增强了在弱网环境和低端设备上的画质和流畅度表现。 ### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -1:一般性的错误(未明确归类)。 - -4:不支持设置视频业务场景。可能的原因是当前使用的是音频 SDK。 - -7:IRtcEngine 对象尚未初始化。你需要在调用该方法前成功初始化 IRtcEngine 对象。 ### 所属接口类 [#所属接口类-5] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## startPreview [1/2] [#startpreview-12] 开启视频预览。 ```cpp virtual int startPreview() = 0; ``` 该方法用于启动本地视频预览。 ### 调用时机 [#调用时机-4] 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 和 [setupLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-rendering#api_irtcengine_setuplocalvideo) 之后调用。 ### 调用限制 [#调用限制-4] - 本地预览默认开启镜像功能。 - 在离开频道后,本地预览依然处于开启状态。你需要调用 [stopPreview [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_stoppreview) 关闭本地预览。 ### 返回值 [#返回值-6] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-6] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## startPreview [2/2] [#startpreview-22] 开启视频预览并指定预览的视频源。 ```cpp virtual int startPreview(VIDEO_SOURCE_TYPE sourceType) = 0; ``` 该方法用于启动本地视频预览,并指定出现在预览画面中的视频源。 ### 调用时机 [#调用时机-5] 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 和 [setupLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-rendering#api_irtcengine_setuplocalvideo) 之后调用。 ### 调用限制 [#调用限制-5] - 本地预览默认开启镜像功能。 - 在离开频道后,本地预览依然处于开启状态。你需要调用 [stopPreview [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_stoppreview) 关闭本地预览。 ### 参数 [#参数-4] 视频源的类型,详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 ### 返回值 [#返回值-7] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-7] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## stopPreview [1/2] [#stoppreview-12] 停止视频预览。 ```cpp virtual int stopPreview() = 0; ``` ### 适用场景 [#适用场景] 调用 [startPreview [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview) 开启预览后,如果你想关闭本地视频预览,请调用该方法。 ### 调用时机 [#调用时机-6] 请在加入频道前或离开频道后调用该方法。 ### 调用限制 [#调用限制-6] 无。 ### 返回值 [#返回值-8] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-8] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## stopPreview [2/2] [#stoppreview-22] 停止视频预览。 ```cpp virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType) = 0; ``` ### 适用场景 [#适用场景-1] 调用 [startPreview [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview2) 开启预览后,如果你想关闭本地视频预览,请调用该方法。 ### 调用时机 [#调用时机-7] 请在加入频道前或离开频道后调用该方法。 ### 调用限制 [#调用限制-7] 无。 ### 参数 [#参数-5] 视频源的类型,详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 ### 返回值 [#返回值-9] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-9] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## onFirstLocalVideoFrame [#onfirstlocalvideoframe] 已显示本地视频首帧回调。 ```cpp virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) { (void)source; (void)width; (void)height; (void)elapsed; } ``` ### 详情 [#详情-2] 本地视频首帧显示在本地视图上时,SDK 会触发此回调。 ### 参数 [#参数-6] 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 本地渲染视频的宽 (px) 。 本地渲染视频的高 (px)。 从调用 [joinChannel [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel) 或[joinChannel [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel2) 加入频道时到发生此事件过去的时间(毫秒)。如果在加入频道前调用了 [startPreview [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview)/[startPreview [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview2),则该参数表示从调用 startPreview [1/2] 或startPreview [2/2] 开启本地视频预览到发生此事件过去的时间。 ### 所属接口类 [#所属接口类-10] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onFirstLocalVideoFramePublished [#onfirstlocalvideoframepublished] 已发布本地视频首帧回调。 ```cpp virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) { (void)source; (void)elapsed; } ``` ### 详情 [#详情-3] SDK 会在以下三种时机触发该回调: - 开启本地视频模块的情况下,调用 [joinChannel [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel) 或[joinChannel [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel2) 成功加入频道后。 - 调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_mutelocalvideostream)(`true`),再调用 muteLocalVideoStream(`false`) 后。 - 调用 [disableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_disablevideo),再调用 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后。 - 调用 [pushVideoFrame](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) 成功向 SDK 推送视频帧后。 ### 参数 [#参数-7] 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 从调用 joinChannel [1/2] 或joinChannel [2/2] 方法到触发该回调的时间间隔(毫秒)。 ### 所属接口类 [#所属接口类-11] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onFirstRemoteVideoDecoded [#onfirstremotevideodecoded] 已接收到远端视频并完成解码回调。 ```cpp virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) { (void)uid; (void)width; (void)height; (void)elapsed; } ``` ### 详情 [#详情-4] SDK 会在以下时机触发该回调: - 远端用户首次上线后发送视频。 - 远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括: - 远端用户离开频道。 - 远端用户掉线。 - 远端用户调用 [disableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_disablevideo) 方法关闭视频模块。 ### 参数 [#参数-8] 用户 ID,指定是哪个用户的视频流。 视频流宽(px)。 视频流高(px)。 从本地调用 joinChannel [1/2] 或joinChannel [2/2] 开始到该回调触发的延迟(毫秒)。 ### 所属接口类 [#所属接口类-12] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onFirstRemoteVideoFrame [#onfirstremotevideoframe] 渲染器已接收首帧远端视频回调。 ```cpp virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) { (void)userId; (void)width; (void)height; (void)elapsed; } ``` ### 详情 [#详情-5] :::caution 注意: 该回调只在 SDK 渲染时才会触发;如果用户采用自定义视频渲染则不会触发,客户需要通过 SDK 以外的方法自行实现。 ::: ### 参数 [#参数-9] 用户 ID,指定是哪个用户的视频流。 视频流宽(px)。 视频流高(px)。 从本地调用 joinChannel [1/2] 或joinChannel [2/2] 到发生此事件过去的时间(毫秒)。 ### 所属接口类 [#所属接口类-13] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onLocalVideoStateChanged [#onlocalvideostatechanged] 本地视频状态发生改变回调。 ```cpp virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason) { (void)source; (void)state; (void)reason; } ``` 本地视频的状态发生改变时,SDK 会触发该回调,报告当前的本地视频状态以及状态改变的原因。 ### 适用场景 [#适用场景-2] 你可以通过该回调及时了解本地视频流的状态变化,并根据状态改变的原因采取相应的措施,更好地管理和调试视频流相关的问题。 ### 触发时机 [#触发时机] - SDK 会在如下情况触发该回调,且 state 为 LOCAL_VIDEO_STREAM_STATE_FAILED,reason 为 `LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE`: - 应用退到后台,系统回收摄像头。 - Android 9 及以上版本,App 切后台一段时间后,系统会收回相机权限。 - Android 6 及以上版本,如果相机被第三方应用占用一段时间后释放,则 SDK 会触发该回调,并报告 onLocalVideoStateChanged(`LOCAL_VIDEO_STREAM_STATE_CAPTURING,LOCAL_VIDEO_STREAM_REASON_OK`) 回调。 - 摄像头正常启动,但连续 4 秒都没有输出采集的视频。 - 当摄像头输出采集的视频帧时,如果 SDK 检测到连续 15 个重复的视频帧,会触发该回调,且 state 为 LOCAL_VIDEO_STREAM_STATE_CAPTURING,reason 为 LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE。 :::note 注: - 帧重复检测仅针对分辨率大于 200 × 200、帧率大于等于 10 fps、码率小于 20 Kbps 的视频帧。 - 如果视频采集出现异常,正常情况下可以通过该回调的 `reason` 参数来排查问题。但在部分设备上,采集出现问题时(如卡死) Android 系统不会抛出任何错误回调,因此 SDK 无法报告本地视频状态改变的原因,此时你可以通过下列方式来判断采集是否无帧:该回调报告 `state` 为 `LOCAL_VIDEO_STREAM_STATE_CAPTURING` 或 `LOCAL_VIDEO_STREAM_STATE_ENCODING`,且 [onLocalVideoStats](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostats) 回调的 `captureFrameRate` 为 0。 ::: ### 参数 [#参数-10] 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 本地视频状态,详见 [LOCAL_VIDEO_STREAM_STATE](/zh-CN/api-reference/rtc/unreal-cpp/enum-localvideostreamstate)。 本地视频状态改变原因,详见 [LOCAL_VIDEO_STREAM_REASON](/zh-CN/api-reference/rtc/unreal-cpp/enum-localvideostreamreason)。 ### 所属接口类 [#所属接口类-14] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onLocalVideoStats [#onlocalvideostats] 本地视频流统计信息回调。 ```cpp virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) { (void)source; (void)stats; } ``` ### 详情 [#详情-6] 该回调描述本地设备发送视频流的统计信息,每 2 秒触发一次。 ### 参数 [#参数-11] 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 本地视频流统计信息。详见 [LocalVideoStats](/zh-CN/api-reference/rtc/unreal-cpp/class-localvideostats)。 ### 所属接口类 [#所属接口类-15] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onRemoteVideoStateChanged [#onremotevideostatechanged] 远端视频状态发生改变回调。 ```cpp virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { (void)uid; (void)state; (void)reason; (void)elapsed; } ``` ### 详情 [#详情-7] :::caution 注意: 频道内的用户(通信场景)或主播(直播场景)人数超过 32 人时,该回调可能不准确。 ::: ### 参数 [#参数-12] 发生视频状态改变的远端用户 ID。 远端视频流状态,详见 [REMOTE_VIDEO_STATE](/zh-CN/api-reference/rtc/unreal-cpp/enum-remotevideostate)。 远端视频流状态改变的具体原因,详见 [REMOTE_VIDEO_STATE_REASON](/zh-CN/api-reference/rtc/unreal-cpp/enum-remotevideostatereason)。 从本地用户调用 joinChannel [2/2] 方法到发生本事件经历的时间,单位为毫秒。 ### 所属接口类 [#所属接口类-16] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onRemoteVideoStats [#onremotevideostats] 通话中远端视频流的统计信息回调。 ```cpp virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { (void)stats; } ``` ### 详情 [#详情-8] 该回调描述远端用户在通话中端到端的视频流统计信息, 针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播, 该回调每 2 秒会被触发多次。 ### 参数 [#参数-13] 远端视频统计数据。详见 [RemoteVideoStats](/zh-CN/api-reference/rtc/unreal-cpp/class-remotevideostats)。 ### 所属接口类 [#所属接口类-17] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onRemoteVideoTransportStats [#onremotevideotransportstats] 通话中远端视频流传输的统计信息回调。 ```cpp virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { (void)uid; (void)delay; (void)lost; (void)rxKBitRate; } ``` ### 详情 [#详情-9] :::error[弃用:] 该回调已被废弃,请改用 [onRemoteVideoStats](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onremotevideostats)。 ::: 该回调描述远端用户通话中端到端的网络统计信息,通过视频包计算,用客观的数据,如丢包、 网络延迟等,展示当前网络状态。 通话中,当用户收到远端用户/主播发送的视频数据包后,会每 2 秒触发一次该回调。 ### 参数 [#参数-14] 用户 ID,指定是哪个用户/主播的视频包。 视频包从发送端到接收端的延时(毫秒)。 视频包从发送端到接收端的丢包率 (%)。 远端视频包的接收码率(Kbps)。 ### 所属接口类 [#所属接口类-18] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onUserEnableLocalVideo [#onuserenablelocalvideo] 远端用户开/关本地视频采集回调。 ```cpp virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; } ``` ### 详情 [#详情-10] :::error[弃用:] 该回调已废弃,请改用 [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) 回调的如下枚举: - REMOTE_VIDEO_STATE_STOPPED(0) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)。 - REMOTE_VIDEO_STATE_DECODING (2) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)。 ::: 该回调是由远端用户调用 [enableLocalVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablelocalvideo) 方法开启或关闭视频采集触发的。 ### 参数 [#参数-15] 用户 ID,提示是哪个用户的视频流。 远端用户是否启用视频采集: - `true`: 该用户已启用视频功能。启用后,其他用户可以接收到该用户的视频流。 - `false`: 该用户已关闭视频功能。关闭后,该用户仍然可以接收其他用户的视频流,但其他用户接收不到该用户的视频流。 ### 所属接口类 [#所属接口类-19] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onUserEnableVideo [#onuserenablevideo] 远端用户开/关视频模块回调。 ```cpp virtual void onUserEnableVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; } ``` ### 详情 [#详情-11] 关闭视频功能是指该用户只能进行语音通话,不能显示、发送自己的视频,也不能接收、显示别人的视频。 该回调是由远端用户调用 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 或 [disableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_disablevideo) 方法开启或关闭视频模块触发的。 ### 参数 [#参数-16] 用户 ID,提示是哪个用户的视频流。 - `true`: 该用户已启用视频功能。 - `false`: 该用户已关闭视频功能。 ### 所属接口类 [#所属接口类-20] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onUserMuteVideo [#onusermutevideo] 远端用户取消或恢复发布视频流回调。 ```cpp virtual void onUserMuteVideo(uid_t uid, bool muted) { (void)uid; (void)muted; } ``` ### 详情 [#详情-12] 当远端用户调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_mutelocalvideostream) 取消或恢复发布视频流时,SDK 会触发该回调向本地用户报告远端用户的发流状况。 :::caution 注意: 当频道内的用户(通信场景)或主播(直播场景)的人数超过 32 人时,该回调可能不准确。 ::: ### 参数 [#参数-17] 远端用户 ID。 远端用户是否取消发布视频流: - `true`: 取消发布视频流。 - `false`: 发布视频流。 ### 所属接口类 [#所属接口类-21] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onVideoPublishStateChanged [#onvideopublishstatechanged] 视频发布状态改变回调。 ```cpp virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { (void)source; (void)channel; (void)oldState; (void)newState; (void)elapseSinceLastState; } ``` ### 参数 [#参数-18] 频道名。 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 之前的发布状态,详见 [STREAM_PUBLISH_STATE](/zh-CN/api-reference/rtc/unreal-cpp/enum-streampublishstate)。 当前的发布状态,详见 STREAM_PUBLISH_STATE。 两次状态变化时间间隔(毫秒)。 ### 所属接口类 [#所属接口类-22] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onVideoSizeChanged [#onvideosizechanged] 本地或远端视频大小和旋转信息发生改变回调。 ```cpp virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) { (void)uid; (void)width; (void)height; (void)rotation; } ``` ### 参数 [#参数-19] 视频源的类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。 图像尺寸和旋转信息发生变化的用户 ID(本地用户的 uid 为 0。此时视频为本地用户的视频预览)。 视频流的宽度(像素)。 视频流的高度(像素)。 旋转信息,取值范围 [0,360)。 :::note 注: 在 iOS 平台上,该参数值始终为 0。 ::: ### 所属接口类 [#所属接口类-23] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onVideoStopped [#onvideostopped] 视频功能已停止回调。 ```cpp virtual void onVideoStopped() ``` ### 详情 [#详情-13] :::error[弃用:] 请改用 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。 ::: App 如需在停止视频后对 view 做其他处理(比如显示其他画面),可以在这个回调中进行。 ### 所属接口类 [#所属接口类-24] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)