Video SDK for Unity
- API Overview
  Agora provides a flexible combination of APIs deployed globally to deliver reliable real-time audio and video communication.
- IRtcEngine
  The base interface class of the RTC SDK that implements the core functions of real-time audio and video.
- IRtcEngineEx
  Interface class that provides multi-channel methods.
- IRtcEngineEventHandler
  The IRtcEngineEventHandler interface class is used by the SDK to send event notifications to the App. The App receives the SDK's event notifications by inheriting methods of this interface class.
- IMediaPlayer
  Class that provides media player functionality and supports multiple instances.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files in the media player.
- IMediaPlayerSourceObserver
  Provides callbacks for the media player.
- IMediaPlayerCustomDataProvider
  Provides callbacks for opening custom media resource files.
- IAudioEncodedFrameObserver
  Observer for encoded audio.
- IAudioFrameObserver
  Audio frame observer.
- IAudioFrameObserverBase
  Audio observer.
- IVideoEncodedFrameObserver
  A class used to receive encoded video frames.
- IVideoFrameObserver
  Video frame observer.
- IAudioSpectrumObserver
  Audio spectrum observer.
- IMetadataObserver
  Metadata observer.
- IAudioDeviceManager
  Audio device management methods.
- IVideoDeviceManager
  Video device management methods.
- IMediaEngine
  IMediaEngine class.
- IDirectCdnStreamingEventHandler
  The IDirectCdnStreamingEventHandler interface class is used by the SDK to send CDN streaming event notifications to the App. The App receives the SDK's event notifications by inheriting methods of this interface class.
- IBaseSpatialAudioEngine
  This class contains some APIs from the ILocalSpatialAudioEngine class.
- ILocalSpatialAudioEngine
  This class implements spatial audio by calculating user coordinates through the SDK.
- Class and Enum
  This page lists the definitions of all Class and Enum in Unity.

IMetadataObserver

Metadata observer.

OnMetadataReceived

Occurs when metadata is received on the receiving end.

public virtual void OnMetadataReceived(Metadata metadata)
        {

        }

Parameters

metadata: The received metadata. See Metadata.

OnReadyToSendMetadata

Occurs when the sender is ready to send metadata.

public virtual bool OnReadyToSendMetadata(ref Metadata metadata, VIDEO_SOURCE_TYPE source_type)
        {
            return false;
        }

This callback is triggered when the SDK is ready to send metadata.

Parameters

source_Type: The type of video data. See VIDEO_SOURCE_TYPE.
metadata: The metadata the user wants to send. See Metadata.

Return Values

true: Send
false: Do not send