通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
Documentation
All
Console 官网 Community Technical support
English
search-icon

Agora Unity SDK API Reference

Overview IRtcEngine AgoraCallback AgoraChannel AudioEffectManagerImpl AudioPlaybackDeviceManager AudioRecordingDeviceManager VideoDeviceManager MetadataObserver PacketObserver AudioRawDataManager VideoRawDataManager VideoSurface MediaRecorder
Member agora_gaming_rtc.AgoraChannel.AddPublishStreamUrl (string url, bool transcodingEnabled)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.AgoraChannel.CreateDataStream (bool reliable, bool ordered)
This method is deprecated from v3.3.1. Use the CreateDataStream2 method instead.
Member agora_gaming_rtc.AgoraChannel.EnableRemoteSuperResolution (uint userId, bool enable)
This method is deprecated from v3.7.1. Use EnableRemoteSuperResolution [2/2] instead.
Member agora_gaming_rtc.AgoraChannel.RemovePublishStreamUrl (string url)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.AgoraChannel.SetDefaultMuteAllRemoteAudioStreams (bool mute)
This method is deprecated from v3.3.1.
Member agora_gaming_rtc.AgoraChannel.SetDefaultMuteAllRemoteVideoStreams (bool mute)
This method is deprecated from v3.3.1.
Member agora_gaming_rtc.AgoraChannel.SetEncryptionMode (string encryptionMode)
Deprecated as of v3.2.0. Use the EnableEncryption instead.
Member agora_gaming_rtc.AgoraChannel.SetEncryptionSecret (string secret)
Deprecated as of v3.2.0. Use the EnableEncryption instead.
Member agora_gaming_rtc.AgoraChannel.SetLiveTranscoding (LiveTranscoding liveTranscoding)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.AUDIO_MIXING_ERROR_TYPE
Deprecated from v3.4.2, Use AUDIO_MIXING_REASON_TYPE instead.
Member agora_gaming_rtc.AUDIO_REVERB_PRESET
Deprecated as of v3.2.0. Use AUDIO_EFFECT_PRESET instead.
Member agora_gaming_rtc.IRtcEngine.AddPublishStreamUrl (string url, bool transcodingEnabled)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.IRtcEngine.AddVideoWatermark (RtcImage rtcImage)
This method is deprecated from v2.9.1. Use AddVideoWatermark instead.
Member agora_gaming_rtc.IRtcEngine.CreateDataStream (bool reliable, bool ordered)
This method is deprecated from v3.3.1. Use the CreateDataStream2 method instead.
Member agora_gaming_rtc.IRtcEngine.EnableRemoteSuperResolution (uint userId, bool enable)
This method is deprecated from v3.7.1. Use EnableRemoteSuperResolution [2/2] instead.
Member agora_gaming_rtc.IRtcEngine.EnableWebSdkInteroperability (bool enabled)
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.GetAudioMixingDuration (string filePath)
Deprecated from v3.6.1.1. Use GetAudioFileInfo instead.
Member agora_gaming_rtc.IRtcEngine.getEngine (string appId)
Use GetEngine instead.
Member agora_gaming_rtc.IRtcEngine.PushAudioFrame (AudioFrame audioFrame)
This method is deprecated from v3.6.1.1, use the PushAudioFrame method instead.
Member agora_gaming_rtc.IRtcEngine.RemovePublishStreamUrl (string url)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.IRtcEngine.SetDefaultMuteAllRemoteAudioStreams (bool mute)
This method is deprecated from v3.3.1.
Member agora_gaming_rtc.IRtcEngine.SetDefaultMuteAllRemoteVideoStreams (bool mute)
This method is deprecated from v3.3.1.
Member agora_gaming_rtc.IRtcEngine.SetEncryptionMode (string encryptionMode)
Deprecated as of v3.2.0. Use the EnableEncryption instead.
Member agora_gaming_rtc.IRtcEngine.SetEncryptionSecret (string secret)
Deprecated as of v3.2.0. Use the EnableEncryption instead.
Member agora_gaming_rtc.IRtcEngine.SetLiveTranscoding (LiveTranscoding transcoding)
This method is deprecated as of v3.6.1.1. See Release Notes for an alternative solution.
Member agora_gaming_rtc.IRtcEngine.SetLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)
Deprecated from v3.2.0. Use the following methods instead:
  • SetAudioEffectPreset: Audio effects.
  • SetVoiceBeautifierPreset: Voice beautifier effects.
  • SetVoiceConversionPreset: Voice conversion effects. This method can be used to set the local voice effect for users in a communication channel or hosts in the interactive live streaming channel. Voice changer options include the following voice effects:
Member agora_gaming_rtc.IRtcEngine.SetLocalVoiceReverbPreset (AUDIO_REVERB_PRESET audioReverbPreset)
Deprecated from v3.2.0. Use SetAudioEffectPreset or SetVoiceBeautifierPreset instead.
Member agora_gaming_rtc.IRtcEngine.SetLogFile (string filePath)
This method is deprecated from v3.3.1. Use logConfig in the GetEngine method instead.
Member agora_gaming_rtc.IRtcEngine.SetLogFileSize (uint fileSizeInKBytes)
This method is deprecated from v3.3.1. Use logConfig in the GetEngine method instead.
Member agora_gaming_rtc.IRtcEngine.SetLogFilter (LOG_FILTER filter)
This method is deprecated from v3.3.1. Use logConfig in the GetEngine method 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.0. 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.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.0. Use VOICE_BEAUTIFIER_PRESET instead.