◆ METADATA_TYPE
The metadata type.
- Note
- We only support video metadata for now.
Enumerator |
---|
UNKNOWN_METADATA | -1: (Not supported) Unknown.
|
VIDEO_METADATA | 0: (Supported) Video metadata.
|
◆ MAX_METADATA_SIZE_TYPE
The maximum metadata size.
Enumerator |
---|
INVALID_METADATA_SIZE_IN_BYTE | |
DEFAULT_METADATA_SIZE_IN_BYTE | |
MAX_METADATA_SIZE_IN_BYTE | |
◆ ~IMetadataObserver()
virtual agora::rtc::IMetadataObserver::~IMetadataObserver |
( |
| ) |
|
|
inlinevirtual |
◆ getMaxMetadataSize()
virtual int agora::rtc::IMetadataObserver::getMaxMetadataSize |
( |
| ) |
|
|
inlinevirtual |
Gets the maximum size of the metadata.
After calling the registerMediaMetadataObserver method, the SDK triggers this callback to query the maximum size of your metadata. You must specify the maximum size in the return value and then pass it to the SDK.
- Returns
- The maximum size of your metadata. See MAX_METADATA_SIZE_TYPE.
◆ onReadyToSendMetadata()
Occurs when the SDK is ready to receive and send metadata.
- Note
- Ensure that the size of the metadata does not exceed the value set in the getMaxMetadataSize callback.
- Parameters
-
- Returns
- true: Send.
- false: Do not send.
◆ onMetadataReceived()
virtual void agora::rtc::IMetadataObserver::onMetadataReceived |
( |
const Metadata & |
metadata | ) |
|
|
pure virtual |
Occurs when received the metadata.
- Parameters
-
metadata | The metadata received. See metadata. |
- Note
- If the receiver is audience, the receiver cannot get the NTP timestamp (ms) that the metadata sends.