Home
Video SDK for Unity
VideoSurface
This class contains Unity native methods related to video rendering.

Video SDK for Unity
- 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.
- IMediaPlayerAudioFrameObserver
  The audio frame observer for the media player.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserver
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IMetadataObserver
  The metadata observer.
- IVideoDeviceManager
  Video device management methods.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- VideoSurface
  This class contains Unity native methods related to video rendering.
- VideoSurfaceYUV
  Porivdes APIs for rendering videos. This class inherits all APIs from the VideoSurface class, but enables you to render video images with high resolutions (such as 4K) faster and at higher frame rates. As of v4.2.0, Agora Unity SDK does not support rendering different video sources with both VideoSurface and VideoSurfaceYUV at the same time. Specifically, after successfully creating IRtcEngine, if the first view is rendered with VideoSurfaceYUV, then only VideoSurfaceYUV can be used for rendering throughout the entire lifecycle of IRtcEngine.
- Class and Enum
  This page lists all the definitions of Class and the enums for Unity.

VideoSurface

This class contains Unity native methods related to video rendering.

SetEnable

Sets whether to enable the video rendering.

public void SetEnable(bool enable)
        {
            Enable = enable;
        }

Parameters

enable

Whether to enable the video rendering:

true: (Default) Enable the video rendering.
false: Disable the video rendering.

SetForUser

Sets the local or remote video display.

public void SetForUser(uint uid = 0, string channelId = "",
            VIDEO_SOURCE_TYPE source_type = VIDEO_SOURCE_TYPE.VIDEO_SOURCE_CAMERA_PRIMARY)
        {
            Uid = uid;
            ChannelId = channelId;
            SourceType = source_type;
        }

Details

Attention:

Ensure that you call this method in the main thread.
Ensure that you call this method before binding VideoSurface.cs.

Parameters

uid: The ID of remote users, obtained through OnUserJoined. The default value is 0, which means you can see the local video.
channelId: The ID of the channel.
source_type: The type of the video source. See VIDEO_SOURCE_TYPE.

OnTextureSizeModify

This callback is triggered when the width and height of Texture are changed.

public event OnTextureSizeModifyHandler OnTextureSizeModify;

When the width and height of Texture are changed, the SDK triggers this callback.