IMetadataObserver

public interface IMetadataObserver

The definition of IMetadataObserver.

Field Summary

Fields

Modifier and Type

Field

Description

static final int

UNKNOWN_METADATA

(Not supported) The metadata type is unknown.

static final int

VIDEO_METADATA

The metadata type is video.
Method Summary

Modifier and Type

Method

Description

int

getMaxMetadataSize()

void

onMetadataReceived(AgoraMetadata metadata)

byte[]

onReadyToSendMetadata(long timeStampMs, int sourceType)

Field Details
- 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 Details
- getMaxMetadataSize
  
  int getMaxMetadataSize()
  
  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)
  
  Parameters:
  
  timeStampMs - The timestamp.
  
  sourceType - Video data type. See `VideoSourceType`.
  
  Returns:
  
  The metadata that you want to send in the format of byte. Ensure that you set the return value.
- onMetadataReceived
  
  void onMetadataReceived(AgoraMetadata metadata)
  
  Parameters:
  
  metadata - The metadata received. See `AgoraMetadata`.