io.agora.rtc2

Interface IMetadataObserver

public interface IMetadataObserver

The definition of IMetadataObserver.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_METADATA (Not supported) The metadata type is unknown.
static int	VIDEO_METADATA The metadata type is video.

Method Summary

Modifier and Type	Method and Description
int	getMaxMetadataSize() Occurs when the SDK requests the maximum size of the metadata.
void	onMetadataReceived(byte[] buffer, int uid, long timeStampMs) Occurs when the local user receives the metadata.
byte[]	onReadyToSendMetadata(long timeStampMs, int sourceType) Occurs when the SDK is ready to receive and send metadata.

Field Detail

UNKNOWN_METADATA

static final int UNKNOWN_METADATA

(Not supported) The metadata type is unknown.

See Also:

Constant Field Values

VIDEO_METADATA

static final int VIDEO_METADATA

The metadata type is video.

See Also:

Constant Field Values

Method Detail

getMaxMetadataSize

int getMaxMetadataSize()

Occurs when the SDK requests the maximum size of the metadata. The Metadata struct contains the following parameters: - `uid`: ID of the user who sends the metadata.

Returns:

The maximum size of the buffer of the metadata that you want to use. The highest value is 1024 bytes. Ensure that you set the return value.

onReadyToSendMetadata

byte[] onReadyToSendMetadata(long timeStampMs,
                             int sourceType)

Occurs when the SDK is ready to receive and send metadata. You need to specify the metadata in the return value of this callback.

Parameters:

timeStampMs - The NTP timestamp (ms) that the metadata sends.

sourceType - VideoSourceType

Returns:

The metadata that you want to send in the format of byte[]. Ensure that you set the return value.

onMetadataReceived

void onMetadataReceived(byte[] buffer,
                        int uid,
                        long timeStampMs)

Occurs when the local user receives the metadata.

Parameters:

buffer - The metadata buffer.

uid - The ID of the user who sent the metadata. When sending the metadata, ignore this parameter. When receiving the metadata, use this parameter to determine who sends the metadata.

timeStampMs - The NTP timestamp (ms) that the metadata sends. If the metadata receiver is audience, this parameter does not work.