# 媒体流附属信息分发 (/zh-CN/api-reference/rtc/unity/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_irtcengine_registermediametadataobserver"></a>

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

## RegisterMediaMetadataObserver [#registermediametadataobserver]

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

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

```csharp
public abstract int RegisterMediaMetadataObserver(IMetadataObserver observer, METADATA_TYPE type);
```

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

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

:::note
注： 请在 [JoinChannel [2/2]](/zh-CN/api-reference/rtc/unity/channel#api_irtcengine_joinchannel2) 前调用该方法。
:::

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

### 参数 [#参数]

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

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

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_registermediametadataobserver__return_values"></a>

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

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

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

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

<a id="api_irtcengine_sendmetadata"></a>

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

## SendMetadata [#sendmetadata]

发送媒体附属信息。

<a id="api_irtcengine_sendmetadata__prototype"></a>

```csharp
public abstract int SendMetadata(Metadata metadata, VIDEO_SOURCE_TYPE source_type);
```

<a id="api_irtcengine_sendmetadata__detailed_desc"></a>

如果成功发送了媒体附属信息，接收端会收到 [OnMetadataReceived](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#callback_imetadataobserver_onmetadatareceived) 回调。

:::note
请确保 metadata 大小不超过 [SetMaxMetadataSize](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#api_irtcengine_setmaxmetadatasize) 中设置的最大值。如果超过该值，SDK 会截除超出部分。
:::

<a id="api_irtcengine_sendmetadata__parameters"></a>

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

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

媒体附属信息。详见 [Metadata](/zh-CN/api-reference/rtc/unity/class-metadata)。

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

视频源的类型，详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unity/enum-videosourcetype)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_sendmetadata__return_values"></a>

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

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

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

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

<a id="api_irtcengine_setmaxmetadatasize"></a>

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

## SetMaxMetadataSize [#setmaxmetadatasize]

设置媒体附属信息的最大大小。

<a id="api_irtcengine_setmaxmetadatasize__prototype"></a>

```csharp
public abstract int SetMaxMetadataSize(int size);
```

<a id="api_irtcengine_setmaxmetadatasize__detailed_desc"></a>

调用 [RegisterMediaMetadataObserver](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) 后，你可以调用本方法来设置媒体附属信息的最大大小。

<a id="api_irtcengine_setmaxmetadatasize__parameters"></a>

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

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

媒体附属信息的最大大小。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setmaxmetadatasize__return_values"></a>

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

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

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

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

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

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

## UnregisterMediaMetadataObserver [#unregistermediametadataobserver]

取消注册媒体 metadata 观测器。

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

```csharp
public abstract int UnregisterMediaMetadataObserver();
```

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

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

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

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

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

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

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

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

## OnMetadataReceived [#onmetadatareceived]

接收端已收到 metadata。

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

```csharp
public virtual void OnMetadataReceived(Metadata metadata)
        {

        }
```

<a id="callback_imetadataobserver_onmetadatareceived__detailed_desc"></a>

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

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnReadyToSendMetadata [#onreadytosendmetadata]

发送端已准备好发送 metadata。

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

```csharp
public virtual bool OnReadyToSendMetadata(ref Metadata metadata, VIDEO_SOURCE_TYPE source_type)
        {
            return false;
        }
```

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

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

:::note
请确保在该方法中传入的 metadata 大小不超过 [SetMaxMetadataSize](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#api_irtcengine_setmaxmetadatasize) 中设定的值。如果超过该值，SDK 会截除超出部分。
:::

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

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

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

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

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

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

</Parameter>
</ParameterList>

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

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

- true: 发送
- false: 不发送

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

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