AgoraMediaMetadataDataSource 协议

Conforms to NSObject
Declared in AgoraMediaMetadata.h

概览

AgoraMediaMetadataDataSource 定义

Note: 该类包含的所有回调均需要在引擎的关键线程中实现。因此我们建议你在关键线程中避免耗时操作。

– metadataMaxSize required method

请求媒体附属信息的最大数据大小

- (NSInteger)metadataMaxSize

返回

指定附属信息中 buffer (详见 readyToSendMetadataAtTimestamp 中返回值的描述)的大小,单位为 Byte,最大值不超过 1024。请确保在该返回值中进行传参。

详情

在成功调用 setMediaMetadataDataSource 方法设置 Metadata Data Source 后,SDK 会触发该回调,你需要在该方法的返回值中设置想要使用的 Metadata 最大数据大小。

SDK 会在使用过程中多次返回该回调,你可以在新的回调中更新附属信息的最大值。

Declared In

AgoraMediaMetadata.h

– readyToSendMetadataAtTimestamp: required method

发送端已准备好发送媒体附属信息

- (NSData *_Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp

参数

timestamp

当前附属信息的时间戳,单位为毫秒。

返回

指定想要发送的附属信息,格式为 NSData,由如下字段组成:

  • uid:发送该 Metadata 的远端用户的 ID
  • size:发送或收到的 Metadata 的数据大小
  • buffer:发送或收到的 Metadata 数据
  • timeStampMs:该 Metadata 的时间戳

请确保在该返回值中进行传参。

详情

当 SDK 准备好接收和发送附属信息数据时,会触发该回调方法;你需要在该方法的返回值中指定想要发送的附属信息。

Note: 请确保用户在该方法中传入的附属信息大小不超过 metadataMaxSize 中设定的值。

Declared In

AgoraMediaMetadata.h