# 媒体流附属信息分发 (/zh-CN/api-reference/rtc/unity/metadata/metadata-observer)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## RegisterMediaMetadataObserver [#registermediametadataobserver]
注册媒体 metadata 观测器用于接收或发送 metadata。
```csharp
public abstract int RegisterMediaMetadataObserver(IMetadataObserver observer, METADATA_TYPE type);
```
你需要自行实现 [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) 前调用该方法。
:::
### 参数 [#参数]
metadata 观测器。详见 [IMetadataObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imetadataobserver)。
metadata 类型。目前仅支持 `VIDEO_METADATA`。详见 [METADATA_TYPE](/zh-CN/api-reference/rtc/unity/enum-metadatatype)。
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SendMetadata [#sendmetadata]
发送媒体附属信息。
```csharp
public abstract int SendMetadata(Metadata metadata, VIDEO_SOURCE_TYPE source_type);
```
如果成功发送了媒体附属信息,接收端会收到 [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 会截除超出部分。
:::
### 参数 [#参数-1]
媒体附属信息。详见 [Metadata](/zh-CN/api-reference/rtc/unity/class-metadata)。
视频源的类型,详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unity/enum-videosourcetype)。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetMaxMetadataSize [#setmaxmetadatasize]
设置媒体附属信息的最大大小。
```csharp
public abstract int SetMaxMetadataSize(int size);
```
调用 [RegisterMediaMetadataObserver](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) 后,你可以调用本方法来设置媒体附属信息的最大大小。
### 参数 [#参数-2]
媒体附属信息的最大大小。
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## UnregisterMediaMetadataObserver [#unregistermediametadataobserver]
取消注册媒体 metadata 观测器。
```csharp
public abstract int UnregisterMediaMetadataObserver();
```
### 返回值 [#返回值-3]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## OnMetadataReceived [#onmetadatareceived]
接收端已收到 metadata。
```csharp
public virtual void OnMetadataReceived(Metadata metadata)
{
}
```
### 参数 [#参数-3]
接收到的 metadata,详见 [Metadata](/zh-CN/api-reference/rtc/unity/class-metadata)。
### 所属接口类 [#所属接口类-4]
- [IMetadataObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imetadataobserver)
## OnReadyToSendMetadata [#onreadytosendmetadata]
发送端已准备好发送 metadata。
```csharp
public virtual bool OnReadyToSendMetadata(ref Metadata metadata, VIDEO_SOURCE_TYPE source_type)
{
return false;
}
```
当 SDK 准备好发送 metadata 时,会触发该回调。
:::note
请确保在该方法中传入的 metadata 大小不超过 [SetMaxMetadataSize](/zh-CN/api-reference/rtc/unity/metadata/metadata-observer#api_irtcengine_setmaxmetadatasize) 中设定的值。如果超过该值,SDK 会截除超出部分。
:::
### 参数 [#参数-4]
视频数据类型。详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unity/enum-videosourcetype)。
用户想要发送的 metadata。详见 [Metadata](/zh-CN/api-reference/rtc/unity/class-metadata)。
### 返回值 [#返回值-4]
- true: 发送
- false: 不发送
### 所属接口类 [#所属接口类-5]
- [IMetadataObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imetadataobserver)