Agora Unity SDK API Reference
概览
IRtcEngine
AgoraCallback
AgoraChannel
AudioEffectManagerImpl
AudioPlaybackDeviceManager
AudioRecordingDeviceManager
VideoDeviceManager
MetadataObserver
PacketObserver
AudioRawDataManager
VideoRawDataManager
VideoSurface
警告码
错误码
- 成员 agora_gaming_rtc.IRtcEngine.AddVideoWatermark (RtcImage rtcImage)
- 该方法自 v2.9.1 起废弃，请改用 AddVideoWatermark。
- 成员 agora_gaming_rtc.IRtcEngine.EnableWebSdkInteroperability (bool enabled)
- 该方法自 v3.0.1 起废弃。自 v3.0.1 起，Unity SDK 自动开启与 Web SDK 的互通，无需调用该方法开启。
- 成员 agora_gaming_rtc.IRtcEngine.getEngine (string appId)
- 该方法已废弃，请改用 GetEngine。
- 成员 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.StartAudioRecording (string filePath, AUDIO_RECORDING_QUALITY_TYPE quality)
- 该方法从 v2.9.1 起废弃，其默认录音采样率为 32 kHz，不可修改。请改用新的 StartAudioRecording2 方法。
- 成员 agora_gaming_rtc.IRtcEngine.StartEchoTest ()
- 该方法自 v2.4 起废弃。
- 成员 agora_gaming_rtc.LiveTranscoding.lowLatency
- true: 低延时，不保证画质；
- false: （默认值）高延时，保证画质。
- 成员 agora_gaming_rtc.LiveTranscoding.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.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.PublisherConfiguration
- 该结构体已被废弃。
- 成员 agora_gaming_rtc.RemoteVideoStats.delay
- 延时 (毫秒)。 在有音画同步机制的音视频场景中，你可以参考
RemoteAudioStats里的networkTransportDelay和jitterBufferDelay成员的值，了解视频的延迟数据。 - 成员 agora_gaming_rtc.RENDER_MODE_ADAPTIVE
- 3: 该模式已废弃。
- 成员 agora_gaming_rtc.VIDEO_PROFILE_TYPE
- 横屏模式视频属性。
