IMatadataObserver

最近更新时间:2022-09-20 05:17:40

structMetadata
Public 类型
enumMETADATA_TYPE { UNKNOWN_METADATA = -1, VIDEO_METADATA = 0 }
Public 成员函数
virtual~IMetadataObserver ()
virtual intgetMaxMetadataSize ()=0
virtual boolonReadyToSendMetadata (Metadata &metadata)=0
virtual voidonMetadataReceived (const Metadata &metadata)=0

详细描述

IMetadataObserver 类的定义。

成员枚举类型说明

METADATA_TYPE

enum METADATA_TYPE

观测器的 Metadata 类型。当前仅支持视频类型的 Metadata 。

枚举值

枚举值描述
UNKNOWN_METADATAMetadata 类型未知
VIDEO_METADATAMetadata 类型为视频

构造及析构函数说明

~IMetadataObserver

virtual ~IMetadataObserver()

构造及析构函数说明

getMaxMetadataSize

virtual int getMaxMetadataSize()

请求最大的 Metadata 大小。

Metadata 结构体由如下字段组成:

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

请求最大的 Metadata 大小。在成功调用 registerMediaMetadataObserver 完成注册后,SDK 会触发该回调;你需要在该方法的返回值中指定 Metadata 的最大数据大小。

返回值

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

onReadyToSendMetadata

virtual bool onReadyToSendMetadata(Metadata &metadata)

发送端已准备好发送 Metadata

当 SDK 准备好接收和发送 Metadata 时,会触发该回调方法。

参数

参数描述
metadata用户想要发送的 Metadata

返回值

  • true: 发送
  • false: 不发送

注意事项:

onMetadataReceived

virtual void onMetadataReceived(const Metadata &metadata)

接收端已收到 Metadata

当接收到远端用户发送的 Metadata 时,SDK 会触发该回调。

参数

参数描述
metadata接收到的 Metadata