agora::rtc::IMetadataObserver类 参考
- C++
更新时间
详细描述
视频 Metadata 观测器。通过 ILocalVideoTrack::registerVideoMetadataObserver 注册。
公开类型
- Metadata:发送或接收的视频 Metadata。
成员枚举类型说明
METADATA_TYPE
Metadata 类型,目前仅支持视频 Metadata。
MAX_METADATA_SIZE_TYPE
Metadata 大小常量,单位为字节。
| 枚举值 | |
|---|---|
| -1:无效大小。 | |
| 512:默认大小。 | |
| 1024:最大大小。 | |
构造及析构函数说明
~IMetadataObserver()
inline
virtual
virtual agora::rtc::IMetadataObserver::~IMetadataObserver()成员函数说明
getMaxMetadataSize()
inline
virtual
virtual int agora::rtc::IMetadataObserver::getMaxMetadataSize()SDK 请求 Metadata 最大缓冲区大小时触发。
返回值
最大大小,单位为字节。默认值为 512,最大为 1024。
onReadyToSendMetadata()
pure
virtual
virtual bool agora::rtc::IMetadataObserver::onReadyToSendMetadata(Metadata & metadata, VIDEO_SOURCE_TYPE source_type)SDK 准备发送 Metadata 时触发。将数据写入 SDK 提供的缓冲区,并设置大小。
注解
Metadata 大小不得超过 getMaxMetadataSize 返回的值。
| 参数名 | 描述 |
|---|---|
metadata | 待发送的 Metadata。 |
source_type | 视频源类型:VIDEO_SOURCE_TYPE。 |
返回值
true:发送 Metadata;false:不发送 Metadata。
onMetadataReceived()
pure
virtual
virtual void agora::rtc::IMetadataObserver::onMetadataReceived(const Metadata & metadata)收到远端用户的视频 Metadata 时触发。
| 参数名 | 描述 |
|---|---|
metadata | 收到的 Metadata。 |