# 自定义视频采集和渲染 (/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_video_custom_capturenrendering"></a>

<a id="api_irtcengine_createcustomvideotrack"></a>

<a id="ariaid-title2"></a>

## createCustomVideoTrack [#createcustomvideotrack]

创建一个自定义的视频轨道。

<a id="api_irtcengine_createcustomvideotrack__prototype"></a>

```cpp
virtual video_track_id_t createCustomVideoTrack() = 0;
```

<a id="api_irtcengine_createcustomvideotrack__detailed_desc"></a>

### 详情 [#详情]

当你需要在频道中发布自定义采集视频时，可参考以下步骤：

1. 调用该方法创建视频轨道并获得视频轨道 ID。
2. 调用 [joinChannel [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel2) 加入频道时，将 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID，并将 publishCustomVideoTrack 设置为 `true`。
3. 调用 [pushVideoFrame](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) 将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID，即可实现在频道内发布对应的自定义视频源。

<a id="api_irtcengine_createcustomvideotrack__return_values"></a>

### 返回值 [#返回值]

- 方法调用成功，返回视频轨道 ID 作为该视频轨道的唯一标识。
- 方法调用失败，返回 0xffffffff。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类]

- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_destroycustomvideotrack"></a>

<a id="ariaid-title3"></a>

## destroyCustomVideoTrack [#destroycustomvideotrack]

销毁指定的视频轨道。

<a id="api_irtcengine_destroycustomvideotrack__prototype"></a>

```cpp
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id) = 0;
```

<a id="api_irtcengine_destroycustomvideotrack__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="video_track_id"></a>
<Parameter name="video_track_id">

调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 方法返回的视频轨道 ID。

</Parameter>
</ParameterList>

<a id="api_irtcengine_destroycustomvideotrack__return_values"></a>

### 返回值 [#返回值-1]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)

<a id="api_imediaengine_pushvideoframe"></a>

<a id="ariaid-title4"></a>

## pushVideoFrame [#pushvideoframe]

将外部原始视频帧通过自定义视频轨道发布到频道中。

<a id="api_imediaengine_pushvideoframe__prototype"></a>

```cpp
virtual int pushVideoFrame(base::ExternalVideoFrame* frame, unsigned int videoTrackId = 0) = 0;
```

<a id="api_imediaengine_pushvideoframe__detailed_desc"></a>

### 详情 [#详情-1]

<a id="api_imediaengine_pushvideoframe__desc1"></a>

当你需要在频道中发布自定义采集视频时，可参考以下步骤：

1. 调用 [createCustomVideoTrack](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) 方法创建视频轨道并获得视频轨道 ID。

   :::note
   注： 如果你只需推送一路自定义采集的视频流到频道中，可以直接调用 [setExternalVideoSource](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_imediaengine_setexternalvideosource) 方法启用外部视频源，此时 SDK 会自动创建一个 videoTrackId 为 0 的视频轨道。
   :::
2. 调用 [joinChannel [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel2) 加入频道时，将 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID，并将 publishCustomVideoTrack 设置为 `true`。
3. 调用该方法将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID，即可实现在频道内发布对应的自定义视频源。

<a id="api_imediaengine_pushvideoframe__desc2"></a>

:::error
危险： 调用该方法后，即使你停止推送外部视频帧到 SDK，自定义采集的视频流仍然会被计入视频时长用量并产生费用，声网建议你根据实际情况采取相应措施避免此类视频计费：

- 如果你不再需要采集外部视频数据，可以调用 [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) 销毁自定义采集的视频轨道。
- 如果你只想将采集到的外部视频数据用于本地预览、而不在频道内发布，可以调用 [muteLocalVideoStream](/zh-CN/api-reference/rtc/unreal-cpp/publishnsubscribe#api_irtcengine_mutelocalvideostream) 取消发送视频流，或调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_updatechannelmediaoptions) 将 publishCustomVideoTrack 设置为 `false`。
:::

<a id="api_imediaengine_pushvideoframe__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="frame"></a>
<Parameter name="frame">

待推送的视频帧。详见 [ExternalVideoFrame](/zh-CN/api-reference/rtc/unreal-cpp/class-externalvideoframe)。

</Parameter>
<a id="videotrackid"></a>
<Parameter name="videoTrackId">

调用 createCustomVideoTrack 方法返回的视频轨道 ID。

:::note
注： 如果你只需推送一路外部视频流，videoTrackId 设置为 0 即可。
:::

</Parameter>
</ParameterList>

<a id="api_imediaengine_pushvideoframe__return_values"></a>

### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-2]

- [IMediaEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaengine)

<a id="api_irtcengine_setexternalremoteeglcontext"></a>

<a id="ariaid-title5"></a>

## setExternalRemoteEglContext [#setexternalremoteeglcontext]

设置远端视频流渲染的 EGL 环境上下文。

<a id="api_irtcengine_setexternalremoteeglcontext__prototype"></a>

```cpp
virtual int setExternalRemoteEglContext(void* eglContext) = 0;
```

<a id="api_irtcengine_setexternalremoteeglcontext__detailed_desc"></a>

通过设置该方法，开发者可以替换 SDK 内部默认的远端 EGL 环境上下文，便于实现统一的 EGL 上下文管理。

引擎销毁时，SDK 会自动释放 EGL 环境上下文。

:::caution
注意： 该方法仅适用于 Android。
:::

<a id="api_irtcengine_setexternalremoteeglcontext__scenario"></a>

### 适用场景 [#适用场景]

该方法适用于使用 Texture 格式的视频数据进行远端视频自渲染的场景。

<a id="api_irtcengine_setexternalremoteeglcontext__timing"></a>

### 调用时机 [#调用时机]

该方法需要在加入频道前调用。

<a id="api_irtcengine_setexternalremoteeglcontext__restriction"></a>

### 调用限制 [#调用限制]

无。

<a id="api_irtcengine_setexternalremoteeglcontext__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="eglcontext"></a>
<Parameter name="eglContext">

用于远端视频流渲染的 EGL 环境上下文对象。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setexternalremoteeglcontext__return_values"></a>

### 返回值 [#返回值-3]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)

<a id="api_imediaengine_setexternalvideosource"></a>

<a id="ariaid-title6"></a>

## setExternalVideoSource [#setexternalvideosource]

设置外部视频源。

<a id="api_imediaengine_setexternalvideosource__prototype"></a>

```cpp
virtual int setExternalVideoSource(
    bool enabled, bool useTexture, EXTERNAL_VIDEO_SOURCE_TYPE sourceType = VIDEO_FRAME,
    rtc::SenderOptions encodedVideoOption = rtc::SenderOptions()) = 0;
```

<a id="api_imediaengine_setexternalvideosource__detailed_desc"></a>

调用该方法启用外部视频源后，你可以调用 [pushVideoFrame](/zh-CN/api-reference/rtc/unreal-cpp/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) 向 SDK 推送外部视频数据。

<a id="api_imediaengine_setexternalvideosource__timing"></a>

### 调用时机 [#调用时机-1]

该方法需要在加入频道前调用。

<a id="api_imediaengine_setexternalvideosource__restriction"></a>

### 调用限制 [#调用限制-1]

不支持在频道内动态切换视频源。如果已调用该方法启用外部视频源并加入频道，若想切换为内部视频源，必须先退出频道，然后调用该方法关闭外部视频源，再重新加入频道。

<a id="api_imediaengine_setexternalvideosource__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="enabled"></a>
<Parameter name="enabled">

是否启用外部视频源：

- `true`: 启用外部视频源。SDK 准备接收外部视频帧。
- `false`:（默认）不启用外部视频源。

</Parameter>
<a id="usetexture"></a>
<Parameter name="useTexture">

是否使用 Texture 格式的外部视频帧：

- `true`: 使用 Texture 格式的外部视频帧。
- `false`: 不使用 Texture 格式的外部视频帧。

</Parameter>
<a id="sourcetype"></a>
<Parameter name="sourceType">

外部视频帧是否编码，详见 [EXTERNAL_VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-externalvideosourcetype)。

</Parameter>
<a id="encodedvideooption"></a>
<Parameter name="encodedVideoOption">

视频编码选项。如果 sourceType 为 ENCODED_VIDEO_FRAME，则需要设置该参数。你可以[联系技术支持](https://ticket.shengwang.cn/)了解如何设置该参数。

</Parameter>
</ParameterList>

<a id="api_imediaengine_setexternalvideosource__return_values"></a>

### 返回值 [#返回值-4]

- 0：方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-4]

- [IMediaEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaengine)