# 媒体流附属信息分发 (/zh-CN/api-reference/rtc/ios/metadata/metadata-observer)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## metadataMaxSize [#metadatamaxsize]
当 SDK 请求元数据的最大大小时触发。
```objc
- (NSInteger)metadataMaxSize NS_SWIFT_NAME(metadataMaxSize());
```
调用 [setMediaMetadataDelegate\:withType:](/zh-CN/api-reference/rtc/ios/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) 方法成功注册后,SDK 每发送一帧视频时会触发该回调。你需要在该回调的返回值中指定元数据的最大大小。
### 返回值 [#返回值]
方法调用成功,返回你希望使用的元数据缓冲区的最大大小,单位为字节。最大值为 1024 字节。
### 所属接口类 [#所属接口类]
- [AgoraMediaMetadataDataSource](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_agoramediametadatadatasource)
## readyToSendMetadataAtTimestamp\:sourceType: [#readytosendmetadataattimestampsourcetype]
当 SDK 准备好发送元数据时触发回调。
```objc
- (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp sourceType:(AgoraVideoSourceType)sourceType NS_SWIFT_NAME(readyToSendMetadata(atTimestamp:sourceType:));
```
该回调在 SDK 准备好发送元数据时触发。
:::note
注: 请确保元数据的大小不超过 [metadataMaxSize](/zh-CN/api-reference/rtc/ios/metadata/metadata-observer#api_agoramediametadatadatasource_metadatamaxsize) 回调中设置的值。如果超过该值,SDK 会截除超出部分。
:::
### 调用时机 [#调用时机]
当 SDK 准备好发送元数据时触发。
### 参数 [#参数]
时间戳。
视频数据类型,详见 [AgoraVideoSourceType](/zh-CN/api-reference/rtc/ios/enum-videosourcetype)。
### 返回值 [#返回值-1]
你希望发送的元数据,格式为 `NSData`,包含以下参数:
- `uid`:发送元数据的远端用户 ID。
- `size`:元数据的大小。
- `buffer`:元数据内容。
- `timeStampMs`:发送元数据时的 NTP 时间戳(毫秒)。
### 所属接口类 [#所属接口类-1]
- [AgoraMediaMetadataDataSource](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_agoramediametadatadatasource)
## setMediaMetadataDelegate\:withType: [#setmediametadatadelegatewithtype]
注册元数据观察者。
```objc
- (BOOL)setMediaMetadataDelegate:(id _Nullable)metadataDelegate withType:(AgoraMetadataType)type NS_SWIFT_NAME(setMediaMetadataDelegate(_:with:));
```
你需要实现 [AgoraMediaMetadataDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imetadataobserver) 协议,并在该方法中指定元数据类型。该方法使你能够在视频流中添加同步的元数据,以实现更丰富的直播互动场景,例如发送购物链接、数字优惠券和在线问答。
:::note
注: 请在调用 `joinChannelByToken` 之前调用该方法。
:::
### 参数 [#参数-1]
元数据观察者,详见 [AgoraMediaMetadataDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imetadataobserver)。
元数据类型,详见 [AgoraMetadataType](/zh-CN/api-reference/rtc/ios/enum-metadatatype)。当前 SDK 仅支持 `AgoraMetadataTypeVideo`。
### 返回值 [#返回值-2]
- YES:方法调用成功。
- NO:方法调用失败。
### 所属接口类 [#所属接口类-2]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)
## setMediaMetadataDataSource\:withType: [#setmediametadatadatasourcewithtype]
设置元数据的数据源。
```objc
- (BOOL)setMediaMetadataDataSource:(id _Nullable)metadataDataSource withType:(AgoraMetadataType)type NS_SWIFT_NAME(setMediaMetadataDataSource(_:with:));
```
你需要在该方法中实现 [AgoraMediaMetadataDataSource](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_agoramediametadatadatasource) 协议,并指定元数据的数据格式。成功调用该方法后,SDK 会触发 [metadataMaxSize](/zh-CN/api-reference/rtc/ios/metadata/metadata-observer#api_agoramediametadatadatasource_metadatamaxsize) 回调。你可以结合 [setMediaMetadataDelegate\:withType:](/zh-CN/api-reference/rtc/ios/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) 方法,在视频流中添加同步的元数据,实现更丰富的直播互动,例如发送购物链接、数字优惠券和在线问答。
:::note
注: 该方法需要在加入频道前调用。
:::
### 参数 [#参数-2]
元数据的数据源,需实现 [AgoraMediaMetadataDataSource](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_agoramediametadatadatasource) 协议。详见 [AgoraMediaMetadataDataSource](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_agoramediametadatadatasource)。
元数据的类型,详见 [AgoraMetadataType](/zh-CN/api-reference/rtc/ios/enum-metadatatype)。SDK 当前仅支持 `AgoraMetadataTypeVideo`。
### 返回值 [#返回值-3]
- YES:方法调用成功。
- NO:方法调用失败。
### 所属接口类 [#所属接口类-3]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)
## didMetadataReceived: [#didmetadatareceived]
当本地用户接收到元数据时触发。
```objc
- (void)didMetadataReceived:(AgoraMetadata * _Nonnull)metadata NS_SWIFT_NAME(didMetadataReceived(_:));
```
### 触发时机 [#触发时机]
该回调在本地用户接收到元数据时被触发。
### 参数 [#参数-3]
接收到的元数据。详见 [AgoraMetadata](/zh-CN/api-reference/rtc/ios/class-metadata)。
### 所属接口类 [#所属接口类-4]
- [AgoraMediaMetadataDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imetadataobserver)