数据流 Datastream

metadataMaxSize

请求最大的 metadata 大小。

Objective-C

- (NSInteger)metadataMaxSize;

在成功调用 setMediaMetadataDelegate 完成注册后，SDK 会在发送每一个视频帧时触发一次该回调；你需要在该方法的返回值中指定 metadata 的最大数据大小。

返回值

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

所属接口类

• AgoraMediaMetadataDataSource

setMediaMetadataDelegate

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

Objective-C

- (BOOL)setMediaMetadataDelegate:(id<AgoraMediaMetadataDelegate> _Nullable)metadataDelegate withType:(AgoraMetadataType)type;

你需要自行实现 AgoraMediaMetadataDelegate 类并在本方法中指定 metadata 类型。本方法允许你为视频流添加同步的 metadata，用于多样化的直播互动，如发送购物链接、电子优惠券和在线测试。

调用该方法成功后，SDK 会触发 metadataMaxSize 回调。

注意： 请在 joinChannelByToken [2/4] 前调用该方法。

参数

参数名	描述
observer	metadata 观测器。详见 AgoraMediaMetadataDelegate。
type	metadata 类型。目前仅支持 AgoraMetadataTypeVideo。详见 AgoraMetadataType。

返回值

• 0：方法调用成功。

• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setMediaMetadataDataSource

设置 metadata 的 Data source。

Objective-C

- (BOOL)setMediaMetadataDataSource:(id<AgoraMediaMetadataDataSource> _Nullable)metadataDataSource withType:(AgoraMetadataType)type;

你需要在该方法中实现一个 AgoraMediaMetadataDataSource 协议，并指定 metadata 的数据类型。成功调用该方法后，SDK 会触发 metadataMaxSize 回调。

该接口可以与 setMediaMetadataDelegate 接口搭配使用，在直播场景中实现发送商品链接、分发优惠券、发送答题等功能，构建更为丰富的直播互动方式。

注意： 请在加入频道前调用该方法。

参数

参数名	描述
metadataDataSource	AgoraMediaMetadataDataSource 协议。
type	metadata 类型。目前仅支持 AgoraMetadataTypeVideo。详见 AgoraMetadataType。

返回值

• YES：方法调用成功。

• NO：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

receiveMetadata

接收端已收到 metadata。

Objective-C

- (void)receiveMetadata:(NSData * _Nonnull)data
                fromUser:(NSInteger)uid atTimestamp:(NSTimeInterval)timestamp;

参数

参数名	描述
data	接收到的数据。
uid	用户 ID。
timestamp	时间戳。

所属接口类

• AgoraMediaMetadataDataSource

readyToSendMetadataAtTimestamp

发送端已准备好发送 metadata。

Objective-C

- (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp
                    sourceType:(AgoraVideoSourceType)sourceType;

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

注意： 请确保在该方法中传入的 metadata 大小不超过 metadataMaxSize 中设定的值。

参数

参数名	描述
timestamp	时间戳。
sourceType	视频数据类型。详见 AgoraVideoSourceType。

返回值

指定想要发送的 metadata ，格式为 NSData，由如下字段组成：

• uid：发送该 metadata 的远端用户的 ID。

• size：metadata 的大小。

• buffer：metadata 数据。

• timeStampMs：metadata 发送时的 NTP 时间戳（ms）。

所属接口类

• AgoraMediaMetadataDataSource