# 已编码视频数据 (/zh-CN/api-reference/rtc/react-native/video/video-encoded)

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

<a id="toc_video_encoded"></a>

<a id="api_imediaengine_addlistener_imediaengine"></a>

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

## addListener [#addlistener]

添加一个 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent) 监听器。

<a id="api_imediaengine_addlistener_imediaengine__prototype"></a>

```ts
addListener?<EventType extends keyof IMediaEngineEvent>(
      eventType: EventType,
      listener: IMediaEngineEvent[EventType]
    ): void;
```

<a id="api_imediaengine_addlistener_imediaengine__detailed_desc"></a>

成功调用该方法后，你可以通过 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent) 监听对应 [IMediaEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengine) 对象的事件、获取数据。根据业务需要，你可以为同一事件添加多个监听器。

<a id="api_imediaengine_addlistener_imediaengine__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="eventtype"></a>
<Parameter name="eventType">

需要监听的目标事件名。详见 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent)。

</Parameter>
<a id="listener"></a>
<Parameter name="listener">

`eventType` 对应的回调函数。以添加 [onPlaybackAudioFrameBeforeMixing](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserver_onplaybackaudioframebeforemixing) 为例：

```text
const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
```

</Parameter>
</ParameterList>

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

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

<a id="api_imediaengine_registervideoencodedframeobserver"></a>

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

## registerVideoEncodedFrameObserver [#registervideoencodedframeobserver]

为编码后的视频图像注册视频帧接收观测器。

<a id="api_imediaengine_registervideoencodedframeobserver__prototype"></a>

```ts
abstract registerVideoEncodedFrameObserver(
    observer: IVideoEncodedFrameObserver
  ): number;
```

<a id="api_imediaengine_registervideoencodedframeobserver__detailed_desc"></a>

如果你只想要观测编码后的视频帧 (如 H.264 格式)，而不需要对视频进行解码和渲染，声网推荐你通过该方法注册一个 [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ivideoencodedframeobserver) 类。

:::note
注： 该方法需要在加入频道前调用。
:::

<a id="api_imediaengine_registervideoencodedframeobserver__parameters"></a>

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

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

视频帧接收观测器，详见 [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ivideoencodedframeobserver)。

</Parameter>
</ParameterList>

<a id="api_imediaengine_registervideoencodedframeobserver__return_values"></a>

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

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

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

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

<a id="api_imediaengine_removealllisteners_imediaengine"></a>

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

## removeAllListeners [#removealllisteners]

移除指定事件的所有监听器。

<a id="api_imediaengine_removealllisteners_imediaengine__prototype"></a>

```ts
removeAllListeners?<EventType extends keyof IMediaEngineEvent>(
      eventType?: EventType
    ): void;
```

<a id="api_imediaengine_removealllisteners_imediaengine__detailed_desc"></a>

<a id="api_imediaengine_removealllisteners_imediaengine__parameters"></a>

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

<ParameterList>
<a id="eventtype-1"></a>
<Parameter name="eventType">

需要监听的目标事件名。详见 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent)。

</Parameter>
</ParameterList>

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

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

<a id="api_imediaengine_removelistener_imediaengine"></a>

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

## removeListener [#removelistener]

移除指定的 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent) 监听器。

<a id="api_imediaengine_removelistener_imediaengine__prototype"></a>

```ts
removeListener?<EventType extends keyof IMediaEngineEvent>(
      eventType: EventType,
      listener: IMediaEngineEvent[EventType]
    ): void;
```

<a id="api_imediaengine_removelistener_imediaengine__detailed_desc"></a>

<a id="api_imediaengine_removelistener_imediaengine__parameters"></a>

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

<ParameterList>
<a id="eventtype-2"></a>
<Parameter name="eventType">

需要监听的目标事件名。详见 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent)。

</Parameter>
<a id="listener-1"></a>
<Parameter name="listener">

`eventType` 对应的回调函数。必须传入 [addListener](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_addlistener_imediaengine) 中传入的同一个函数对象。以取消监听 [onJoinChannelSuccess](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onjoinchannelsuccess) 为例：

```text
const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
engine.removeListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
```

</Parameter>
</ParameterList>

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

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

<a id="api_imediaengine_unregistervideoencodedframeobserver"></a>

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

## unregisterVideoEncodedFrameObserver [#unregistervideoencodedframeobserver]

为编码后的视频图像取消注册视频帧接收观测器。

<a id="api_imediaengine_unregistervideoencodedframeobserver__prototype"></a>

```ts
abstract unregisterVideoEncodedFrameObserver(
    observer: IVideoEncodedFrameObserver
  ): number;
```

<a id="api_imediaengine_unregistervideoencodedframeobserver__detailed_desc"></a>

<a id="api_imediaengine_unregistervideoencodedframeobserver__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="observer-1"></a>
<Parameter name="observer">

视频帧观测器，观测每帧视频的接收, 详见 [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ivideoencodedframeobserver)。

</Parameter>
</ParameterList>

<a id="api_imediaengine_unregistervideoencodedframeobserver__return_values"></a>

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

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

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

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

<a id="callback_ivideoencodedframeobserver_onencodedvideoframereceived"></a>

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

## onEncodedVideoFrameReceived [#onencodedvideoframereceived]

报告接收端已收到远端发送的待解码视频帧。

<a id="callback_ivideoencodedframeobserver_onencodedvideoframereceived__prototype"></a>

```ts
onEncodedVideoFrameReceived?(
    channelId: string,
    uid: number,
    imageBuffer: Uint8Array,
    length: number,
    videoEncodedFrameInfo: EncodedVideoFrameInfo
  ): void;
```

<a id="callback_ivideoencodedframeobserver_onencodedvideoframereceived__detailed_desc"></a>

调用 [setRemoteVideoSubscriptionOptions](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setremotevideosubscriptionoptions) 方法并将 `encodedFrameOnly` 设置为 true 时，SDK 会在本地触发该回调，上报接收到的编码后视频帧信息。

<a id="callback_ivideoencodedframeobserver_onencodedvideoframereceived__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="channelid"></a>
<Parameter name="channelId">

频道名。

</Parameter>
<a id="uid"></a>
<Parameter name="uid">

远端用户 ID。

</Parameter>
<a id="imagebuffer"></a>
<Parameter name="imageBuffer">

视频图像 buffer。

</Parameter>
<a id="length"></a>
<Parameter name="length">

视频图像的数据长度。

</Parameter>
<a id="videoencodedframeinfo"></a>
<Parameter name="videoEncodedFrameInfo">

编码后的视频帧信息，详见 [EncodedVideoFrameInfo](/zh-CN/api-reference/rtc/react-native/class-encodedvideoframeinfo)。

</Parameter>
</ParameterList>

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

- [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ivideoencodedframeobserver)