文档中心
互动直播 (Legacy)
API 参考
Agora Unity API Reference for All Platforms
Agora Unity SDK API Reference
- 成员 agora_gaming_rtc.AgoraChannel.CreateDataStream (bool reliable, bool ordered)
- 该方法自 v3.3.1 起废弃,请改用 CreateDataStream2。
- 成员 agora_gaming_rtc.AgoraChannel.Publish ()
- 该方法自 v3.4.5 起废弃,请改用 MuteLocalAudioStream (false) 或 MuteLocalVideoStream (false)。
- 成员 agora_gaming_rtc.AgoraChannel.SetDefaultMuteAllRemoteAudioStreams (bool mute)
- 该方法自 v3.3.1 起废弃。
- 成员 agora_gaming_rtc.AgoraChannel.SetDefaultMuteAllRemoteVideoStreams (bool mute)
- 该方法自 v3.3.1 起废弃。
- 成员 agora_gaming_rtc.AgoraChannel.Unpublish ()
- 该方法自 v3.4.5 起废弃,请改用 MuteLocalAudioStream (true) 或 MuteLocalVideoStream (true)。
- 成员 agora_gaming_rtc.AUDIO_MIXING_ERROR_TYPE
自 v3.4.2 废弃,请改用 AUDIO_MIXING_REASON_TYPE 。
自 v3.4.2 废弃,请改用 AUDIO_MIXING_REASON_TYPE 。
- 成员 agora_gaming_rtc.AUDIO_REVERB_PRESET
自 v3.2.0 废弃。请改用 AUDIO_EFFECT_PRESET 。
自 v3.2.0 废弃。请改用 AUDIO_EFFECT_PRESET 。
- 成员 agora_gaming_rtc.AudioEffectManagerImpl.PlayEffect (int soundId, string filePath, int loopCount, double pitch=1.0D, double pan=0.0D, int gain=100, bool publish=false)
- 自 v3.4.2 废弃,请改用 PlayEffect[2/2]。
- 成员 agora_gaming_rtc.IRtcEngine.AddVideoWatermark (RtcImage rtcImage)
- 该方法自 v2.9.1 起废弃,请改用 AddVideoWatermark。
- 成员 agora_gaming_rtc.IRtcEngine.CreateDataStream (bool reliable, bool ordered)
- 该方法自 v3.3.1 起废弃,请改用 CreateDataStream2。
- 成员 agora_gaming_rtc.IRtcEngine.EnableWebSdkInteroperability (bool enabled)
- 该方法自 v3.0.1 起废弃。自 v3.0.1 起,Unity SDK 自动开启与 Web SDK 的互通,无需调用该方法开启。
- 成员 agora_gaming_rtc.IRtcEngine.GetAudioMixingDuration ()
- 自v3.4.2废弃,请改用 GetAudioMixingDuration[2/2]。
- 成员 agora_gaming_rtc.IRtcEngine.getEngine (string appId)
- 该方法已废弃,请改用 GetEngine。
- 成员 agora_gaming_rtc.IRtcEngine.SetDefaultMuteAllRemoteAudioStreams (bool mute)
- 该方法自 v3.3.1 起废弃。
- 成员 agora_gaming_rtc.IRtcEngine.SetDefaultMuteAllRemoteVideoStreams (bool mute)
- 该方法自 v3.3.1 起废弃。
- 成员 agora_gaming_rtc.IRtcEngine.SetEncryptionMode (string encryptionMode)
- 该方法自 v3.2.0 起废弃。请改用 EnableEncryption 方法。
- 成员 agora_gaming_rtc.IRtcEngine.SetEncryptionSecret (string secret)
- 该方法自 v3.2.0 起废弃。请改用 EnableEncryption 方法。
- 成员 agora_gaming_rtc.IRtcEngine.SetLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)
- 该方法从 v3.2.0 起废弃,请改用如下方法:
- 成员 agora_gaming_rtc.IRtcEngine.SetLocalVoiceReverbPreset (AUDIO_REVERB_PRESET audioReverbPreset)
- 该方法从 v3.2.0 起废弃,请改用 SetAudioEffectPreset 或 SetVoiceBeautifierPreset。
- 成员 agora_gaming_rtc.IRtcEngine.SetLogFile (string filePath)
- 该方法从 v3.3.1 起废弃,请改用 GetEngine 中的
logConfig
。
- 成员 agora_gaming_rtc.IRtcEngine.SetLogFileSize (uint fileSizeInKBytes)
- 该方法从 v3.3.1 起废弃,请改用 GetEngine 中的
logConfig
。
- 成员 agora_gaming_rtc.IRtcEngine.SetLogFilter (LOG_FILTER filter)
- 该方法从 v3.3.1 起废弃,请改用 GetEngine 中的
logConfig
。
- 成员 agora_gaming_rtc.IRtcEngine.SetSpeakerphoneVolume (int volume)
- 该方法自 v2.3 起废弃。改用 AdjustRecordingSignalVolume 和 AdjustPlaybackSignalVolume 方法。
- 成员 agora_gaming_rtc.IRtcEngine.SetVideoProfile (VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight)
- 该方法自 v2.3 起废弃。请改用 SetVideoEncoderConfiguration 方法。
- 成员 agora_gaming_rtc.IRtcEngine.SetVideoQualityParameters (bool preferFrameRateOverImageQuality)
- 该方法自 v2.4 起废弃。
- 成员 agora_gaming_rtc.IRtcEngine.StartAudioMixing (string filePath, bool loopback, bool replace, int cycle)
- 自v3.4.2 废弃,请改用 StartAudioMixing[2/2]。
- 成员 agora_gaming_rtc.IRtcEngine.StartAudioRecording (string filePath, AUDIO_RECORDING_QUALITY_TYPE quality)
- 自 v3.4.2 废弃,请改用新的 StartAudioRecording[3/3] 方法。
- 成员 agora_gaming_rtc.IRtcEngine.StartAudioRecording (string filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)
- 自 v3.4.2 废弃。请改用 StartAudioRecording[3/3]。
- 成员 agora_gaming_rtc.IRtcEngine.StartEchoTest ()
- 该方法自 v2.4 起废弃。
- 成员 agora_gaming_rtc.LiveTranscoding.lowLatency
- true: 低延时,不保证画质;
- false: (默认值)高延时,保证画质。
- true: 低延时,不保证画质;
- false: (默认值)高延时,保证画质。
- 成员 agora_gaming_rtc.LiveTranscoding.metadata
发送给 CDN 客户端的 metadata。
发送给 CDN 客户端的 metadata。
- 成员 agora_gaming_rtc.MEDIA_SOURCE_TYPE
音频采集设备类型。
音频采集设备类型。
- 成员 agora_gaming_rtc.OnAudioMixingFinishedHandler ()
- 该回调已废弃,请改用 OnAudioMixingStateChangedHandler。
- 成员 agora_gaming_rtc.OnAudioQualityHandler (uint userId, int quality, ushort delay, ushort lost)
- 该回调自 v2.3.2 起废弃。请改用 OnRemoteAudioStatsHandler 回调。
- 成员 agora_gaming_rtc.OnCameraReadyHandler ()
- 该回调自 v2.4.1 起废弃。请改用 OnLocalVideoStateChangedHandler 回调中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
- 成员 agora_gaming_rtc.OnConnectionBannedHandler ()
- 该回调自 v2.3.2 起废弃,请改用 OnConnectionStateChangedHandler。
- 成员 agora_gaming_rtc.OnConnectionInterruptedHandler ()
- 该回调自 v2.3.2 起废弃,请改用 OnConnectionStateChangedHandler。
- 成员 agora_gaming_rtc.OnFirstLocalAudioFrameHandler (int elapsed)
- 该回调自 v3.2.0 废弃,请改用 OnFirstLocalAudioFramePublishedHandler 回调。
- 成员 agora_gaming_rtc.OnFirstRemoteAudioDecodedHandler (uint uid, int elapsed)
- 该方法自 v3.0.1 起废弃,请改用 OnRemoteAudioStateChangedHandler。
- 成员 agora_gaming_rtc.OnFirstRemoteAudioFrameHandler (uint userId, int elapsed)
- 该回调自 v3.0.1 起废弃,请改用 OnRemoteAudioStateChangedHandler。
- 成员 agora_gaming_rtc.OnFirstRemoteVideoDecodedHandler (uint uid, int width, int height, int elapsed)
- 该回调已被废弃,请改用 OnRemoteVideoStateChangedHandler 回调的:
- 成员 agora_gaming_rtc.OnMicrophoneEnabledHandler (bool isEnabled)
- 该回调已被废弃,请改用 OnLocalAudioStateChangedHandler 回调的:LOCAL_AUDIO_STREAM_STATE_STOPPED(0) 或 LOCAL_AUDIO_STREAM_STATE_RECORDING(1)。
- 成员 agora_gaming_rtc.OnRemoteAudioTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)
- 该回调已被废弃,请改用 OnRemoteAudioStatsHandler。
- 成员 agora_gaming_rtc.OnRemoteVideoTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)
- 该回调已被废弃,请改用 OnRemoteVideoStatsHandler。
- 成员 agora_gaming_rtc.OnStreamPublishedHandler (string url, int error)
- 该回调自 v3.0.1 起废弃,请改用 OnRtmpStreamingStateChangedHandler。
- 成员 agora_gaming_rtc.OnStreamUnpublishedHandler (string url)
- 该回调自 v3.0.1 起废弃。请改用 OnRtmpStreamingStateChangedHandler。
- 成员 agora_gaming_rtc.OnUserEnableLocalVideoHandler (uint uid, bool enabled)
- 该回调已被废弃,请改用 OnRemoteVideoStateChangedHandler 回调的:
- 成员 agora_gaming_rtc.OnUserEnableVideoHandler (uint uid, bool enabled)
- 该回调已被废弃,请改用 OnRemoteVideoStateChangedHandler 回调的:
- 成员 agora_gaming_rtc.OnVideoStoppedHandler ()
- 该回调自 v2.4.1 起废弃。请改用 OnLocalVideoStateChangedHandler 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。
- 成员 agora_gaming_rtc.RemoteVideoStats.delay
延时 (毫秒)。 在有音画同步机制的音视频场景中,你可以参考 RemoteAudioStats
里的 networkTransportDelay
和 jitterBufferDelay
成员的值,了解视频的延迟数据。
延时 (毫秒)。 在有音画同步机制的音视频场景中,你可以参考 RemoteAudioStats
里的 networkTransportDelay
和 jitterBufferDelay
成员的值,了解视频的延迟数据。
- 成员 agora_gaming_rtc.RENDER_MODE_ADAPTIVE
3: 该模式已废弃。
3: 该模式已废弃。
- 成员 agora_gaming_rtc.VIDEO_PROFILE_TYPE
横屏模式视频属性。
横屏模式视频属性。
- 成员 agora_gaming_rtc.VOICE_CHANGER_PRESET
自 v3.2.0 废弃。请改用 VOICE_BEAUTIFIER_PRESET 。
自 v3.2.0 废弃。请改用 VOICE_BEAUTIFIER_PRESET 。