API Reference

This method is deprecated. As of v3.0.1, the Unity SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.

Member agora_gaming_rtc.IRtcEngine.getEngine (string appId)

Use GetEngine instead.

Member agora_gaming_rtc.IRtcEngine.SetEncryptionMode (string encryptionMode)

Deprecated as of v3.2.1. Use the EnableEncryption instead.

Member agora_gaming_rtc.IRtcEngine.SetEncryptionSecret (string secret)

Deprecated as of v3.2.1. Use the EnableEncryption instead.

Member agora_gaming_rtc.IRtcEngine.SetLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)

Deprecated from v3.2.1. Use SetAudioEffectPreset or SetVoiceBeautifierPreset instead.

Member agora_gaming_rtc.IRtcEngine.SetLocalVoiceReverbPreset (AUDIO_REVERB_PRESET audioReverbPreset)

Deprecated from v3.2.1. Use SetAudioEffectPreset or SetVoiceBeautifierPreset instead.

Member agora_gaming_rtc.IRtcEngine.SetSpeakerphoneVolume (int volume)

This method is deprecated as of v2.3.0. Use AdjustRecordingSignalVolume and AdjustPlaybackSignalVolume instead.

Member agora_gaming_rtc.IRtcEngine.SetVideoProfile (VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight=false)

This method is deprecated as of v2.3. Use the SetVideoEncoderConfiguration method instead.

Member agora_gaming_rtc.IRtcEngine.SetVideoQualityParameters (bool preferFrameRateOverImageQuality)

This method is deprecated as of v2.4.0.

Member agora_gaming_rtc.IRtcEngine.StartAudioRecording (string filePath, AUDIO_RECORDING_QUALITY_TYPE quality)

Use StartAudioRecording2 instead.

Member agora_gaming_rtc.IRtcEngine.StartEchoTest ()

This method is deprecated as of v2.4.0.

Member agora_gaming_rtc.LiveTranscoding.lowLatency

Latency mode:

true: Low latency with unassured quality.
false: (Default) High latency with assured quality.

Member agora_gaming_rtc.LiveTranscoding.metadata

The metadata sent to the CDN live client defined by the RTMP or FLV metadata.

Member agora_gaming_rtc.MEDIA_SOURCE_TYPE

Type of audio device.

Member agora_gaming_rtc.OnAudioMixingFinishedHandler ()

use OnAudioMixingStateChangedHandler instead.

Member agora_gaming_rtc.OnAudioQualityHandler (uint userId, int quality, ushort delay, ushort lost)

Deprecated as of v2.3.2. Use the OnRemoteAudioStatsHandler callback instead.

Member agora_gaming_rtc.OnCameraReadyHandler ()

Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in the OnLocalVideoStateChangedHandler callback instead.

Member agora_gaming_rtc.OnConnectionBannedHandler ()

from v2.3.2. Replaced by the OnConnectionStateChangedHandler callback.

Member agora_gaming_rtc.OnConnectionInterruptedHandler ()

Deprecated as of v2.3.2. Replaced by the OnConnectionStateChangedHandler callback.

Member agora_gaming_rtc.OnFirstLocalAudioFrameHandler (int elapsed)

Deprecated as of v3.2.1. Use the OnFirstLocalAudioFramePublishedHandler callback instead.

Member agora_gaming_rtc.OnFirstRemoteAudioDecodedHandler (uint uid, int elapsed)

v3.0.1 This callback is deprecated. Use OnRemoteAudioStateChangedHandler instead.

Member agora_gaming_rtc.OnFirstRemoteAudioFrameHandler (uint userId, int elapsed)

v3.0.1 This callback is deprecated. Use OnRemoteAudioStateChangedHandler instead.

Member agora_gaming_rtc.OnFirstRemoteVideoDecodedHandler (uint uid, int width, int height, int elapsed)

Use the OnRemoteVideoStateChangedHandler callback with the following parameters instead:

Member agora_gaming_rtc.OnMicrophoneEnabledHandler (bool isEnabled)

Use LOCAL_AUDIO_STREAM_STATE_STOPPED(0) or LOCAL_AUDIO_STREAM_STATE_RECORDING(1) in the OnLocalAudioStateChangedHandler callback instead.

Member agora_gaming_rtc.OnRemoteAudioTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)

This callback is deprecated and replaced by the OnRemoteAudioStatsHandler callback.

Member agora_gaming_rtc.OnRemoteVideoTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)

This callback is deprecated and replaced by the OnRemoteVideoStatsHandler callback.

Member agora_gaming_rtc.OnStreamPublishedHandler (string url, int error)

v3.0.1 This method is deprecated. Use OnRtmpStreamingStateChangedHandler instead.

Member agora_gaming_rtc.OnStreamUnpublishedHandler (string url)

v3.0.1 This method is deprecated. Use OnRtmpStreamingStateChangedHandler instead.

Member agora_gaming_rtc.OnUserEnableLocalVideoHandler (uint uid, bool enabled)

This callback is deprecated and replaced by the OnRemoteVideoStateChangedHandler callback with the following parameters:

Member agora_gaming_rtc.OnUserEnableVideoHandler (uint uid, bool enabled)

This callback is deprecated and replaced by the OnRemoteVideoStateChangedHandler callback with the following parameters:

Member agora_gaming_rtc.OnUserMutedAudioHandler (uint uid, bool muted)

This method is deprecated from v3.0.1, use the OnRemoteAudioStateChangedHandler callback instead.

Member agora_gaming_rtc.OnVideoStoppedHandler ()

Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the OnLocalVideoStateChangedHandler callback instead.

Member agora_gaming_rtc.RemoteVideoStats.delay

Time delay (ms).

Member agora_gaming_rtc.RENDER_MODE_ADAPTIVE

3: This mode is deprecated.

Member agora_gaming_rtc.VIDEO_PROFILE_TYPE

Video profiles.

Member agora_gaming_rtc.VOICE_CHANGER_PRESET

Deprecated as of v3.2.1. Use VOICE_BEAUTIFIER_PRESET instead.