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

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

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

<a id="api_imetadataobserver_getmaxmetadatasize"></a>

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

## getMaxMetadataSize [#getmaxmetadatasize]

当 SDK 请求元数据最大大小时触发的回调。

<a id="api_imetadataobserver_getmaxmetadatasize__prototype"></a>

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

<a id="api_imetadataobserver_getmaxmetadatasize__detailed_desc"></a>

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

<a id="api_imetadataobserver_getmaxmetadatasize__return_values"></a>

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

方法调用成功，返回你希望使用的元数据 `buffer` 的最大大小，单位为字节。最大值为 1024 字节。

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

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

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

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

## registerMediaMetadataObserver [#registermediametadataobserver]

注册元数据观察器。

<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>

你需要实现 [IMetadataObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imetadataobserver) 类，并在该方法中指定元数据类型。该方法支持在视频流中添加同步元数据，用于实现更丰富的互动直播场景，例如发送购物链接、数字优惠券和在线问答。成功调用该方法后，SDK 会触发 [getMaxMetadataSize](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/metadata-observer#api_imetadataobserver_getmaxmetadatasize) 回调。

:::note
注： 请在调用 `joinChannel` 之前调用此方法。
:::

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

### 参数 [#参数]

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

元数据观察器。详见 [IMetadataObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imetadataobserver)。

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

元数据类型。详见 [METADATA_TYPE](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-metadatatype)。SDK 当前仅支持 `VIDEO_METADATA`。

</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/cpp-all-platforms/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_unregistermediametadataobserver"></a>

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

## unregisterMediaMetadataObserver [#unregistermediametadataobserver]

取消注册指定的元数据观察器。

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

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

<a id="api_irtcengine_unregistermediametadataobserver__detailed_desc"></a>

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

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

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

元数据观察器。详见 [IMetadataObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imetadataobserver)。

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

元数据类型。SDK 当前仅支持 `VIDEO_METADATA`。

</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/cpp-all-platforms/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__detailed_desc"></a>

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

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

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

接收到的元数据。详见 [Metadata](/zh-CN/api-reference/rtc/cpp-all-platforms/class-metadata)。

</Parameter>
</ParameterList>

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

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

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

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

## onReadyToSendMetadata [#onreadytosendmetadata]

当 SDK 准备好发送元数据时触发的回调。

<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>

:::note
注： 请确保元数据的大小不超过 [getMaxMetadataSize](/zh-CN/api-reference/rtc/cpp-all-platforms/metadata/metadata-observer#api_imetadataobserver_getmaxmetadatasize) 回调中设置的值。如果超过该值，SDK 会截除超出部分。
:::

<a id="callback_imetadataobserver_onreadytosendmetadata__timing"></a>

### 触发时机 [#触发时机]

当 SDK 准备好发送元数据时触发。

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

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

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

用户希望发送的元数据。详见 [Metadata](/zh-CN/api-reference/rtc/cpp-all-platforms/class-metadata)。

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

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

</Parameter>
</ParameterList>

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

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

- true：发送该视频帧。
- false：不发送该视频帧。

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

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