文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

#include <IAgoraRtcEngine.h>

类

struct  Metadata
 

Public 类型

enum  METADATA_TYPE { UNKNOWN_METADATA = -1 , VIDEO_METADATA = 0 }
 

Public 成员函数

virtual ~IMetadataObserver ()
 
virtual int getMaxMetadataSize ()=0
 
virtual bool onReadyToSendMetadata (Metadata &metadata)=0
 
virtual void onMetadataReceived (const Metadata &metadata)=0
 

详细描述

IMetadataObserver 类的定义。

成员枚举类型说明

◆ METADATA_TYPE

enum agora::rtc::IMetadataObserver::METADATA_TYPE

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

枚举值
UNKNOWN_METADATA 

Metadata 类型未知

VIDEO_METADATA 

Metadata 类型为视频

构造及析构函数说明

◆ ~IMetadataObserver()

virtual agora::rtc::IMetadataObserver::~IMetadataObserver ( )
inlinevirtual

成员函数说明

◆ getMaxMetadataSize()

virtual int agora::rtc::IMetadataObserver::getMaxMetadataSize ( )
pure virtual

请求最大的 Metadata 大小。

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

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

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

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

◆ onReadyToSendMetadata()

virtual bool agora::rtc::IMetadataObserver::onReadyToSendMetadata ( Metadata &  metadata)
pure virtual

发送端已准备好发送 Metadata

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

注解
请确保在该方法中传入的 Metadata 大小不超过 getMaxMetadataSize 中设定的值。
参数
metadata用户想要发送的 Metadata 。
返回
  • true: 发送
  • false: 不发送

◆ onMetadataReceived()

virtual void agora::rtc::IMetadataObserver::onMetadataReceived ( const Metadata &  metadata)
pure virtual

接收端已收到 Metadata。

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

参数
metadata接收到的 Metadata 。