Video SDK for React Native
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaEngine
  The IMediaEngine class.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserverBase
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IMediaPlayerVideoFrameObserver
  The video frame observer for the media player.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- RtcSurfaceView
  The RtcSurfaceView class.
- RtcTextureView
  The RtcTextureView class.
- Class and Enum
  This page lists all the definitions of Class and the enums for React Native.

RtcSurfaceView

The RtcSurfaceView class.

This class is used for rendering.

Android: This class corresponds to the native SurfaceView.
iOS: This class corresponds to the native UIView.

To ensure the rendering of the image, before calling this component, you should proceed based on whether you are joining a channel:

Not joining a channel: First call startPreview, and then call enableVideo.
Joining a channel: First ensure capture is enabled, and then call enableVideo.

RtcRendererViewProps

A common property for RtcSurfaceView and RtcTextureView.

export interface RtcRendererViewProps {
  canvas: VideoCanvas;
  connection?: RtcConnection;
}

Attributes

canvas: The local video view and settings. See VideoCanvas.
connection: The connection infomation. See RtcConnection.

RtcSurfaceViewProps

Properties of the RtcSurfaceView.

export interface RtcSurfaceViewProps {
  zOrderOnTop?: boolean;
  zOrderMediaOverlay?: boolean;
}

Attributes

zOrderOnTop

Controls whether to place the surface of the RtcSurfaceView on top of the window:

true: Place it on top of the window.
false: Do not place it on top of another RtcSurfaceView in the window.

zOrderMediaOverlay

Controls whether to place the surface of the RtcSurfaceView on top of another RtcSurfaceView in the window (but still behind the window):

true: Place it on top of another RtcSurfaceView in the window.
false: Do not place it on top of another RtcSurfaceView in the window.