# 自定义视频采集和渲染 (/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## createCustomVideoTrack [#createcustomvideotrack]
创建一个自定义视频轨道。
```java
public abstract int createCustomVideoTrack();
```
调用该方法创建一个视频轨道,并获取视频轨道 ID。该 ID 可用于发布自定义视频源。要发布自定义视频源,请按照以下步骤操作:
1. 调用该方法创建一个视频轨道,并获取视频轨道 ID。
2. 调用 `joinChannel` 加入频道。在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中,将 `customVideoTrackId` 设置为要发布的视频轨道 ID,并将 `publishCustomVideoTrack` 设置为 true。
3. 调用 `pushExternalVideoFrameById`,并将 `videoTrackId` 设置为第 2 步中指定的视频轨道 ID,即可在频道中发布对应的自定义视频源。
### 返回值 [#返回值]
- 方法调用成功,返回视频轨道的唯一标识符,即视频轨道 ID。
- 方法调用失败,返回 0xffffffff。
### 所属接口类 [#所属接口类]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## destroyCustomVideoTrack [#destroycustomvideotrack]
销毁指定的视频轨道。
```java
public abstract int destroyCustomVideoTrack(int video_track_id);
```
### 参数 [#参数]
调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 返回的视频轨道 ID。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## isTextureEncodeSupported [#istextureencodesupported]
检查视频是否支持 `Texture` 编码。
```java
public abstract boolean isTextureEncodeSupported();
```
### 返回值 [#返回值-2]
- true:支持 `Texture` 编码。
- false:不支持 `Texture` 编码。
### 所属接口类 [#所属接口类-2]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## pushExternalVideoFrameById [1/2] [#pushexternalvideoframebyid-12]
通过视频轨道向 SDK 推送外部原始视频帧。
```java
public abstract int pushExternalVideoFrameById(VideoFrame frame, int videoTrackId);
```
在 Android 自采集场景中,声网推荐优先使用 `io.agora.base.VideoFrame` 配合 `pushExternalVideoFrameById(VideoFrame frame, int videoTrackId)` 推送视频帧。[VideoFrame](/zh-CN/api-reference/rtc/android/class-videoframe) 支持通过统一的 `Buffer` 抽象封装 `I420`、`NV21`、`NV12` 和 Texture 等数据,适合新接入场景。
如果你只需向当前频道发布一路自采集视频,推荐在加入频道前调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource) 启用外部视频源,并在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中将 `publishCustomVideoTrack` 设置为 true、将 `customVideoTrackId` 设置为 `0`。此场景下,SDK 会自动创建默认自定义视频轨道,你无需先调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack)。
如果你需要发布多路自采集视频,或者需要在多个频道中分别发布不同的自采集视频流,请按照以下步骤操作:
1. 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 创建视频轨道并获取视频轨道 ID。
2. 调用 `joinChannel` 加入频道。在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中,将 `customVideoTrackId` 设置为要发布的视频轨道 ID,并将 `publishCustomVideoTrack` 设置为 true。
3. 调用 `pushExternalVideoFrameById`,并将 `videoTrackId` 设置为第 2 步中设置的视频轨道 ID,即可在频道中发布对应的自定义视频源。
如果你的现有采集模块已经基于 [AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe) 封装,仍可继续调用 `pushExternalVideoFrameById(AgoraVideoFrame frame, int videoTrackId)`;但该重载不支持 Texture 数据,且可扩展能力弱于 [VideoFrame](/zh-CN/api-reference/rtc/android/class-videoframe)。你可以通过调用 `pushExternalVideoFrameById` 或调用 `pushExternalVideoFrameById`(参数为 [AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe))推送视频帧。
:::note
注: 如果你只需向频道中推送一个自定义视频源,可以直接调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource),SDK 会自动创建一个 `videoTrackId` 为 0 的视频轨道。
危险:调用本方法后,即使你停止向 SDK 推送外部视频帧,自定义视频流仍会计入视频时长并产生费用。声网建议你根据实际情况采取适当措施以避免此类视频计费:
- 如果你不再需要采集外部视频数据,可以调用 [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) 销毁自定义视频轨道。
- 如果你只想将外部视频数据用于本地预览而不发布到频道中,可以调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/android/publishnsubscribe#api_irtcengine_mutelocalvideostream) 取消发送视频流,或调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/android/channel#api_irtcengine_updatechannelmediaoptions) 将 `publishCustomVideoTrack` 设置为 false。
:::
### 参数 [#参数-1]
要推送的视频帧。详见 [VideoFrame](/zh-CN/api-reference/rtc/android/class-videoframe)。
调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 返回的视频轨道 ID。
:::note
注: 如果你只需推送一个自定义视频源,请将 `videoTrackId` 设置为 0。
:::
### 返回值 [#返回值-3]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## pushExternalVideoFrame [1/2] [#pushexternalvideoframe-12]
将外部原始视频帧推送至 SDK。
```java
public abstract boolean pushExternalVideoFrame(VideoFrame frame)
```
:::error[废弃]
该方法已废弃。
:::
调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource) 方法并将 `enabled` 参数设置为 true,`encodedFrame` 参数设置为 false 后,可以使用该方法将外部原始视频帧推送至 SDK。你可以调用该方法或 `pushExternalVideoFrame` 推送视频帧。
:::note
注: 在 Android 自采集场景中,声网推荐优先使用 `io.agora.base.VideoFrame` 配合 `pushExternalVideoFrameById(VideoFrame frame, int videoTrackId)` 推送视频帧。[VideoFrame](/zh-CN/api-reference/rtc/android/class-videoframe) 支持通过统一的 `Buffer` 抽象封装 `I420`、`NV21`、`NV12` 和 Texture 等数据,适合新接入场景;[AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe) 更适合兼容现有基于字节数组的推帧实现。
:::
### 参数 [#参数-2]
要推送的视频帧。详见 [VideoFrame](/zh-CN/api-reference/rtc/android/class-videoframe)。
### 返回值 [#返回值-4]
- true:推送视频帧成功。
- false:推送视频帧失败。
### 所属接口类 [#所属接口类-4]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## pushExternalVideoFrameById [2/2] [#pushexternalvideoframebyid-22]
通过视频轨道向 SDK 推送外部原始视频帧。
```java
public abstract int pushExternalVideoFrameById(AgoraVideoFrame frame, int videoTrackId);
```
如果你的现有采集模块已经基于 [AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe) 封装,可继续调用该重载推送视频帧。
如果你只需向当前频道发布一路自采集视频,推荐在加入频道前调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource) 启用外部视频源,并在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中将 `publishCustomVideoTrack` 设置为 true、将 `customVideoTrackId` 设置为 `0`。此场景下,SDK 会自动创建默认自定义视频轨道,你无需先调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack)。
如果你需要发布多路自采集视频,或者需要在多个频道中分别发布不同的自采集视频流,请按照以下步骤操作:
1. 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 创建视频轨道并获取视频轨道 ID。
2. 调用 `joinChannel` 加入频道。在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中,将 `customVideoTrackId` 设置为要发布的视频轨道 ID,并将 `publishCustomVideoTrack` 设置为 true。
3. 调用 `pushExternalVideoFrameById`,并将 `videoTrackId` 设置为步骤 2 中设置的视频轨道 ID,即可在频道中发布对应的自定义视频源。
[AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe) 更适合兼容现有基于字节数组的推帧实现;如果你是新接入场景,声网更推荐使用 `pushExternalVideoFrameById(VideoFrame frame, int videoTrackId)` 重载,因为它支持 Texture 数据,且可通过统一的 `Buffer` 抽象封装更多格式。你可以通过调用 `pushExternalVideoFrameById` 或调用 `pushExternalVideoFrame` 推送视频帧。
:::note
注: 如果你只需向频道中推送一个自定义视频源,可以直接调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource) 方法,SDK 会自动创建一个 `videoTrackId` 为 0 的视频轨道。
警告:调用 `pushExternalVideoFrameById` 后,即使你停止向 SDK 推送外部视频帧,自定义视频流仍会被计入视频时长并产生费用。声网建议你根据实际情况采取适当措施以避免此类视频计费:
- 如果你不再需要采集外部视频数据,可以调用 [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) 销毁自定义视频轨道。
- 如果你只想将外部视频数据用于本地预览而不在频道中发布,可以调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/android/publishnsubscribe#api_irtcengine_mutelocalvideostream) 取消发送视频流,或调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/android/channel#api_irtcengine_updatechannelmediaoptions) 将 `publishCustomVideoTrack` 设置为 false。
:::
### 参数 [#参数-3]
要推送的外部原始视频帧。详见 [AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe)。
调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 返回的视频轨道 ID。
:::note
注: 如果你只需推送一个自定义视频源,请将 `videoTrackId` 设置为 0。
:::
### 返回值 [#返回值-5]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## pushExternalVideoFrame [2/2] [#pushexternalvideoframe-22]
将外部原始视频帧推送至 SDK。
```java
public abstract boolean pushExternalVideoFrame(AgoraVideoFrame frame)
```
:::error[废弃]
自 v4.5.0 版本废弃。
:::
调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/android/video/video-custom-capturenrendering#api_irtcengine_setexternalvideosource) 方法并将 `enabled` 参数设置为 true,`encodedFrame` 参数设置为 false 后,可以使用 `pushExternalVideoFrame` 将外部原始视频帧推送至 SDK。你也可以调用 `pushExternalVideoFrame` 推送视频帧。
### 参数 [#参数-4]
要推送的外部原始视频帧。详见 [AgoraVideoFrame](/zh-CN/api-reference/rtc/android/class-externalvideoframe)。
### 返回值 [#返回值-6]
- true:推送成功。
- false:推送失败。
### 所属接口类 [#所属接口类-6]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## setExternalRemoteEglContext [#setexternalremoteeglcontext]
设置用于渲染远端视频流的 EGL 上下文。
```java
public abstract int setExternalRemoteEglContext(Object eglContext);
```
该方法用于替换 SDK 默认的远端 EGL 上下文,便于你自行管理 EGL 上下文。当引擎销毁时,SDK 会自动释放该上下文。
### 适用场景 [#适用场景]
该方法适用于使用自定义渲染方式(如 Texture 格式)替代 SDK 默认渲染方式渲染远端视频帧的场景。
### 调用时机 [#调用时机]
请在加入频道前调用该方法。
### 参数 [#参数-5]
用于渲染远端视频流的 EGL 上下文。
### 返回值 [#返回值-7]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-7]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)
## setExternalVideoSource [#setexternalvideosource]
配置外部视频源。
```java
public abstract int setExternalVideoSource(boolean enable, boolean useTexture, Constants.ExternalVideoSourceType sourceType);
```
调用该方法后,可以调用 `pushExternalVideoFrameById` 向 SDK 推送外部视频数据。
:::note
注: 频道内不支持动态切换视频源。若需从外部视频源切换为内部视频源,必须先离开频道,调用该方法关闭外部视频源,再重新加入频道。
:::
### 调用时机 [#调用时机-1]
请在加入频道前调用该方法。
### 参数 [#参数-6]
是否使用外部视频源:
- true:使用外部视频源,SDK 会准备接收外部视频帧。
- false:(默认)不使用外部视频源。
是否使用 Texture 格式的外部视频帧:
- true:使用 Texture 格式的外部视频帧。
- false:(默认)不使用 Texture 格式的外部视频帧。
外部视频帧是否为编码格式,详见 [ExternalVideoSourceType](/zh-CN/api-reference/rtc/android/enum-externalvideosourcetype)。
### 返回值 [#返回值-8]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-8]
- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)