# 媒体流附属信息分发 (/zh-CN/api-reference/rtc/unreal-cpp/metadata/metadata-observer)

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

<a id="toc_metadata_observer"></a>

<a id="callback_imetadataobserver_getmaxmetadatasize"></a>

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

## getMaxMetadataSize [#getmaxmetadatasize]

请求最大的 metadata 大小。

<a id="callback_imetadataobserver_getmaxmetadatasize__prototype"></a>

```cpp
virtual int getMaxMetadataSize() { return DEFAULT_METADATA_SIZE_IN_BYTE; }
```

<a id="callback_imetadataobserver_getmaxmetadatasize__detailed_desc"></a>

### 详情 [#详情]

在成功调用 [registerMediaMetadataObserver](/zh-CN/api-reference/rtc/unreal-cpp/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) 完成注册后，SDK 会在发送每一个视频帧时触发一次该回调；你需要在该方法的返回值中指定 metadata 的最大数据大小。

<a id="callback_imetadataobserver_getmaxmetadatasize__return_values"></a>

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

指定 metadata 中 buffer 的最大数据大小，单位为 Byte，最大值不超过 1024。请确保在该返回值中进行传参。

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

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

<a id="api_irtcengine_registermediametadataobserver"></a>

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

## registerMediaMetadataObserver [#registermediametadataobserver]

注册媒体 metadata 观测器用于接收或发送 metadata。

<a id="api_irtcengine_registermediametadataobserver__prototype"></a>

```cpp
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0;
```

<a id="api_irtcengine_registermediametadataobserver__detailed_desc"></a>

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

你需要自行实现 [IMetadataObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imetadataobserver) 类并在本方法中指定 metadata 类型。本方法允许你为视频流添加同步的 metadata，用于多样化的直播互动，如发送购物链接、电子优惠券和在线测试。

调用该方法成功后，SDK 会触发 [getMaxMetadataSize](/zh-CN/api-reference/rtc/unreal-cpp/metadata/metadata-observer#callback_imetadataobserver_getmaxmetadatasize) 回调。

:::caution
注意： 请在 joinChannel [2/2] 前调用该方法。
:::

<a id="api_irtcengine_registermediametadataobserver__parameters"></a>

### 参数 [#参数]

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

metadata 观测器。详见 [IMetadataObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imetadataobserver)。

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

metadata 类型。目前仅支持 VIDEO_METADATA。详见 [METADATA_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-metadatatype)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_registermediametadataobserver__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_irtcengine_unregistermediametadataobserver"></a>

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

## unregisterMediaMetadataObserver [#unregistermediametadataobserver]

取消注册媒体 metadata 观测器。

<a id="api_irtcengine_unregistermediametadataobserver__prototype"></a>

```cpp
virtual int unregisterMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0;
```

<a id="api_irtcengine_unregistermediametadataobserver__parameters"></a>

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

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

metadata 观测器，详见 [IMetadataObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imetadataobserver)。

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

metadata 类型。目前仅支持 VIDEO_METADATA。详见 [METADATA_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-metadatatype)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_unregistermediametadataobserver__return_values"></a>

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

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

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

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

<a id="callback_imetadataobserver_onmetadatareceived"></a>

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

## onMetadataReceived [#onmetadatareceived]

接收端已收到 metadata。

<a id="callback_imetadataobserver_onmetadatareceived__prototype"></a>

```cpp
virtual void onMetadataReceived(const Metadata &metadata) = 0;
```

<a id="callback_imetadataobserver_onmetadatareceived__parameters"></a>

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

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

接收到的 metadata，详见 [Metadata](/zh-CN/api-reference/rtc/unreal-cpp/class-metadata)。

</Parameter>
</ParameterList>

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

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

<a id="callback_imetadataobserver_onreadytosendmetadata"></a>

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

## onReadyToSendMetadata [#onreadytosendmetadata]

发送端已准备好发送 metadata。

<a id="callback_imetadataobserver_onreadytosendmetadata__prototype"></a>

```cpp
virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0;
```

<a id="callback_imetadataobserver_onreadytosendmetadata__detailed_desc"></a>

### 详情 [#详情-2]

当 SDK 准备好发送 metadata 时，会触发该回调。

:::caution
注意： 请确保在该方法中传入的 metadata 大小不超过 [getMaxMetadataSize](/zh-CN/api-reference/rtc/unreal-cpp/metadata/metadata-observer#callback_imetadataobserver_getmaxmetadatasize) 中设定的值。如果超过该值，SDK 会截除超出部分。
:::

<a id="callback_imetadataobserver_onreadytosendmetadata__parameters"></a>

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

<ParameterList>
<a id="source_type"></a>
<Parameter name="source_Type">

视频数据类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。

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

用户想要发送的 metadata。详见 [Metadata](/zh-CN/api-reference/rtc/unreal-cpp/class-metadata)。

</Parameter>
</ParameterList>

<a id="callback_imetadataobserver_onreadytosendmetadata__return_values"></a>

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

- `true`: 发送
- `false`: 不发送

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

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