# 自定义视频采集和渲染 (/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## createCustomVideoTrack [#createcustomvideotrack] 创建一个自定义的视频轨道。 ```ts abstract createCustomVideoTrack(): number; ``` 当你需要在频道中发布自定义采集视频时,可参考以下步骤: 1. 调用该方法创建视频轨道并获得视频轨道 ID。 2. 调用 [joinChannel](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_joinchannel2) 加入频道时,将 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中的 `customVideoTrackId` 设置为你想要发布的视频轨道 ID,并将 `publishCustomVideoTrack` 设置为 true。 3. 调用 [pushVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) 将 `videoTrackId` 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。 ### 返回值 [#返回值] - 方法调用成功,返回视频轨道 ID 作为该视频轨道的唯一标识。 - 方法调用失败,返回 0xffffffff。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## destroyCustomVideoTrack [#destroycustomvideotrack] 销毁指定的视频轨道。 ```ts abstract destroyCustomVideoTrack(videoTrackId: number): number; ``` ### 参数 [#参数] 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 方法返回的视频轨道 ID。 ### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## isPipActivated [#ispipactivated] 检查画中画模式是否已激活。 ```ts abstract isPipActivated(): boolean; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 返回值 [#返回值-2] - true:画中画模式已激活。 - false:画中画模式未激活。 ### 所属接口类 [#所属接口类-2] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipDispose [#pipdispose] 释放画中画相关的资源。 ```ts abstract pipDispose(): void; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 所属接口类 [#所属接口类-3] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipIsAutoEnterSupported [#pipisautoentersupported] 检查是否支持自动进入画中画模式。 ```ts abstract pipIsAutoEnterSupported(): boolean; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 返回值 [#返回值-3] - true:支持自动进入画中画模式。 - false:不支持自动进入画中画模式。 ### 所属接口类 [#所属接口类-4] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipIsSupported [#pipissupported] 检查当前设备是否支持画中画模式。 ```ts abstract pipIsSupported(): boolean; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 返回值 [#返回值-4] - true:当前设备支持画中画模式。 - false:当前设备不支持画中画模式。 ### 所属接口类 [#所属接口类-5] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipSetup [#pipsetup] 配置画中画模式。 ```ts abstract pipSetup(options: AgoraPipOptions): boolean; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 参数 [#参数-1] 画中画配置选项,详见 [AgoraPipOptions](/zh-CN/api-reference/rtc/react-native/class-agorapipoptions)。 ### 返回值 [#返回值-5] - true:方法调用成功。 - false:方法调用失败。 ### 所属接口类 [#所属接口类-6] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipStart [#pipstart] 启动画中画模式。 ```ts abstract pipStart(): boolean; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 返回值 [#返回值-6] - true:方法调用成功。 - false:方法调用失败。 ### 所属接口类 [#所属接口类-7] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pipStop [#pipstop] 停止画中画模式。 ```ts abstract pipStop(): void; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 所属接口类 [#所属接口类-8] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## pushVideoFrame [#pushvideoframe] 将外部原始视频帧通过自定义视频轨道发布到频道中。 ```ts abstract pushVideoFrame( frame: ExternalVideoFrame, videoTrackId?: number ): number; ``` 当你需要在频道中发布自定义采集视频时,可参考以下步骤: 1. 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 方法创建视频轨道并获得视频轨道 ID。 2. 调用 [joinChannel](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_joinchannel2) 加入频道时,将 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中的 `customVideoTrackId` 设置为你想要发布的视频轨道 ID,并将 `publishCustomVideoTrack` 设置为 true。 3. 调用该方法将 `videoTrackId` 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。 :::note 注: 调用该方法后,即使你停止推送外部视频帧到 SDK,自定义采集的视频流仍然会被计入视频时长用量并产生费用,声网建议你根据实际情况采取相应措施避免此类视频计费: - 如果你不再需要采集外部视频数据,可以调用 [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) 销毁自定义采集的视频轨道。 - 如果你只想将采集到的外部视频数据用于本地预览、而不在频道内发布,可以调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_mutelocalvideostream) 取消发送视频流,或调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_updatechannelmediaoptions) 将 `publishCustomVideoTrack` 设置为 false。 ::: ### 参数 [#参数-2] 待推送的视频帧。详见 [ExternalVideoFrame](/zh-CN/api-reference/rtc/react-native/class-externalvideoframe)。 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 方法返回的视频轨道 ID。 :::note 注: 如果你只需推送一路外部视频流,`videoTrackId` 设置为 0 即可。 ::: ### 返回值 [#返回值-7] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-9] - [IMediaEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengine) ## registerPipStateChangedObserver [#registerpipstatechangedobserver] 注册画中画状态改变观测器。 ```ts abstract registerPipStateChangedObserver(observer: AgoraPipStateChangedObserver): void; ``` ### 参数 [#参数-3] 画中画状态改变观测器,详见 [AgoraPipStateChangedObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapipstatechangedobserver)。 ### 所属接口类 [#所属接口类-10] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## release [#release] 释放画中画相关的资源。 ```ts abstract release(): void; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 所属接口类 [#所属接口类-11] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## setExternalRemoteEglContext [#setexternalremoteeglcontext] 设置远端视频流渲染的 EGL 环境上下文。 ```ts abstract setExternalRemoteEglContext(eglContext: any): number; ``` 通过设置该方法,开发者可以替换 SDK 内部默认的远端 EGL 环境上下文,便于实现统一的 EGL 上下文管理。 引擎销毁时,SDK 会自动释放 EGL 环境上下文。 :::note 注: 该方法仅适用于 Android。 ::: ### 适用场景 [#适用场景] 该方法适用于使用 Texture 格式的视频数据进行远端视频自渲染的场景。 ### 调用时机 [#调用时机] 该方法需要在加入频道前调用。 ### 参数 [#参数-4] 用于远端视频流渲染的 EGL 环境上下文对象。 ### 返回值 [#返回值-8] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-12] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## setExternalVideoSource [#setexternalvideosource] 设置外部视频源。 ```ts abstract setExternalVideoSource( enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions ): number; ``` 调用该方法启用外部视频源后,你可以调用 [pushVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) 向 SDK 推送外部视频数据。 :::note 注: 不支持在频道内动态切换视频源。如果已调用该方法启用外部视频源并加入频道,若想切换为内部视频源,必须先退出频道,然后调用该方法关闭外部视频源,再重新加入频道。 ::: ### 调用时机 [#调用时机-1] 该方法需要在加入频道前调用。 ### 参数 [#参数-5] 是否启用外部视频源: - true: 启用外部视频源。SDK 准备接收外部视频帧。 - false:(默认)不启用外部视频源。 是否使用 Texture 格式的外部视频帧: - true: 使用 Texture 格式的外部视频帧。 - false: 不使用 Texture 格式的外部视频帧。 外部视频帧是否编码,详见 [ExternalVideoSourceType](/zh-CN/api-reference/rtc/react-native/enum-externalvideosourcetype)。 视频编码选项。如果 `sourceType` 为 `EncodedVideoFrame`,则需要设置该参数。你可以[联系技术支持](https://ticket.shengwang.cn/)了解如何设置该参数。 ### 返回值 [#返回值-9] - 0:方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-13] - [IMediaEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengine) ## unregisterPipStateChangedObserver [#unregisterpipstatechangedobserver] 取消注册画中画状态改变观测器。 ```ts abstract unregisterPipStateChangedObserver(observer: AgoraPipStateChangedObserver): void; ``` ### 参数 [#参数-6] 画中画状态改变观测器,详见 [AgoraPipStateChangedObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapipstatechangedobserver)。 ### 所属接口类 [#所属接口类-14] - [AgoraPip](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapip) ## onPipStateChanged [#onpipstatechanged] 画中画状态改变回调。 ```ts onPipStateChanged: (state: AgoraPipState, error: string | null) => void; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: 当画中画状态发生改变时,SDK 会触发此回调。 ### 参数 [#参数-7] 新的画中画状态,详见 [AgoraPipState](/zh-CN/api-reference/rtc/react-native/enum-agorapipstate)。 如果状态改变失败,返回错误信息;否则返回 null。 ### 所属接口类 [#所属接口类-15] - [AgoraPipStateChangedObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_agorapipstatechangedobserver)