

互动直播 (Legacy)





Unity SDK API 参考

概览 IRtcEngine AgoraCallback AgoraChannel AudioEffectManagerImpl AudioPlaybackDeviceManager AudioRecordingDeviceManager VideoDeviceManager MetadataObserver PacketObserver AudioRawDataManager VideoRawDataManager VideoSurface MediaRecorder

类
class	AgoraChannel

struct	LogConfig

struct	RtcEngineConfig

struct	RtcStats

struct	AudioVolumeInfo

struct	ChannelMediaOptions

struct	LocalVideoStats

struct	RemoteVideoStats

struct	UserInfo

struct	RemoteAudioStats

struct	WatermarkOptions

struct	LocalAudioStats

struct	VideoEncoderConfiguration

struct	VideoDimensions

struct	TranscodingUser

struct	RtcImage

struct	LiveTranscoding

struct	ExternalVideoFrame

struct	VideoFrame

struct	AudioFrame

struct	LastmileProbeOneWayResult

struct	LastmileProbeResult

struct	CameraCapturerConfiguration

struct	LastmileProbeConfig

struct	Packet

struct	BeautyOptions

struct	Rectangle

struct	ScreenCaptureParameters

struct	ChannelMediaRelayConfiguration

struct	ChannelMediaInfo

struct	Metadata

struct	VideoCanvas

class	EncryptionConfig

struct	ClientRoleOptions

struct	DataStreamConfig

struct	AudioRecordingConfiguration

struct	VirtualBackgroundSource

struct	AudioFileInfo

struct	EchoTestConfiguration

class	VDataInfo

class	ADataInfo

struct	AVData

struct	MediaRecorderConfiguration

struct	RecorderInfo

struct	LogUploadServerInfo

struct	AdvancedConfigInfo

struct	LocalAccessPointConfiguration

struct	LowLightEnhanceOptions

struct	VideoDenoiserOptions

struct	ColorEnhanceOptions

struct	WlAccStats

struct	ThumbImageBuffer

struct	ScreenCaptureInfo

class	IRtcEngine

class	IAudioEffectManager

class	AudioEffectManagerImpl

class	IAudioPlaybackDeviceManager

class	AudioPlaybackDeviceManager

class	IAudioRecordingDeviceManager

class	AudioRecordingDeviceManager

class	IMediaRecorder

class	MediaRecorder

class	IScreenCaptureManager

class	ScreenCaptureManager

class	IVideoDeviceManager

class	VideoDeviceManager

class	IRtcEngineNative

class	IMetadataObserver

class	MetadataObserver

class	IPacketObserver

class	PacketObserver

class	IAudioRawDataManager

class	AudioRawDataManager

class	IVideoRawDataManager

class	VideoRawDataManager

class	VideoSurface

枚举
enum class	VIDEO_RENDER_MODE { RENDER_RAWDATA = 100 , REDNER_OPENGL_ES2 = 101 , RENDER_UNITY_LOW_LEVEL_INTERFACE = 102 }

enum class	ERROR_CODE { ERROR_NOT_INIT_ENGINE = -7 , ERROR_OK = 0 , ERROR_INVALID_ARGUMENT = -2 , ERROR_NO_DEVICE_PLUGIN = -100 }

enum class	REMOTE_VIDEO_STREAM_TYPE { REMOTE_VIDEO_STREAM_HIGH = 0 , REMOTE_VIDEO_STREAM_LOW = 1 }

enum class	REMOTE_VIDEO_STATE { REMOTE_VIDEO_STATE_STOPPED = 0 , REMOTE_VIDEO_STATE_STARTING = 1 , REMOTE_VIDEO_STATE_DECODING = 2 , REMOTE_VIDEO_STATE_FROZEN = 3 , REMOTE_VIDEO_STATE_FAILED = 4 }

enum class	AUDIO_MIXING_REASON_TYPE { AUDIO_MIXING_REASON_CAN_NOT_OPEN = 701 , AUDIO_MIXING_REASON_TOO_FREQUENT_CALL = 702 , AUDIO_MIXING_REASON_INTERRUPTED_EOF = 703 , AUDIO_MIXING_REASON_STARTED_BY_USER = 720 , AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED = 721 , AUDIO_MIXING_REASON_START_NEW_LOOP = 722 , AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED = 723 , AUDIO_MIXING_REASON_STOPPED_BY_USER = 724 , AUDIO_MIXING_REASON_PAUSED_BY_USER = 725 , AUDIO_MIXING_REASON_RESUMED_BY_USER = 726 }

enum class	USER_OFFLINE_REASON { QUIT = 0 , DROPPED = 1 , BECOME_AUDIENCE = 2 }

enum class	LOG_FILTER { OFF = 0 , DEBUG = 0x80f , INFO = 0x0f , WARNING = 0x0e , ERROR = 0x0c , CRITICAL = 0x08 }

enum class	CHANNEL_PROFILE { CHANNEL_PROFILE_COMMUNICATION = 0 , CHANNEL_PROFILE_LIVE_BROADCASTING = 1 , CHANNEL_PROFILE_GAME = 2 }

enum class	CLIENT_ROLE_TYPE { CLIENT_ROLE_BROADCASTER = 1 , CLIENT_ROLE_AUDIENCE = 2 }

enum class	AUDIO_RECORDING_QUALITY_TYPE { AUDIO_RECORDING_QUALITY_LOW = 0 , AUDIO_RECORDING_QUALITY_MEDIUM = 1 , AUDIO_RECORDING_QUALITY_HIGH = 2 , AUDIO_RECORDING_QUALITY_ULTRA_HIGH = 3 }

enum class	AUDIO_ROUTE { AUDIO_ROUTE_DEFAULT = -1 , AUDIO_ROUTE_HEADSET = 0 , AUDIO_ROUTE_EARPIECE = 1 , AUDIO_ROUTE_HEADSET_NO_MIC = 2 , AUDIO_ROUTE_SPEAKERPHONE = 3 , AUDIO_ROUTE_LOUDSPEAKER = 4 , AUDIO_ROUTE_BLUETOOTH , AUDIO_ROUTE_HDMI = 7 , AUDIO_ROUTE_DISPLAYPORT = 8 , AUDIO_ROUTE_AIRPLAY = 9 }

enum class	CONNECTION_STATE_TYPE { CONNECTION_STATE_DISCONNECTED = 1 , CONNECTION_STATE_CONNECTING = 2 , CONNECTION_STATE_CONNECTED = 3 , CONNECTION_STATE_RECONNECTING = 4 , CONNECTION_STATE_FAILED = 5 }

enum class	CONNECTION_CHANGED_REASON_TYPE { CONNECTION_CHANGED_CONNECTING = 0 , CONNECTION_CHANGED_JOIN_SUCCESS = 1 , CONNECTION_CHANGED_INTERRUPTED = 2 , CONNECTION_CHANGED_BANNED_BY_SERVER = 3 , CONNECTION_CHANGED_JOIN_FAILED = 4 , CONNECTION_CHANGED_LEAVE_CHANNEL = 5 , CONNECTION_CHANGED_INVALID_APP_ID = 6 , CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7 , CONNECTION_CHANGED_INVALID_TOKEN = 8 , CONNECTION_CHANGED_TOKEN_EXPIRED = 9 , CONNECTION_CHANGED_REJECTED_BY_SERVER = 10 , CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11 , CONNECTION_CHANGED_RENEW_TOKEN = 12 , CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13 , CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14 , CONNECTION_CHANGED_SAME_UID_LOGIN = 19 , CONNECTION_CHANGED_TOO_MANY_BROADCASTERS = 20 }

enum class	STREAM_FALLBACK_OPTIONS { STREAM_FALLBACK_OPTION_DISABLED = 0 , STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1 , STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2 }

enum class	VideoContentHint { CONTENT_HINT_NONE = 0 , CONTENT_HINT_MOTION = 1 , CONTENT_HINT_DETAILS = 2 }

enum class	REMOTE_VIDEO_STATE_REASON { REMOTE_VIDEO_STATE_REASON_INTERNAL = 0 , REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1 , REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2 , REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3 , REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4 , REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5 , REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6 , REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7 , REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8 , REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9 , REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND = 10 }

enum class	LOCAL_VIDEO_STREAM_STATE { LOCAL_VIDEO_STREAM_STATE_STOPPED = 0 , LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1 , LOCAL_VIDEO_STREAM_STATE_ENCODING = 2 , LOCAL_VIDEO_STREAM_STATE_FAILED = 3 }

enum class	LOCAL_VIDEO_STREAM_ERROR { LOCAL_VIDEO_STREAM_ERROR_OK = 0 , LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1 , LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2 , LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3 , LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4 , LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5 , LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND = 6 , LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7 , LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND = 8 , LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED = 9 , LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID = 10 , LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11 , LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED = 12 , LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED = 13 , LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20 }

enum class	AUDIO_RECORDING_POSITION { AUDIO_RECORDING_POSITION_MIXED_RECORDING_AND_PLAYBACK = 0 , AUDIO_RECORDING_POSITION_RECORDING = 1 , AUDIO_RECORDING_POSITION_MIXED_PLAYBACK = 2 }

enum class	MEDIA_DEVICE_TYPE { UNKNOWN_AUDIO_DEVICE = -1 , AUDIO_PLAYOUT_DEVICE = 0 , AUDIO_RECORDING_DEVICE = 1 , VIDEO_RENDER_DEVICE = 2 , VIDEO_CAPTURE_DEVICE = 3 , AUDIO_APPLICATION_PLAYOUT_DEVICE = 4 }

enum class	RAW_AUDIO_FRAME_OP_MODE_TYPE { RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0 , RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1 , RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2 }

enum class	AUDIO_PROFILE_TYPE { AUDIO_PROFILE_DEFAULT = 0 , AUDIO_PROFILE_SPEECH_STANDARD = 1 , AUDIO_PROFILE_MUSIC_STANDARD = 2 , AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3 , AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4 , AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5 , AUDIO_PROFILE_IOT = 6 , AUDIO_PROFILE_NUM = 7 }

enum class	AUDIO_SCENARIO_TYPE { AUDIO_SCENARIO_DEFAULT = 0 , AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1 , AUDIO_SCENARIO_EDUCATION = 2 , AUDIO_SCENARIO_GAME_STREAMING = 3 , AUDIO_SCENARIO_SHOWROOM = 4 , AUDIO_SCENARIO_CHATROOM_GAMING = 5 , AUDIO_SCENARIO_IOT = 6 , AUDIO_SCENARIO_MEETING = 8 , AUDIO_SCENARIO_NUM = 10 }

enum class	VIDEO_CODEC_PROFILE_TYPE { VIDEO_CODEC_PROFILE_BASELINE = 66 , VIDEO_CODEC_PROFILE_MAIN = 77 , VIDEO_CODEC_PROFILE_HIGH = 100 }

enum class	AUDIO_SAMPLE_RATE_TYPE { AUDIO_SAMPLE_RATE_32000 = 32000 , AUDIO_SAMPLE_RATE_44100 = 44100 , AUDIO_SAMPLE_RATE_48000 = 48000 }

enum class	AUDIO_MIXING_STATE_TYPE { AUDIO_MIXING_STATE_PLAYING = 710 , AUDIO_MIXING_STATE_PAUSED = 711 , AUDIO_MIXING_STATE_STOPPED = 713 , AUDIO_MIXING_STATE_FAILED = 714 }

enum class	AUDIO_MIXING_ERROR_TYPE { AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701 , AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702 , AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703 , AUDIO_MIXING_ERROR_OK = 0 }

enum class	RTMP_STREAM_PUBLISH_STATE { RTMP_STREAM_PUBLISH_STATE_IDLE = 0 , RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1 , RTMP_STREAM_PUBLISH_STATE_RUNNING = 2 , RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3 , RTMP_STREAM_PUBLISH_STATE_FAILURE = 4 , RTMP_STREAM_PUBLISH_STATE_DISCONNECTING = 5 }

enum class	RTMP_STREAM_PUBLISH_ERROR_TYPE { RTMP_STREAM_PUBLISH_ERROR_OK = 0 , RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT = 1 , RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED = 2 , RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT = 3 , RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR = 4 , RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR = 5 , RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN = 6 , RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT = 7 , RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED = 8 , RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND = 9 , RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED = 10 , RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER = 11 , RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM = 13 , RTMP_STREAM_PUBLISH_ERROR_NET_DOWN = 14 , RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID = 15 , RTMP_STREAM_UNPUBLISH_ERROR_OK = 100 }

enum class	NETWORK_TYPE { NETWORK_TYPE_UNKNOWN = -1 , NETWORK_TYPE_DISCONNECTED = 0 , NETWORK_TYPE_LAN = 1 , NETWORK_TYPE_WIFI = 2 , NETWORK_TYPE_MOBILE_2G = 3 , NETWORK_TYPE_MOBILE_3G = 4 , NETWORK_TYPE_MOBILE_4G = 5 , NETWORK_TYPE_MOBILE_5G = 6 }

enum class	VOICE_CHANGER_PRESET { VOICE_CHANGER_OFF = 0x00000000 , VOICE_CHANGER_OLDMAN = 0x00000001 , VOICE_CHANGER_BABYBOY = 0x00000002 , VOICE_CHANGER_BABYGIRL = 0x00000003 , VOICE_CHANGER_ZHUBAJIE = 0x00000004 , VOICE_CHANGER_ETHEREAL = 0x00000005 , VOICE_CHANGER_HULK = 0x00000006 , VOICE_BEAUTY_VIGOROUS = 0x00100001 , VOICE_BEAUTY_DEEP = 0x00100002 , VOICE_BEAUTY_MELLOW = 0x00100003 , VOICE_BEAUTY_FALSETTO = 0x00100004 , VOICE_BEAUTY_FULL = 0x00100005 , VOICE_BEAUTY_CLEAR = 0x00100006 , VOICE_BEAUTY_RESOUNDING = 0x00100007 , VOICE_BEAUTY_RINGING = 0x00100008 , VOICE_BEAUTY_SPACIAL = 0x00100009 , GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x00200001 , GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x00200002 , GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x00200003 }

enum class	AUDIO_REVERB_PRESET { AUDIO_REVERB_OFF = 0x00000000 , AUDIO_REVERB_FX_KTV = 0x00100001 , AUDIO_REVERB_FX_VOCAL_CONCERT = 0x00100002 , AUDIO_REVERB_FX_UNCLE = 0x00100003 , AUDIO_REVERB_FX_SISTER = 0x00100004 , AUDIO_REVERB_FX_STUDIO = 0x00100005 , AUDIO_REVERB_FX_POPULAR = 0x00100006 , AUDIO_REVERB_FX_RNB = 0x00100007 , AUDIO_REVERB_FX_PHONOGRAPH = 0x00100008 , AUDIO_REVERB_POPULAR = 0x00000001 , AUDIO_REVERB_RNB = 0x00000002 , AUDIO_REVERB_ROCK = 0x00000003 , AUDIO_REVERB_HIPHOP = 0x00000004 , AUDIO_REVERB_VOCAL_CONCERT = 0x00000005 , AUDIO_REVERB_KTV = 0x00000006 , AUDIO_REVERB_STUDIO = 0x00000007 , AUDIO_VIRTUAL_STEREO = 0x00200001 }

enum class	AUDIO_EQUALIZATION_BAND_FREQUENCY { AUDIO_EQUALIZATION_BAND_31 = 0 , AUDIO_EQUALIZATION_BAND_62 = 1 , AUDIO_EQUALIZATION_BAND_125 = 2 , AUDIO_EQUALIZATION_BAND_250 = 3 , AUDIO_EQUALIZATION_BAND_500 = 4 , AUDIO_EQUALIZATION_BAND_1K = 5 , AUDIO_EQUALIZATION_BAND_2K = 6 , AUDIO_EQUALIZATION_BAND_4K = 7 , AUDIO_EQUALIZATION_BAND_8K = 8 , AUDIO_EQUALIZATION_BAND_16K = 9 }

enum class	QUALITY_ADAPT_INDICATION { ADAPT_NONE = 0 , ADAPT_UP_BANDWIDTH = 1 , ADAPT_DOWN_BANDWIDTH = 2 }

enum class	AUDIO_REVERB_TYPE { AUDIO_REVERB_DRY_LEVEL = 0 , AUDIO_REVERB_WET_LEVEL = 1 , AUDIO_REVERB_ROOM_SIZE = 2 , AUDIO_REVERB_WET_DELAY = 3 , AUDIO_REVERB_STRENGTH = 4 }

enum class	AUDIO_CODEC_PROFILE_TYPE { AUDIO_CODEC_PROFILE_LC_AAC = 0 , AUDIO_CODEC_PROFILE_HE_AAC = 1 , AUDIO_CODEC_PROFILE_HE_AAC_V2 = 2 }

enum class	VIDEO_CODEC_TYPE { VIDEO_CODEC_VP8 = 1 , VIDEO_CODEC_H264 = 2 , VIDEO_CODEC_EVP = 3 , VIDEO_CODEC_E264 = 4 }

enum class	AREA_CODE : uint { AREA_CODE_CN = 0x00000001 , AREA_CODE_NA = 0x00000002 , AREA_CODE_EUR = 0x00000004 , AREA_CODE_AS = 0x00000008 , AREA_CODE_JP = 0x00000010 , AREA_CODE_IN = 0x00000020 , AREA_CODE_GLOBAL = 0xFFFFFFFF }

enum class	LOG_LEVEL { LOG_LEVEL_NONE = 0x0000 , LOG_LEVEL_INFO = 0x0001 , LOG_LEVEL_WARN = 0x0002 , LOG_LEVEL_ERROR = 0x0004 , LOG_LEVEL_FATAL = 0x0008 }

enum class	FRAME_RATE { FRAME_RATE_FPS_1 = 1 , FRAME_RATE_FPS_7 = 7 , FRAME_RATE_FPS_10 = 10 , FRAME_RATE_FPS_15 = 15 , FRAME_RATE_FPS_24 = 24 , FRAME_RATE_FPS_30 = 30 , FRAME_RATE_FPS_60 = 60 }

enum class	ORIENTATION_MODE { ORIENTATION_MODE_ADAPTIVE = 0 , ORIENTATION_MODE_FIXED_LANDSCAPE = 1 , ORIENTATION_MODE_FIXED_PORTRAIT = 2 }

enum class	DEGRADATION_PREFERENCE { MAINTAIN_QUALITY = 0 , MAINTAIN_FRAMERATE = 1 , MAINTAIN_BALANCED = 2 }

enum class	VIDEO_FRAME_TYPE { FRAME_TYPE_YUV420 = 0 , FRAME_TYPE_RGBA = 1 }

enum class	VIDEO_MIRROR_MODE_TYPE { VIDEO_MIRROR_MODE_AUTO = 0 , VIDEO_MIRROR_MODE_ENABLED = 1 , VIDEO_MIRROR_MODE_DISABLED = 2 }

enum class	AUDIO_FRAME_TYPE { FRAME_TYPE_PCM16 = 0 }

enum class	MEDIA_SOURCE_TYPE { AUDIO_PLAYOUT_SOURCE = 0 , AUDIO_RECORDING_SOURCE = 1 }

enum class	LASTMILE_PROBE_RESULT_STATE { LASTMILE_PROBE_RESULT_COMPLETE = 1 , LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2 , LASTMILE_PROBE_RESULT_UNAVAILABLE = 3 }

enum class	CAMERA_DIRECTION { CAMERA_REAR = 0 , CAMERA_FRONT = 1 }

enum class	CAPTURER_OUTPUT_PREFERENCE { CAPTURER_OUTPUT_PREFERENCE_AUTO = 0 , CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1 , CAPTURER_OUTPUT_PREFERENCE_PREVIEW = 2 , CAPTURER_OUTPUT_PREFERENCE_MANUAL = 3 }

enum class	QUALITY_TYPE { QUALITY_UNKNOWN = 0 , QUALITY_EXCELLENT = 1 , QUALITY_GOOD = 2 , QUALITY_POOR = 3 , QUALITY_BAD = 4 , QUALITY_VBAD = 5 , QUALITY_DOWN = 6 , QUALITY_UNSUPPORTED = 7 , QUALITY_DETECTING = 8 }

enum class	MEDIA_DEVICE_STATE_TYPE { MEDIA_DEVICE_STATE_IDLE = 0 , MEDIA_DEVICE_STATE_ACTIVE = 1 , MEDIA_DEVICE_STATE_DISABLED = 2 , MEDIA_DEVICE_STATE_NOT_PRESENT = 4 , MEDIA_DEVICE_STATE_UNPLUGGED = 8 , MEDIA_DEVICE_STATE_UNRECOMMENDED = 16 }

enum class	PRIORITY_TYPE { PRIORITY_HIGH = 50 , PRIORITY_NORMAL = 100 }

enum class	LOCAL_AUDIO_STREAM_STATE { LOCAL_AUDIO_STREAM_STATE_STOPPED = 0 , LOCAL_AUDIO_STREAM_STATE_RECORDING = 1 , LOCAL_AUDIO_STREAM_STATE_ENCODING = 2 , LOCAL_AUDIO_STREAM_STATE_FAILED = 3 }

enum class	LOCAL_AUDIO_STREAM_ERROR { LOCAL_AUDIO_STREAM_ERROR_OK = 0 , LOCAL_AUDIO_STREAM_ERROR_FAILURE = 1 , LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2 , LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY = 3 , LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE = 4 , LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5 , LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE = 6 , LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE = 7 , LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED = 8 , LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID = 9 , LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID = 10 }

enum class	REMOTE_AUDIO_STATE { REMOTE_AUDIO_STATE_STOPPED = 0 , REMOTE_AUDIO_STATE_STARTING = 1 , REMOTE_AUDIO_STATE_DECODING = 2 , REMOTE_AUDIO_STATE_FROZEN = 3 , REMOTE_AUDIO_STATE_FAILED = 4 }

enum class	REMOTE_AUDIO_STATE_REASON { REMOTE_AUDIO_REASON_INTERNAL = 0 , REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1 , REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2 , REMOTE_AUDIO_REASON_LOCAL_MUTED = 3 , REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4 , REMOTE_AUDIO_REASON_REMOTE_MUTED = 5 , REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6 , REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7 }

enum class	AUDIO_SESSION_OPERATION_RESTRICTION { AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0 , AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1 , AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1 , AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2 , AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7 }

enum class	CHANNEL_MEDIA_RELAY_EVENT { RELAY_EVENT_NETWORK_DISCONNECTED = 0 , RELAY_EVENT_NETWORK_CONNECTED = 1 , RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2 , RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3 , RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4 , RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5 , RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6 , RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7 , RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8 , RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9 , RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10 , RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11 , RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS = 12 , RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED = 13 , RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS = 14 , RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED = 15 }

enum class	CHANNEL_MEDIA_RELAY_STATE { RELAY_STATE_IDLE = 0 , RELAY_STATE_CONNECTING = 1 , RELAY_STATE_RUNNING = 2 , RELAY_STATE_FAILURE = 3 }

enum class	VIDEO_PROFILE_TYPE { VIDEO_PROFILE_LANDSCAPE_120P = 0 , VIDEO_PROFILE_LANDSCAPE_120P_3 = 2 , VIDEO_PROFILE_LANDSCAPE_180P = 10 , VIDEO_PROFILE_LANDSCAPE_180P_3 = 12 , VIDEO_PROFILE_LANDSCAPE_180P_4 = 13 , VIDEO_PROFILE_LANDSCAPE_240P = 20 , VIDEO_PROFILE_LANDSCAPE_240P_3 = 22 , VIDEO_PROFILE_LANDSCAPE_240P_4 = 23 , VIDEO_PROFILE_LANDSCAPE_360P = 30 , VIDEO_PROFILE_LANDSCAPE_360P_3 = 32 , VIDEO_PROFILE_LANDSCAPE_360P_4 = 33 , VIDEO_PROFILE_LANDSCAPE_360P_6 = 35 , VIDEO_PROFILE_LANDSCAPE_360P_7 = 36 , VIDEO_PROFILE_LANDSCAPE_360P_8 = 37 , VIDEO_PROFILE_LANDSCAPE_360P_9 = 38 , VIDEO_PROFILE_LANDSCAPE_360P_10 = 39 , VIDEO_PROFILE_LANDSCAPE_360P_11 = 100 , VIDEO_PROFILE_LANDSCAPE_480P = 40 , VIDEO_PROFILE_LANDSCAPE_480P_3 = 42 , VIDEO_PROFILE_LANDSCAPE_480P_4 = 43 , VIDEO_PROFILE_LANDSCAPE_480P_6 = 45 , VIDEO_PROFILE_LANDSCAPE_480P_8 = 47 , VIDEO_PROFILE_LANDSCAPE_480P_9 = 48 , VIDEO_PROFILE_LANDSCAPE_480P_10 = 49 , VIDEO_PROFILE_LANDSCAPE_720P = 50 , VIDEO_PROFILE_LANDSCAPE_720P_3 = 52 , VIDEO_PROFILE_LANDSCAPE_720P_5 = 54 , VIDEO_PROFILE_LANDSCAPE_720P_6 = 55 , VIDEO_PROFILE_LANDSCAPE_1080P = 60 , VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62 , VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64 , VIDEO_PROFILE_LANDSCAPE_1440P = 66 , VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67 , VIDEO_PROFILE_LANDSCAPE_4K = 70 , VIDEO_PROFILE_LANDSCAPE_4K_3 = 72 , VIDEO_PROFILE_PORTRAIT_120P = 1000 , VIDEO_PROFILE_PORTRAIT_120P_3 = 1002 , VIDEO_PROFILE_PORTRAIT_180P = 1010 , VIDEO_PROFILE_PORTRAIT_180P_3 = 1012 , VIDEO_PROFILE_PORTRAIT_180P_4 = 1013 , VIDEO_PROFILE_PORTRAIT_240P = 1020 , VIDEO_PROFILE_PORTRAIT_240P_3 = 1022 , VIDEO_PROFILE_PORTRAIT_240P_4 = 1023 , VIDEO_PROFILE_PORTRAIT_360P = 1030 , VIDEO_PROFILE_PORTRAIT_360P_3 = 1032 , VIDEO_PROFILE_PORTRAIT_360P_4 = 1033 , VIDEO_PROFILE_PORTRAIT_360P_6 = 1035 , VIDEO_PROFILE_PORTRAIT_360P_7 = 1036 , VIDEO_PROFILE_PORTRAIT_360P_8 = 1037 , VIDEO_PROFILE_PORTRAIT_360P_9 = 1038 , VIDEO_PROFILE_PORTRAIT_360P_10 = 1039 , VIDEO_PROFILE_PORTRAIT_360P_11 = 1100 , VIDEO_PROFILE_PORTRAIT_480P = 1040 , VIDEO_PROFILE_PORTRAIT_480P_3 = 1042 , VIDEO_PROFILE_PORTRAIT_480P_4 = 1043 , VIDEO_PROFILE_PORTRAIT_480P_6 = 1045 , VIDEO_PROFILE_PORTRAIT_480P_8 = 1047 , VIDEO_PROFILE_PORTRAIT_480P_9 = 1048 , VIDEO_PROFILE_PORTRAIT_480P_10 = 1049 , VIDEO_PROFILE_PORTRAIT_720P = 1050 , VIDEO_PROFILE_PORTRAIT_720P_3 = 1052 , VIDEO_PROFILE_PORTRAIT_720P_5 = 1054 , VIDEO_PROFILE_PORTRAIT_720P_6 = 1055 , VIDEO_PROFILE_PORTRAIT_1080P = 1060 , VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062 , VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064 , VIDEO_PROFILE_PORTRAIT_1440P = 1066 , VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067 , VIDEO_PROFILE_PORTRAIT_4K = 1070 , VIDEO_PROFILE_PORTRAIT_4K_3 = 1072 , VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P }

enum class	CHANNEL_MEDIA_RELAY_ERROR { RELAY_OK = 0 , RELAY_ERROR_SERVER_ERROR_RESPONSE = 1 , RELAY_ERROR_SERVER_NO_RESPONSE = 2 , RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3 , RELAY_ERROR_FAILED_JOIN_SRC = 4 , RELAY_ERROR_FAILED_JOIN_DEST = 5 , RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6 , RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7 , RELAY_ERROR_SERVER_CONNECTION_LOST = 8 , RELAY_ERROR_INTERNAL_ERROR = 9 , RELAY_ERROR_SRC_TOKEN_EXPIRED = 10 , RELAY_ERROR_DEST_TOKEN_EXPIRED = 11 }

enum class	METADATA_TYPE { UNKNOWN_METADATA = -1 , VIDEO_METADATA = 0 }

enum class	RENDER_MODE_TYPE { RENDER_MODE_HIDDEN = 1 , RENDER_MODE_FIT = 2 , RENDER_MODE_ADAPTIVE = 3 }

enum class	ENCRYPTION_MODE { AES_128_XTS = 1 , AES_128_ECB = 2 , AES_256_XTS = 3 , SM4_128_ECB = 4 , AES_128_GCM = 5 , AES_256_GCM = 6 , AES_128_GCM2 = 7 , AES_256_GCM2 = 8 , MODE_END }

enum class	RTMP_STREAMING_EVENT { RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1 , RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2 , RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT = 3 , RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN = 4 }

enum class	STREAM_PUBLISH_STATE { PUB_STATE_IDLE = 0 , PUB_STATE_NO_PUBLISHED = 1 , PUB_STATE_PUBLISHING = 2 , PUB_STATE_PUBLISHED = 3 }

enum class	STREAM_SUBSCRIBE_STATE { SUB_STATE_IDLE = 0 , SUB_STATE_NO_SUBSCRIBED = 1 , SUB_STATE_SUBSCRIBING = 2 , SUB_STATE_SUBSCRIBED = 3 }

enum class	AUDIENCE_LATENCY_LEVEL_TYPE { AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1 , AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2 }

enum class	VOICE_BEAUTIFIER_PRESET { VOICE_BEAUTIFIER_OFF = 0x00000000 , CHAT_BEAUTIFIER_MAGNETIC = 0x01010100 , CHAT_BEAUTIFIER_FRESH = 0x01010200 , CHAT_BEAUTIFIER_VITALITY = 0x01010300 , SINGING_BEAUTIFIER = 0x01020100 , TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100 , TIMBRE_TRANSFORMATION_DEEP = 0x01030200 , TIMBRE_TRANSFORMATION_MELLOW = 0x01030300 , TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400 , TIMBRE_TRANSFORMATION_FULL = 0x01030500 , TIMBRE_TRANSFORMATION_CLEAR = 0x01030600 , TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700 , TIMBRE_TRANSFORMATION_RINGING = 0x01030800 }

enum class	AUDIO_EFFECT_PRESET { AUDIO_EFFECT_OFF = 0x00000000 , ROOM_ACOUSTICS_KTV = 0x02010100 , ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200 , ROOM_ACOUSTICS_STUDIO = 0x02010300 , ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400 , ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500 , ROOM_ACOUSTICS_SPACIAL = 0x02010600 , ROOM_ACOUSTICS_ETHEREAL = 0x02010700 , ROOM_ACOUSTICS_3D_VOICE = 0x02010800 , VOICE_CHANGER_EFFECT_UNCLE = 0x02020100 , VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200 , VOICE_CHANGER_EFFECT_BOY = 0x02020300 , VOICE_CHANGER_EFFECT_SISTER = 0x02020400 , VOICE_CHANGER_EFFECT_GIRL = 0x02020500 , VOICE_CHANGER_EFFECT_PIGKING = 0x02020600 , VOICE_CHANGER_EFFECT_HULK = 0x02020700 , STYLE_TRANSFORMATION_RNB = 0x02030100 , STYLE_TRANSFORMATION_POPULAR = 0x02030200 , PITCH_CORRECTION = 0x02040100 }

enum class	SUPER_RESOLUTION_STATE_REASON { SR_STATE_REASON_SUCCESS = 0 , SR_STATE_REASON_STREAM_OVER_LIMITATION = 1 , SR_STATE_REASON_USER_COUNT_OVER_LIMITATION = 2 , SR_STATE_REASON_DEVICE_NOT_SUPPORTED = 3 , SR_STATE_REASON_INSUFFICIENT_PERFORMANCE = 4 }

enum class	CAPTURE_BRIGHTNESS_LEVEL_TYPE { CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1 , CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0 , CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1 , CAPTURE_BRIGHTNESS_LEVEL_DARK = 2 }

enum class	PROXY_TYPE { NONE_PROXY = 0 , UDP_PROXY = 1 , TCP_PROXY = 2 , LOCAL_PROXY_TYPE = 3 , TCP_PROXY_AUTO_FALLBACK_TYPE = 4 }

enum class	VOICE_CONVERSION_PRESET { VOICE_CONVERSION_OFF = 0x00000000 , VOICE_CHANGER_NEUTRAL = 0x03010100 , VOICE_CHANGER_SWEET = 0x03010200 , VOICE_CHANGER_SOLID = 0x03010300 , VOICE_CHANGER_BASS = 0x03010400 }

enum class	EXPERIENCE_QUALITY_TYPE { EXPERIENCE_QUALITY_GOOD = 0 , EXPERIENCE_QUALITY_BAD = 1 }

enum class	EXPERIENCE_POOR_REASON { EXPERIENCE_REASON_NONE = 0 , REMOTE_NETWORK_QUALITY_POOR = 1 , LOCAL_NETWORK_QUALITY_POOR = 2 , WIRELESS_SIGNAL_POOR = 4 , WIFI_BLUETOOTH_COEXIST = 8 }

enum class	BACKGROUND_SOURCE_TYPE { BACKGROUND_COLOR = 1 , BACKGROUND_IMG , BACKGROUND_BLUR }

enum class	BACKGROUND_BLUR_DEGREE { BLUR_DEGREE_LOW = 1 , BLUR_DEGREE_MEDIUM , BLUR_DEGREE_HIGH }

enum class	VIRTUAL_BACKGROUND_SOURCE_STATE_REASON { VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_SUCCESS = 0 , VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_IMAGE_NOT_EXIST = 1 , VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_COLOR_FORMAT_NOT_SUPPORTED = 2 , VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_DEVICE_NOT_SUPPORTED = 3 , VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_INSUFFICIENT_PERFORMANCE = 4 }

enum class	AUDIO_MIXING_DUAL_MONO_MODE { AUDIO_MIXING_DUAL_MONO_AUTO = 0 , AUDIO_MIXING_DUAL_MONO_L = 1 , AUDIO_MIXING_DUAL_MONO_R = 2 , AUDIO_MIXING_DUAL_MONO_MIX = 3 }

enum class	AUDIO_FILE_INFO_ERROR { AUDIO_FILE_INFO_ERROR_OK = 0 , AUDIO_FILE_INFO_ERROR_FAILURE = 1 }

enum class	CONTENT_INSPECT_RESULT { CONTENT_INSPECT_NEUTRAL = 1 , CONTENT_INSPECT_SEXY = 2 , CONTENT_INSPECT_PORN = 3 }

enum class	AVDATA_TYPE { AVDATA_UNKNOWN = 0 , AVDATA_VIDEO = 1 , AVDATA_AUDIO = 2 }

enum class	CODEC_VIDEO { CODEC_VIDEO_AVC = 0 , CODEC_VIDEO_HEVC = 1 , CODEC_VIDEO_VP8 = 2 }

enum class	CODEC_AUDIO { CODEC_AUDIO_PCM = 0 , CODEC_AUDIO_AAC = 1 , CODEC_AUDIO_G722 = 2 }

enum class	MediaRecorderContainerFormat { FORMAT_MP4 = 1 , FORMAT_FLV = 2 }

enum class	MediaRecorderStreamType { STREAM_TYPE_AUDIO = 0x01 , STREAM_TYPE_VIDEO = 0x02 , STREAM_TYPE_BOTH = STREAM_TYPE_AUDIO \| STREAM_TYPE_VIDEO }

enum class	RecorderState { RECORDER_STATE_ERROR = -1 , RECORDER_STATE_START = 2 , RECORDER_STATE_STOP = 3 }

enum class	RecorderErrorCode { RECORDER_ERROR_NONE = 0 , RECORDER_ERROR_WRITE_FAILED = 1 , RECORDER_ERROR_NO_STREAM = 2 , RECORDER_ERROR_OVER_MAX_DURATION = 3 , RECORDER_ERROR_CONFIG_CHANGED = 4 , RECORDER_ERROR_CUSTOM_STREAM_DETECTED = 5 }

enum class	LOCAL_PROXY_MODE { ConnectivityFirst = 0 , LocalOnly = 1 }

enum class	EXCLUDE_WINDOW_ERROR { EXCLUDE_WINDOW_FAIL = -1 , EXCLUDE_WINDOW_NONE = 0 }

enum class	AudioDeviceTestVolumeType { AudioTestRecordingVolume = 0 , AudioTestPlaybackVolume = 1 }

enum class	LOW_LIGHT_ENHANCE_MODE { LOW_LIGHT_ENHANCE_AUTO = 0 , LOW_LIGHT_ENHANCE_MANUAL }

enum class	LOW_LIGHT_ENHANCE_LEVEL { LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0 , LOW_LIGHT_ENHANCE_LEVEL_FAST }

enum class	VIDEO_DENOISER_MODE { VIDEO_DENOISER_AUTO = 0 , VIDEO_DENOISER_MANUAL }

enum class	VIDEO_DENOISER_LEVEL { VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0 , VIDEO_DENOISER_LEVEL_FAST , VIDEO_DENOISER_LEVEL_STRENGTH }

enum class	CLIENT_ROLE_CHANGE_FAILED_REASON { CLIENT_ROLE_CHANGE_FAILED_BY_TOO_MANY_BROADCASTERS = 1 , CLIENT_ROLE_CHANGE_FAILED_BY_NOT_AUTHORIZED = 2 , CLIENT_ROLE_CHANGE_FAILED_BY_REQUEST_TIME_OUT = 3 , CLIENT_ROLE_CHANGE_FAILED_BY_CONNECTION_FAILED = 4 }

enum class	WLACC_MESSAGE_REASON { WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0 , WLACC_MESSAGE_REASON_2G_CHANNEL_CONGESTION = 1 }

enum class	WLACC_SUGGEST_ACTION { WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI = 0 , WLACC_SUGGEST_ACTION_CONNECT_5G = 1 , WLACC_SUGGEST_ACTION_CHECK_5G = 2 , WLACC_SUGGEST_ACTION_MODIFY_SSID = 3 }

enum class	CLOUD_PROXY_TYPE { NONE_PROXY = 0 , UDP_PROXY = 1 , TCP_PROXY = 2 }

enum class	SCREEN_SCENARIO_TYPE { SCREEN_SCENARIO_DOCUMENT = 1 , SCREEN_SCENARIO_GAMING = 2 , SCREEN_SCENARIO_VIDEO = 3 , SCREEN_SCENARIO_RDC = 4 }

enum class	ScreenCaptureSourceType { ScreenCaptureSourceType_Unknown = -1 , ScreenCaptureSourceType_Window = 0 , ScreenCaptureSourceType_Screen = 1 , ScreenCaptureSourceType_Custom = 2 }

enum class	SR_MODE { SR_MODE_MANUAL = 0 , SR_MODE_AUTO }

enum class	AgoraVideoSurfaceType { Renderer = 0 , RawImage = 1 }

函数
delegate void	OnJoinChannelSuccessHandler (string channelName, uint uid, int elapsed)

delegate void	OnLeaveChannelHandler (RtcStats stats)

delegate void	OnReJoinChannelSuccessHandler (string channelName, uint uid, int elapsed)

delegate void	OnConnectionLostHandler ()

delegate void	OnConnectionInterruptedHandler ()

delegate void	OnRequestTokenHandler ()

delegate void	OnUserJoinedHandler (uint uid, int elapsed)

delegate void	OnUserOfflineHandler (uint uid, USER_OFFLINE_REASON reason)

delegate void	OnVolumeIndicationHandler (AudioVolumeInfo[] speakers, int speakerNumber, int totalVolume)

delegate void	OnLocalVoicePitchInHzHandler (int pitchInHz)

delegate void	OnUserMutedAudioHandler (uint uid, bool muted)

delegate void	OnSDKWarningHandler (int warn, string msg)

delegate void	OnSDKErrorHandler (int error, string msg)

delegate void	OnRtcStatsHandler (RtcStats stats)

delegate void	OnAudioMixingFinishedHandler ()

delegate void	OnAudioRouteChangedHandler (AUDIO_ROUTE route)

delegate void	OnFirstRemoteVideoDecodedHandler (uint uid, int width, int height, int elapsed)

delegate void	OnVideoSizeChangedHandler (uint uid, int width, int height, int rotation)

delegate void	OnClientRoleChangedHandler (CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)

delegate void	OnUserMuteVideoHandler (uint uid, bool muted)

delegate void	OnMicrophoneEnabledHandler (bool isEnabled)

delegate void	OnApiExecutedHandler (int err, string api, string result)

delegate void	OnLastmileQualityHandler (int quality)

delegate void	OnFirstLocalAudioFrameHandler (int elapsed)

delegate void	OnFirstRemoteAudioFrameHandler (uint userId, int elapsed)

delegate void	OnAudioQualityHandler (uint userId, int quality, ushort delay, ushort lost)

delegate void	OnStreamUnpublishedHandler (string url)

delegate void	OnStreamPublishedHandler (string url, int error)

delegate void	OnStreamMessageErrorHandler (uint userId, int streamId, int code, int missed, int cached)

delegate void	OnStreamMessageHandler (uint userId, int streamId, string data, int length)

delegate void	OnConnectionBannedHandler ()

delegate void	OnConnectionStateChangedHandler (CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)

delegate void	OnTokenPrivilegeWillExpireHandler (string token)

delegate void	OnActiveSpeakerHandler (uint uid)

delegate void	OnVideoStoppedHandler ()

delegate void	OnFirstLocalVideoFrameHandler (int width, int height, int elapsed)

delegate void	OnFirstRemoteVideoFrameHandler (uint uid, int width, int height, int elapsed)

delegate void	OnUserEnableVideoHandler (uint uid, bool enabled)

delegate void	OnUserEnableLocalVideoHandler (uint uid, bool enabled)

delegate void	OnRemoteVideoStateChangedHandler (uint uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)

delegate void	OnLocalPublishFallbackToAudioOnlyHandler (bool isFallbackOrRecover)

delegate void	OnRemoteSubscribeFallbackToAudioOnlyHandler (uint uid, bool isFallbackOrRecover)

delegate void	OnNetworkQualityHandler (uint uid, int txQuality, int rxQuality)

delegate void	OnLocalVideoStatsHandler (LocalVideoStats localVideoStats)

delegate void	OnRemoteVideoStatsHandler (RemoteVideoStats remoteVideoStats)

delegate void	OnRemoteAudioStatsHandler (RemoteAudioStats remoteAudioStats)

delegate void	OnAudioDeviceStateChangedHandler (string deviceId, int deviceType, int deviceState)

delegate void	OnCameraReadyHandler ()

delegate void	OnCameraFocusAreaChangedHandler (int x, int y, int width, int height)

delegate void	OnCameraExposureAreaChangedHandler (int x, int y, int width, int height)

delegate void	OnRemoteAudioMixingBeginHandler ()

delegate void	OnRemoteAudioMixingEndHandler ()

delegate void	OnAudioEffectFinishedHandler (int soundId)

delegate void	OnVideoDeviceStateChangedHandler (string deviceId, int deviceType, int deviceState)

delegate void	OnRemoteVideoTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)

delegate void	OnRemoteAudioTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate)

delegate void	OnTranscodingUpdatedHandler ()

delegate void	OnAudioDeviceVolumeChangedHandler (MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)

delegate void	OnMediaEngineStartCallSuccessHandler ()

delegate void	OnMediaEngineLoadSuccessHandler ()

delegate void	OnAudioMixingStateChangedHandler (AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason)

delegate void	OnFirstRemoteAudioDecodedHandler (uint uid, int elapsed)

delegate void	OnLocalVideoStateChangedHandler (LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error)

delegate void	OnRtmpStreamingStateChangedHandler (string url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode)

delegate void	OnNetworkTypeChangedHandler (NETWORK_TYPE type)

delegate void	OnLastmileProbeResultHandler (LastmileProbeResult result)

delegate void	OnLocalUserRegisteredHandler (uint uid, string userAccount)

delegate void	OnUserInfoUpdatedHandler (uint uid, UserInfo userInfo)

delegate void	OnLocalAudioStateChangedHandler (LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)

delegate void	OnRemoteAudioStateChangedHandler (uint uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)

delegate void	OnLocalAudioStatsHandler (LocalAudioStats localAudioStats)

delegate void	OnChannelMediaRelayStateChangedHandler (CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code)

delegate void	OnChannelMediaRelayEventHandler (CHANNEL_MEDIA_RELAY_EVENT events)

delegate void	OnFacePositionChangedHandler (int imageWidth, int imageHeight, Rectangle vecRectangle, int vecDistance, int numFaces)

delegate void	OnRtmpStreamingEventHandler (string url, RTMP_STREAMING_EVENT eventCode)

delegate void	OnAudioPublishStateChangedHandler (string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

delegate void	OnVideoPublishStateChangedHandler (string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

delegate void	OnAudioSubscribeStateChangedHandler (string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

delegate void	OnVideoSubscribeStateChangedHandler (string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

delegate void	OnFirstLocalAudioFramePublishedHandler (int elapsed)

delegate void	OnFirstLocalVideoFramePublishedHandler (int elapsed)

delegate void	OnUserSuperResolutionEnabledHandler (uint uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason)

delegate void	OnVirtualBackgroundSourceEnabledHandler (bool enabled, VIRTUAL_BACKGROUND_SOURCE_STATE_REASON reason)

delegate void	OnRequestAudioFileInfoHandler (AudioFileInfo info, AUDIO_FILE_INFO_ERROR error)

delegate void	OnSnapshotTakenHandler (string channel, uint uid, string filePath, int width, int height, int errCode)

delegate void	OnClientRoleChangeFailedHandler (CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)

delegate void	OnAudioDeviceTestVolumeIndicationHandler (AudioDeviceTestVolumeType volumeType, int volume)

delegate void	OnProxyConnectedHandler (string channel, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed)

delegate void	OnWlAccMessageHandler (WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, string wlAccMsg)

delegate void	OnWlAccStatsHandler (WlAccStats currentStats, WlAccStats averageStats)

delegate void	OnScreenCaptureInfoUpdatedHandler (ScreenCaptureInfo info)

delegate void	ChannelOnWarningHandler (string channelId, int warn, string message)

delegate void	ChannelOnErrorHandler (string channelId, int err, string message)

delegate void	ChannelOnJoinChannelSuccessHandler (string channelId, uint uid, int elapsed)

delegate void	ChannelOnReJoinChannelSuccessHandler (string channelId, uint uid, int elapsed)

delegate void	ChannelOnLeaveChannelHandler (string channelId, RtcStats rtcStats)

delegate void	ChannelOnClientRoleChangedHandler (string channelId, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)

delegate void	ChannelOnUserJoinedHandler (string channelId, uint uid, int elapsed)

delegate void	ChannelOnUserOffLineHandler (string channelId, uint uid, USER_OFFLINE_REASON reason)

delegate void	ChannelOnConnectionLostHandler (string channelId)

delegate void	ChannelOnRequestTokenHandler (string channelId)

delegate void	ChannelOnTokenPrivilegeWillExpireHandler (string channelId, string token)

delegate void	ChannelOnRtcStatsHandler (string channelId, RtcStats rtcStats)

delegate void	ChannelOnNetworkQualityHandler (string channelId, uint uid, int txQuality, int rxQuality)

delegate void	ChannelOnRemoteVideoStatsHandler (string channelId, RemoteVideoStats remoteVideoStats)

delegate void	ChannelOnRemoteAudioStatsHandler (string channelId, RemoteAudioStats remoteAudioStats)

delegate void	ChannelOnRemoteAudioStateChangedHandler (string channelId, uint uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)

delegate void	ChannelOnActiveSpeakerHandler (string channelId, uint uid)

delegate void	ChannelOnVideoSizeChangedHandler (string channelId, uint uid, int width, int height, int rotation)

delegate void	ChannelOnRemoteVideoStateChangedHandler (string channelId, uint uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)

delegate void	ChannelOnStreamMessageHandler (string channelId, uint uid, int streamId, string data, int length)

delegate void	ChannelOnStreamMessageErrorHandler (string channelId, uint uid, int streamId, int code, int missed, int cached)

delegate void	ChannelOnMediaRelayStateChangedHandler (string channelId, CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code)

delegate void	ChannelOnMediaRelayEventHandler (string channelId, CHANNEL_MEDIA_RELAY_EVENT events)

delegate void	ChannelOnRtmpStreamingStateChangedHandler (string channelId, string url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode)

delegate void	ChannelOnTranscodingUpdatedHandler (string channelId)

delegate void	ChannelOnRemoteSubscribeFallbackToAudioOnlyHandler (string channelId, uint uid, bool isFallbackOrRecover)

delegate void	ChannelOnConnectionStateChangedHandler (string channelId, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)

delegate void	ChannelOnLocalPublishFallbackToAudioOnlyHandler (string channelId, bool isFallbackOrRecover)

delegate void	ChannelOnRtmpStreamingEventHandler (string channelId, string url, RTMP_STREAMING_EVENT eventCode)

delegate void	ChannelOnAudioPublishStateChangedHandler (string channelId, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

delegate void	ChannelOnVideoPublishStateChangedHandler (string channelId, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

delegate void	ChannelOnAudioSubscribeStateChangedHandler (string channelId, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

delegate void	ChannelOnVideoSubscribeStateChangedHandler (string channelId, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

delegate void	ChannelOnUserSuperResolutionEnabledHandler (string channelId, uint uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason)

delegate void	ChannelOnClientRoleChangeFailedHandler (string channelId, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)

delegate void	ChannelOnFirstRemoteVideoFrameHandler (string channelId, uint uid, int width, int height, int elapsed)

delegate void	ChannelOnChannelProxyConnectedHandler (string channelId, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed)

枚举类型说明

◆ VIDEO_RENDER_MODE

enum agora_gaming_rtc.VIDEO_RENDER_MODE

strong

视频渲染模式。

枚举值
RENDER_RAWDATA	100: （默认）RAWDATA。
REDNER_OPENGL_ES2	101: OpenGLES 2。
RENDER_UNITY_LOW_LEVEL_INTERFACE	102: Unity 底层接口。

◆ ERROR_CODE

enum agora_gaming_rtc.ERROR_CODE

strong

错误码。更多错误码描述见 Error Code。

枚举值
ERROR_NOT_INIT_ENGINE	-7: SDK 尚未初始化，就调用其 API。请确认在调用 API 之前已创建 IRtcEngine 对象并完成初始化。
ERROR_OK	0: 没有错误。
ERROR_INVALID_ARGUMENT	-2: API 调用了无效的参数。例如指定的频道名含有非法字符。
ERROR_NO_DEVICE_PLUGIN	-100: 未插入设备。

◆ REMOTE_VIDEO_STREAM_TYPE

enum agora_gaming_rtc.REMOTE_VIDEO_STREAM_TYPE

strong

视频流类型，视频流大小。

枚举值
REMOTE_VIDEO_STREAM_HIGH	0: 视频大流。
REMOTE_VIDEO_STREAM_LOW	1: 视频小流。

◆ REMOTE_VIDEO_STATE

enum agora_gaming_rtc.REMOTE_VIDEO_STATE

strong

远端视频流状态。

枚举值
REMOTE_VIDEO_STATE_STOPPED	0: 远端视频默认初始状态。在 `REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED(3)`、`REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)` 或 `REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE(7)` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_STARTING	1: 本地用户已接收远端视频首包。
REMOTE_VIDEO_STATE_DECODING	2: 远端视频流正在解码，正常播放。在 `REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY(2)`、`REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED(4)`、`REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)` 或 `REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY(9)` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_FROZEN	3: 远端视频流卡顿。在 `REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION(1)` 或 `REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK(8)` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_FAILED	4: 远端视频流播放失败。在 `REMOTE_VIDEO_STATE_REASON_INTERNAL(0)` 的情况下，会报告该状态。

◆ AUDIO_MIXING_REASON_TYPE

enum agora_gaming_rtc.AUDIO_MIXING_REASON_TYPE

strong

自从: v3.4.2

音乐文件播放状态改变的原因。在 OnAudioMixingStateChangedHandler 回调中报告。

枚举值
AUDIO_MIXING_REASON_CAN_NOT_OPEN	701: 音乐文件打开出错。例如，本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL。
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL	702: 音乐文件打开太频繁。如需多次调用 startAudioMixing，请确保调用间隔大于 500 ms。
AUDIO_MIXING_REASON_INTERRUPTED_EOF	703: 音乐文件播放中断。
AUDIO_MIXING_REASON_STARTED_BY_USER	720: 成功调用 startAudioMixing 播放音乐文件。
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED	721: 音乐文件完成一次循环播放。
AUDIO_MIXING_REASON_START_NEW_LOOP	722: 音乐文件开始新的一次循环播放。
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED	723: 音乐文件完成所有循环播放。
AUDIO_MIXING_REASON_STOPPED_BY_USER	724: 成功调用 stopAudioMixing 停止播放音乐文件。
AUDIO_MIXING_REASON_PAUSED_BY_USER	725: 成功调用 pauseAudioMixing 暂停播放音乐文件。
AUDIO_MIXING_REASON_RESUMED_BY_USER	726: 成功调用 resumeAudioMixing 恢复播放音乐文件。

◆ USER_OFFLINE_REASON

enum agora_gaming_rtc.USER_OFFLINE_REASON

strong

用户离线原因。

枚举值
QUIT	0: 用户主动离开。
DROPPED	1: 因过长时间收不到对方数据包，超时掉线。注意：由于 SDK 使用的是不可靠通道，也有可能对方主动离开本方没收到对方离开消息而误判为超时掉线。
BECOME_AUDIENCE	2: （直播场景中）用户身份从主播切换为观众时触发。

◆ LOG_FILTER

enum agora_gaming_rtc.LOG_FILTER

strong

日志过滤分级

枚举值
OFF	0: 不输出日志信息。
DEBUG	0x80f: 输出所有 API 日志信息。如果你想获取最完整的日志，可以将日志级别设为该等级。
INFO	0x0f: 输出 CRITICAL、ERROR、WARNING 和 INFO 级别的日志信息。我们推荐你将日志级别设为该等级。
WARNING	0x0e: 输出 CRITICAL、ERROR 和 WARNING 级别的日志信息。
ERROR	0x0c: 输出 CRITICAL 和 ERROR 级别的日志信息。
CRITICAL	0x08: 输出 CRITICAL 级别的日志信息。

◆ CHANNEL_PROFILE

enum agora_gaming_rtc.CHANNEL_PROFILE

strong

频道场景。

枚举值

枚举值
CHANNEL_PROFILE_COMMUNICATION	0: 通信场景 (默认)。该场景下，频道内所有用户都可以发布和接收音、视频流。适用于语音通话、视频群聊等应用场景。
CHANNEL_PROFILE_LIVE_BROADCASTING	1: 直播场景。该场景有主播和观众两种用户角色，可以通过 SetClientRole 设置。主播可以发布和接收音视频流，观众直接接收流。适用于语聊房、视频直播、互动大班课等应用场景。
CHANNEL_PROFILE_GAME	2: 游戏语音场景。频道内任何用户可自由发言。该模式下默认使用低功耗低码率的编解码器。 @note 声网不推荐使用该场景。

CHANNEL_PROFILE_COMMUNICATION

0: 通信场景 (默认)。该场景下，频道内所有用户都可以发布和接收音、视频流。适用于语音通话、视频群聊等应用场景。

CHANNEL_PROFILE_LIVE_BROADCASTING

1: 直播场景。该场景有主播和观众两种用户角色，可以通过 SetClientRole 设置。主播可以发布和接收音视频流，观众直接接收流。适用于语聊房、视频直播、互动大班课等应用场景。

CHANNEL_PROFILE_GAME

2: 游戏语音场景。频道内任何用户可自由发言。该模式下默认使用低功耗低码率的编解码器。

   @note 声网不推荐使用该场景。

◆ CLIENT_ROLE_TYPE

enum agora_gaming_rtc.CLIENT_ROLE_TYPE

strong

直播场景里的用户角色。

枚举值
CLIENT_ROLE_BROADCASTER	1: 主播，可以发布和接收音视频流。
CLIENT_ROLE_AUDIENCE	2: 观众，默认角色，只能接收音视频流，无法发布。

◆ AUDIO_RECORDING_QUALITY_TYPE

enum agora_gaming_rtc.AUDIO_RECORDING_QUALITY_TYPE

strong

录音音质。在 StartAudioRecording 中设置。

枚举值
AUDIO_RECORDING_QUALITY_LOW	0: 低音质。例如，采样率为 32000 Hz，录音时长为 10 分钟的 AAC 文件大小约为 1.2 M。
AUDIO_RECORDING_QUALITY_MEDIUM	1:（默认）中音质。例如，采样率为 32000 Hz，录音时长为 10 分钟的 AAC 文件大小约为 2 M。
AUDIO_RECORDING_QUALITY_HIGH	2: 高音质。例如，采样率为 32000 Hz，录音时长为 10 分钟的 AAC 文件大小约为 3.75 M。
AUDIO_RECORDING_QUALITY_ULTRA_HIGH	3: 超高音质。例如，采样率为 32000 Hz，录音时长为 10 分钟的 AAC 文件大小约为 7.5 M。

◆ AUDIO_ROUTE

enum agora_gaming_rtc.AUDIO_ROUTE

strong

当前的音频路由。在 OnAudioRouteChangedHandler 回调中报告。

枚举值
AUDIO_ROUTE_DEFAULT	-1: 使用默认的语音路由。
AUDIO_ROUTE_HEADSET	0: 音频路由为带麦克风的耳机。
AUDIO_ROUTE_EARPIECE	1: 音频路由为听筒。
AUDIO_ROUTE_HEADSET_NO_MIC	2: 音频路由为不带麦克风的耳机。
AUDIO_ROUTE_SPEAKERPHONE	3: 音频路由为设备自带的扬声器。
AUDIO_ROUTE_LOUDSPEAKER	4: 音频路由为外接的扬声器（仅适用于 iOS 和 macOS）
AUDIO_ROUTE_BLUETOOTH	5: 音频路由为蓝牙耳机。
AUDIO_ROUTE_HDMI	7: 音频路由为 HDMI 外围设备（仅适用于 macOS）
AUDIO_ROUTE_DISPLAYPORT	8: 音频路由为 DisplayPort 外围设备（仅适用于 macOS）
AUDIO_ROUTE_AIRPLAY	9: 音频路由为 Apple AirPlay（仅适用于 iOS 和 macOS）

◆ CONNECTION_STATE_TYPE

enum agora_gaming_rtc.CONNECTION_STATE_TYPE

strong

网络连接状态。

枚举值
CONNECTION_STATE_DISCONNECTED	1: 网络连接断开。调用 JoinChannelByKey 加入频道前的初始化阶段；或调用 LeaveChannel 后的离开频道阶段。
CONNECTION_STATE_CONNECTING	2: 建立网络连接中。该状态表示 SDK 在调用 JoinChannelByKey 后正在与指定的频道建立连接。如果成功加入频道，App 会收到 OnConnectionStateChangedHandler 回调，通知当前网络状态变成 `CONNECTION_STATE_CONNECTED(3)`。建立连接后，SDK 还会初始化媒体，一切就绪后会回调 OnJoinChannelSuccessHandler。
CONNECTION_STATE_CONNECTED	3: 网络已连接。该状态表示用户已经加入频道，可以在频道内发布或订阅媒体流。如果因网络断开或切换而导致 SDK 与频道的连接中断，SDK 会自动重连，此时应用程序会收到： OnConnectionInterruptedHandler 回调（已废弃）。同时会收到 OnConnectionStateChangedHandler：通知当前网络状态变成 `CONNECTION_STATE_RECONNECTING(4)`。
CONNECTION_STATE_RECONNECTING	4: 重新建立网络连接中。该状态表示 SDK 之前曾加入过频道，但因网络等原因连接中断了，此时 SDK 会自动尝试重新接入频道。如果 SDK 无法在 10 秒内重新加入频道，则 OnConnectionLostHandler 会被触发，SDK 会一直保持在 `CONNECTION_STATE_RECONNECTING(4)` 的状态，并不断尝试重新加入频道。如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，则应用程序会收到 OnConnectionStateChangedHandler 回调，通知的网络状态进入 `CONNECTION_STATE_FAILED(5)`，SDK 停止尝试重连。
CONNECTION_STATE_FAILED	5: 网络连接失败。该状态表示 SDK 已不再尝试重新加入频道，用户必须要调用 LeaveChannel 离开频道。如果用户还想重新加入频道，则需要再次调用 JoinChannelByKey。如果 SDK 因服务器端使用 RESTful API 禁止加入频道，则应用程序会收到 OnConnectionBannedHandler 回调（已废弃）和 OnConnectionStateChangedHandler 回调。

◆ CONNECTION_CHANGED_REASON_TYPE

enum agora_gaming_rtc.CONNECTION_CHANGED_REASON_TYPE

strong

引起网络连接状态发生改变的原因。

枚举值
CONNECTION_CHANGED_CONNECTING	0: 建立网络连接中。
CONNECTION_CHANGED_JOIN_SUCCESS	1: 成功加入频道。
CONNECTION_CHANGED_INTERRUPTED	2: 网络连接中断。
CONNECTION_CHANGED_BANNED_BY_SERVER	3: 网络连接被服务器禁止。可能服务端踢人场景时会报这个错。
CONNECTION_CHANGED_JOIN_FAILED	4: 加入频道失败。SDK 在尝试加入频道 20 分钟后还是没能加入频道，会返回该状态，并停止尝试重连。
CONNECTION_CHANGED_LEAVE_CHANNEL	5: 离开频道。
CONNECTION_CHANGED_INVALID_APP_ID	6: 不是有效的 APP ID。请更换有效的 APP ID 重新加入频道。
CONNECTION_CHANGED_INVALID_CHANNEL_NAME	7: 不是有效的频道名。请更换有效的频道名重新加入频道。
CONNECTION_CHANGED_INVALID_TOKEN	8: 生成的 Token 无效。一般有以下原因：在控制台上启用了 App Certificate，但加入频道未使用 Token。当启用了 App Certificate，必须使用 Token。在调用 JoinChannelByKey 加入频道时指定的 `uid` 与生成 Token 时传入的 `uid` 不一致。
CONNECTION_CHANGED_TOKEN_EXPIRED	9: 当前使用的 Token 过期，不再有效，需要重新在你的服务端申请生成 Token。
CONNECTION_CHANGED_REJECTED_BY_SERVER	10: 此用户被服务器禁止。一般有以下原因：用户已进入频道，再次调用加入频道的 API，例如 JoinChannelByKey，会返回此状态。停止调用该方法即可。用户在调用 StartEchoTest 进行通话测试时尝试加入频道。等待通话测试结束后再加入频道即可。
CONNECTION_CHANGED_SETTING_PROXY_SERVER	11: 由于设置了代理服务器，SDK 尝试重连。
CONNECTION_CHANGED_RENEW_TOKEN	12: 更新 Token 引起网络连接状态改变。
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED	13: 客户端 IP 地址变更，可能是由于网络类型，或网络运营商的 IP 或端口发生改变引起。
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT	14: SDK 和服务器连接保活超时，进入自动重连状态 `CONNECTION_STATE_RECONNECTING(4)`。
CONNECTION_CHANGED_SAME_UID_LOGIN	19：使用相同的 UID 从不同的设备加入同一频道。自从 3.7.0
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS	20：频道内主播人数已达上限。自从 3.7.0 注解该枚举仅在开启 128 人功能后报告。主播人数的上限根据开启 128 人功能时实际配置的人数而定。

◆ STREAM_FALLBACK_OPTIONS

enum agora_gaming_rtc.STREAM_FALLBACK_OPTIONS

strong

音视频流回退处理选项。

枚举值
STREAM_FALLBACK_OPTION_DISABLED	0: 上行/下行网络较弱时，不对音视频流作回退处理，但不能保证音视频流的质量。
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW	1: 在下行网络条件较差时只接收视频小流（低分辨率、低码率视频流）。该选项只对 SetRemoteSubscribeFallbackOption 有效，对 SetLocalPublishFallbackOption 方法无效。
STREAM_FALLBACK_OPTION_AUDIO_ONLY	2: 上行/下行网络较弱时，先尝试只接收视频小流（低分辨率、低码率视频流）；如果网络环境无法显示视频，则再回退到只接收远端订阅的音频流。

◆ VideoContentHint

enum agora_gaming_rtc.VideoContentHint

strong

屏幕共享的内容类型。

枚举值
CONTENT_HINT_NONE	0: （默认）无指定的内容类型。
CONTENT_HINT_MOTION	1: 内容类型为动画。当共享的内容是视频、电影或视频游戏时，推荐选择该内容类型。
CONTENT_HINT_DETAILS	2: 内容类型为细节。当共享的内容是图片或文字时，推荐选择该内容类型。

◆ REMOTE_VIDEO_STATE_REASON

enum agora_gaming_rtc.REMOTE_VIDEO_STATE_REASON

strong

远端视频流状态切换原因。

枚举值
REMOTE_VIDEO_STATE_REASON_INTERNAL	0: 视频状态发生改变时，会报告该原因。
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION	1: 网络阻塞。
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY	2: 网络恢复正常。
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED	3: 本地用户停止接收远端视频流或本地用户禁用视频模块。
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED	4: 本地用户恢复接收远端视频流或本地用户启动视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED	5: 远端用户停止发送视频流或远端用户禁用视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED	6: 远端用户恢复发送视频流或远端用户启用视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE	7: 远端用户离开频道。
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK	8: 弱网情况下，远端音视频流回退为音频流。
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY	9: 网络情况改善时，远端音频流恢复为音视频流。
REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND	10: App 在后台运行。

◆ LOCAL_VIDEO_STREAM_STATE

enum agora_gaming_rtc.LOCAL_VIDEO_STREAM_STATE

strong

本地视频状态。

枚举值
LOCAL_VIDEO_STREAM_STATE_STOPPED	0: 本地视频默认初始状态。
LOCAL_VIDEO_STREAM_STATE_CAPTURING	1: 本地视频采集设备启动成功。调用 StartScreenCaptureByWindowId 方法共享窗口且共享窗口为最大化时，也会报告该状态。
LOCAL_VIDEO_STREAM_STATE_ENCODING	2: 本地视频首帧编码成功。
LOCAL_VIDEO_STREAM_STATE_FAILED	3: 本地视频启动失败。

◆ LOCAL_VIDEO_STREAM_ERROR

enum agora_gaming_rtc.LOCAL_VIDEO_STREAM_ERROR

strong

本地视频出错原因。

枚举值
LOCAL_VIDEO_STREAM_ERROR_OK	0: 本地视频状态正常。
LOCAL_VIDEO_STREAM_ERROR_FAILURE	1: 出错原因不明确。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION	2: 没有权限启动本地视频采集设备。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY	3: 本地视频采集设备正在使用中。
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE	4: 本地视频采集失败，建议检查采集设备是否正常工作。
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE	5: 本地视频编码失败。
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND	6: 仅适用于 iOS）应用处于后台。请提示用户应用处于后台时，无法正常进行视频采集。
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS	7: （仅支持 iOS）应用窗口处于侧拉、分屏、画中画模式。请提示用户应用窗口在侧拉、分屏、画中画模式时，无法正常进行视频采集。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND	8: 找不到本地视频采集设备。自从 v3.4.2
LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED	9: 本地视频设备已断开连接。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID	10: （仅 macOS 和 Windows）SDK 无法在视频设备列表中找到该视频设备。请检查视频设备 ID 是否有效。自从 v3.6.1.1
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED	11: 调用 StartScreenCaptureByWindowId 方法共享窗口时，共享窗口处于最小化的状态。
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED	12: 该错误码表示通过窗口 ID 共享的窗口已关闭，或通过窗口 ID 共享的全屏窗口已退出全屏。退出全屏模式后，远端用户将无法看到共享的窗口。为避免远端用户看到黑屏，声网建议你立即结束本次共享。报告该错误码的常见场景：本地用户关闭共享的窗口时，SDK 会报告该错误码。本地用户先放映幻灯片，然后共享放映中的幻灯片。结束放映时，SDK 会报告该错误码。本地用户先全屏观看网页视频或网页文档，然后共享网页视频或网页文档。结束全屏时，SDK 会报告该错误码。
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED	13: （仅 Windows）待共享的窗口被其他窗口遮挡住，被遮挡住的部分在共享时会被 SDK 涂黑。自从 v3.6.1.1
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED	20: （仅 Windows）SDK 不支持共享该类型的窗口。自从 v3.6.1.1

◆ AUDIO_RECORDING_POSITION

enum agora_gaming_rtc.AUDIO_RECORDING_POSITION

strong

录音内容。在 StartAudioRecording 中设置。

枚举值
AUDIO_RECORDING_POSITION_MIXED_RECORDING_AND_PLAYBACK	0:（默认）录制本地和所有远端用户混音后的音频。
AUDIO_RECORDING_POSITION_RECORDING	1: 仅录制本地用户的音频。
AUDIO_RECORDING_POSITION_MIXED_PLAYBACK	2: 仅录制所有远端用户的音频。

◆ MEDIA_DEVICE_TYPE

enum agora_gaming_rtc.MEDIA_DEVICE_TYPE

strong

设备类型定义。

枚举值
UNKNOWN_AUDIO_DEVICE	-1: 设备类型未知。
AUDIO_PLAYOUT_DEVICE	0: 音频播放设备。
AUDIO_RECORDING_DEVICE	1: 音频采集设备。
VIDEO_RENDER_DEVICE	2: 视频渲染设备。
VIDEO_CAPTURE_DEVICE	3: 视频采集设备。
AUDIO_APPLICATION_PLAYOUT_DEVICE	4: 音频应用播放设备。

◆ RAW_AUDIO_FRAME_OP_MODE_TYPE

enum agora_gaming_rtc.RAW_AUDIO_FRAME_OP_MODE_TYPE

strong

指定 OnRecordAudioFrameHandler 和 OnPlaybackAudioFrameHandler 回调的使用模式。

枚举值
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY	0: 只读模式，用户仅从 AudioFrame 获取原始数据，不作任何修改。例如: 若用户通过 Unity SDK 采集数据，自己进行 RTMP 推流，则可以选择该模式。
RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY	1: 只写模式，用户替换 AudioFrame 中的数据以供 SDK 编码传输。例如: 若用户自行采集数据，可选择该模式。
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE	2: 读写模式, 用户从 AudioFrame 获取并修改数据、修改，并返回给 SDK 进行编码传输。例如: 若用户自己有音效处理模块，且想要根据实际需要对数据进行前处理(例如变声)，则可以选择该模式。

◆ AUDIO_PROFILE_TYPE

enum agora_gaming_rtc.AUDIO_PROFILE_TYPE

strong

音频属性。

设置采样率，码率，编码模式和声道数。

枚举值
AUDIO_PROFILE_DEFAULT	0: 默认设置。通信场景下： Windows: 16 KHz 采样率，语音编码，单声道，编码码率最大值为 16 Kbps。 Android/iOS/macOS: 32 KHz 采样率，语音编码，单声道，编码码率最大值为 18 Kbps。直播场景下：全平台为 48 KHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。
AUDIO_PROFILE_SPEECH_STANDARD	1: 指定 32 kHz 采样率，语音编码，单声道，编码码率最大值为 18 Kbps。
AUDIO_PROFILE_MUSIC_STANDARD	2: 指定 48 kHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。
AUDIO_PROFILE_MUSIC_STANDARD_STEREO	3: 指定 48 kHz 采样率，音乐编码，双声道，编码码率最大值为 80 Kbps。
AUDIO_PROFILE_MUSIC_HIGH_QUALITY	4: 指定 48 kHz 采样率，音乐编码，单声道，编码码率最大值为 96 Kbps。
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO	5: 指定 48 kHz 采样率，音乐编码，双声道，编码码率最大值为 128 Kbps。
AUDIO_PROFILE_IOT	6: 指定 16 kHz 采样率，语音编码，单声道，应用回声消除算法 AES。
AUDIO_PROFILE_NUM	枚举的数量。

◆ AUDIO_SCENARIO_TYPE

enum agora_gaming_rtc.AUDIO_SCENARIO_TYPE

strong

设置音频应用场景。

枚举值
AUDIO_SCENARIO_DEFAULT	0: 默认的音频应用场景。
AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT	1: 娱乐场景，适用于用户需要频繁上下麦的场景。
AUDIO_SCENARIO_EDUCATION	2: 教育场景，适用于需要高流畅度和稳定性的场景。
AUDIO_SCENARIO_GAME_STREAMING	3: 高音质语聊房场景，适用于音乐为主的场景。
AUDIO_SCENARIO_SHOWROOM	4: 秀场场景，适用于需要高音质的单主播场景。
AUDIO_SCENARIO_CHATROOM_GAMING	5: 游戏开黑场景，适用于只有人声的场景。
AUDIO_SCENARIO_IOT	6: IoT（物联网）场景，适用于使用低功耗 IoT 设备的场景。
AUDIO_SCENARIO_MEETING	8: 会议场景，适用于人声为主的多人会议。自从 v3.2.0
AUDIO_SCENARIO_NUM	枚举的数量。

◆ VIDEO_CODEC_PROFILE_TYPE

enum agora_gaming_rtc.VIDEO_CODEC_PROFILE_TYPE

strong

用于旁路推流的输出视频的编解码规格。

枚举值
VIDEO_CODEC_PROFILE_BASELINE	66: Baseline 级别的视频编码规格，一般用于低阶或需要额外容错的应用，比如视频通话、手机视频等。
VIDEO_CODEC_PROFILE_MAIN	77: Main 级别的视频编码规格，一般用于主流消费类电子产品，如 mp4、便携的视频播放器、PSP 和 iPad 等。
VIDEO_CODEC_PROFILE_HIGH	100: （默认）High 级别的视频编码规格，一般用于广播及视频碟片存储，高清电视。

◆ AUDIO_SAMPLE_RATE_TYPE

enum agora_gaming_rtc.AUDIO_SAMPLE_RATE_TYPE

strong

用于旁路推流的输出音频的采样率。

枚举值
AUDIO_SAMPLE_RATE_32000	32000: 32 kHz
AUDIO_SAMPLE_RATE_44100	44100: 44.1 kHz
AUDIO_SAMPLE_RATE_48000	48000: 48 kHz

◆ AUDIO_MIXING_STATE_TYPE

enum agora_gaming_rtc.AUDIO_MIXING_STATE_TYPE

strong

音乐文件播放状态。在 OnAudioMixingStateChangedHandler 回调中报告。

枚举值
AUDIO_MIXING_STATE_PLAYING	710: 音乐文件正常播放。该状态可能由以下原因导致: `AUDIO_MIXING_REASON_STARTED_BY_USER(720)` `AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED(721)` `AUDIO_MIXING_REASON_START_NEW_LOOP(722)` `AUDIO_MIXING_REASON_RESUMED_BY_USER(726)`
AUDIO_MIXING_STATE_PAUSED	711: 音乐文件暂停播放。该状态由 `AUDIO_MIXING_REASON_PAUSED_BY_USER(725)` 原因导致。
AUDIO_MIXING_STATE_STOPPED	713: 音乐文件停止播放。该状态可能由以下原因导致： `AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED(723)` `AUDIO_MIXING_REASON_STOPPED_BY_USER(724)`
AUDIO_MIXING_STATE_FAILED	714: 音乐文件播放失败。该状态可能由以下原因导致： `AUDIO_MIXING_REASON_CAN_NOT_OPEN(701)` `AUDIO_MIXING_REASON_TOO_FREQUENT_CALL(702)` `AUDIO_MIXING_REASON_INTERRUPTED_EOF(703)`

◆ AUDIO_MIXING_ERROR_TYPE

enum agora_gaming_rtc.AUDIO_MIXING_ERROR_TYPE

strong

混音音乐文件错误码。

弃用:: 自 v3.4.2 废弃，请改用 AUDIO_MIXING_REASON_TYPE 。

枚举值
AUDIO_MIXING_ERROR_CAN_NOT_OPEN	701: 音乐文件打开出错。
AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL	702: 音乐文件打开太频繁。
AUDIO_MIXING_ERROR_INTERRUPTED_EOF	703: 音乐文件播放中断。
AUDIO_MIXING_ERROR_OK	0: 音乐文件状态正常。

◆ RTMP_STREAM_PUBLISH_STATE

enum agora_gaming_rtc.RTMP_STREAM_PUBLISH_STATE

strong

推流状态。

枚举值
RTMP_STREAM_PUBLISH_STATE_IDLE	0: 推流未开始或已结束。成功调用 RemovePublishStreamUrl 方法删除推流地址后，也会返回该状态。
RTMP_STREAM_PUBLISH_STATE_CONNECTING	1: 正在连接声网推流服务器和 RTMP 服务器。调用 AddPublishStreamUrl 方法后，会返回该状态。
RTMP_STREAM_PUBLISH_STATE_RUNNING	2: 推流正在进行。成功推流后，会返回该状态。
RTMP_STREAM_PUBLISH_STATE_RECOVERING	3: 正在恢复推流。当 CDN 出现异常，或推流短暂中断时，SDK 会自动尝试恢复推流，并返回该状态。如成功恢复推流，则进入状态 `RTMP_STREAM_PUBLISH_STATE_RUNNING(2)`。如服务器出错或 60 秒内未成功恢复，则进入状态 `RTMP_STREAM_PUBLISH_STATE_FAILURE(4)`。如果觉得 60 秒太长，也可以主动调用 RemovePublishStreamUrl 和 AddPublishStreamUrl 方法尝试重连。
RTMP_STREAM_PUBLISH_STATE_FAILURE	4: 推流失败。失败后，你可以通过返回的错误码排查错误原因，也可以再次调用 AddPublishStreamUrl 重新尝试推流。
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING	5: SDK 正在与声网推流服务器和 CDN 服务器断开连接。当你调用 `Remove` 或 `Stop` 方法正常结束推流时，SDK 会依次报告推流状态为 `DISCONNECTING`、`IDLE`。自从 v3.6.1.1

◆ RTMP_STREAM_PUBLISH_ERROR_TYPE

enum agora_gaming_rtc.RTMP_STREAM_PUBLISH_ERROR_TYPE

strong

推流错误信息。

枚举值
RTMP_STREAM_PUBLISH_ERROR_OK	0: 推流成功
RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT	1: 参数无效。请检查输入参数是否正确。例如如果你在调用 AddPublishStreamUrl 前没有调用 SetLiveTranscoding 设置转码参数，SDK 会返回该错误。
RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED	2: 推流已加密，不能推流
RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT	3: 推流超时未成功。可调用 AddPublishStreamUrl 重新推流。
RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR	4: 推流服务器出现错误。请调用 AddPublishStreamUrl 重新推流。
RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR	5: RTMP 服务器出现错误。
RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN	6: 推流请求过于频繁。
RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT	7: 单个主播的推流地址数目达到上线 10。请删掉一些不用的推流地址再增加推流地址。
RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED	8: 主播操作不属于自己的流。例如更新其他主播的流参数、停止其他主播的流。请检查 app 逻辑。
RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND	9: 服务器未找到这个流。
RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED	10: 推流地址格式有错误。请检查推流地址格式是否正确。
RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER	11: 用户角色不是主播，该用户无法使用推流功能。请检查你的应用代码逻辑。自从 v3.6.1.1
RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM	13: 非转码推流情况下，调用了 UpdateRtmpTranscoding 或 SetLiveTranscoding 方法更新转码属性。请检查你的应用代码逻辑。自从 v3.6.1.1
RTMP_STREAM_PUBLISH_ERROR_NET_DOWN	14: 主播的网络出错。自从 v3.6.1.1
RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID	15: 你的 App ID 没有使用声网推流服务的权限。请参考前提条件开启推流服务。自从 v3.6.1.1
RTMP_STREAM_UNPUBLISH_ERROR_OK	100: 推流已正常结束。当你调用 RemovePublishStreamUrl 结束推流后，SDK 会返回该值。自从 v3.4.5

◆ NETWORK_TYPE

enum agora_gaming_rtc.NETWORK_TYPE

strong

网络连接类型。

枚举值
NETWORK_TYPE_UNKNOWN	-1: 网络连接类型未知。
NETWORK_TYPE_DISCONNECTED	0: 网络连接已断开。
NETWORK_TYPE_LAN	1: 网络类型为 LAN。
NETWORK_TYPE_WIFI	2: 网络类型为 Wi-Fi (包含热点）。
NETWORK_TYPE_MOBILE_2G	3: 网络类型为 2G 移动网络。
NETWORK_TYPE_MOBILE_3G	4: 网络类型为 3G 移动网络。
NETWORK_TYPE_MOBILE_4G	5: 网络类型为 4G 移动网络。
NETWORK_TYPE_MOBILE_5G	6: 网络类型为 5G 移动网络。自从 v3.6.1.1

◆ VOICE_CHANGER_PRESET

enum agora_gaming_rtc.VOICE_CHANGER_PRESET

strong

预设的美声效果。

弃用:: 自 v3.2.0 废弃。请改用 VOICE_BEAUTIFIER_PRESET 。

枚举值
VOICE_CHANGER_OFF	原声，即关闭本地美声效果。
VOICE_CHANGER_OLDMAN	老男人，建议用于处理男声。
VOICE_CHANGER_BABYBOY	小男孩，建议用于处理男声。
VOICE_CHANGER_BABYGIRL	小女孩，建议用于处理女声。
VOICE_CHANGER_ZHUBAJIE	猪八戒。
VOICE_CHANGER_ETHEREAL	空灵。
VOICE_CHANGER_HULK	绿巨人。
VOICE_BEAUTY_VIGOROUS	浑厚。
VOICE_BEAUTY_DEEP	低沉。
VOICE_BEAUTY_MELLOW	圆润。
VOICE_BEAUTY_FALSETTO	假音。
VOICE_BEAUTY_FULL	饱满。
VOICE_BEAUTY_CLEAR	清澈。
VOICE_BEAUTY_RESOUNDING	高亢。
VOICE_BEAUTY_RINGING	嘹亮。
VOICE_BEAUTY_SPACIAL	空旷。
GENERAL_BEAUTY_VOICE_MALE_MAGNETIC	磁性（男）。此枚举为男声定制化效果，不适用于女声。如果女声使用此音效设置，则音频可能会产生失真。
GENERAL_BEAUTY_VOICE_FEMALE_FRESH	清新（女）。此枚举为女声定制化效果，不适用于男声。如果男声使用此音效设置，则音频可能会产生失真。
GENERAL_BEAUTY_VOICE_FEMALE_VITALITY	活力（女）。此枚举为女声定制化效果，不适用于男声。如果男声使用此音效设置，则音频可能会产生失真。

◆ AUDIO_REVERB_PRESET

enum agora_gaming_rtc.AUDIO_REVERB_PRESET

strong

预设的音效。

弃用:: 自 v3.2.0 废弃。请改用 AUDIO_EFFECT_PRESET 。

枚举值
AUDIO_REVERB_OFF	原声，即关闭本地音效。
AUDIO_REVERB_FX_KTV	KTV。
AUDIO_REVERB_FX_VOCAL_CONCERT	演唱会。
AUDIO_REVERB_FX_UNCLE	大叔。
AUDIO_REVERB_FX_SISTER	少女。
AUDIO_REVERB_FX_STUDIO	录音棚。
AUDIO_REVERB_FX_POPULAR	流行。
AUDIO_REVERB_FX_RNB	R&B。
AUDIO_REVERB_FX_PHONOGRAPH	留声机。
AUDIO_REVERB_POPULAR	流行（旧版）。
AUDIO_REVERB_RNB	R&B（旧版）。
AUDIO_REVERB_ROCK	摇滚。
AUDIO_REVERB_HIPHOP	嘻哈。
AUDIO_REVERB_VOCAL_CONCERT	演唱会（旧版）。
AUDIO_REVERB_KTV	KTV（旧版）。
AUDIO_REVERB_STUDIO	录音棚（旧版）。
AUDIO_VIRTUAL_STEREO	虚拟立体声。虚拟立体声是指将单声道的音轨渲染出立体声的效果，使频道内所有用户听到有空间感的声音效果。为达到更好的虚拟立体声效果，声网推荐在调用该方法前将 `SetAudioProfile` 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。

◆ AUDIO_EQUALIZATION_BAND_FREQUENCY

enum agora_gaming_rtc.AUDIO_EQUALIZATION_BAND_FREQUENCY

strong

语音音效均衡波段的中心频率。

枚举值
AUDIO_EQUALIZATION_BAND_31	0: 31 Hz
AUDIO_EQUALIZATION_BAND_62	1: 62 Hz
AUDIO_EQUALIZATION_BAND_125	2: 125 Hz
AUDIO_EQUALIZATION_BAND_250	3: 250 Hz
AUDIO_EQUALIZATION_BAND_500	4: 500 Hz
AUDIO_EQUALIZATION_BAND_1K	5: 1 kHz
AUDIO_EQUALIZATION_BAND_2K	6: 2 kHz
AUDIO_EQUALIZATION_BAND_4K	7: 4 kHz
AUDIO_EQUALIZATION_BAND_8K	8: 8 kHz
AUDIO_EQUALIZATION_BAND_16K	9: 16 kHz

◆ QUALITY_ADAPT_INDICATION

enum agora_gaming_rtc.QUALITY_ADAPT_INDICATION

strong

自上次统计后本地视频质量的自适应情况（基于目标帧率和目标码率）。

枚举值
ADAPT_NONE	本地视频质量不变。
ADAPT_UP_BANDWIDTH	因网络带宽增加，本地视频质量改善。
ADAPT_DOWN_BANDWIDTH	因网络带宽减少，本地视频质量变差。

◆ AUDIO_REVERB_TYPE

enum agora_gaming_rtc.AUDIO_REVERB_TYPE

strong

各混响音效 Key 所对应的值。

枚举值
AUDIO_REVERB_DRY_LEVEL	0: 取值范围 [-20,10]，单位为 dB, 原始声音强度，即所谓的 dry signal。
AUDIO_REVERB_WET_LEVEL	1: 取值范围 [-20,10]，单位为 dB, 早期反射信号强度，即所谓的 wet signal。
AUDIO_REVERB_ROOM_SIZE	2: 所需混响效果的房间尺寸，一般房间越大，混响越强，取值范围 [0,100]。
AUDIO_REVERB_WET_DELAY	3: 取值范围 [0,200]，单位为毫秒, wet signal 的初始延迟长度，以毫秒为单位。
AUDIO_REVERB_STRENGTH	4: 取值范围 [0,100], 混响持续的强度。

◆ AUDIO_CODEC_PROFILE_TYPE

enum agora_gaming_rtc.AUDIO_CODEC_PROFILE_TYPE

strong

用于旁路推流的输出音频的编解码规格，默认为 LC-AAC。

枚举值

AUDIO_CODEC_PROFILE_LC_AAC

0: LC-AAC 规格，表示基本音频编码规格。

AUDIO_CODEC_PROFILE_HE_AAC

1: HE-AAC 规格，表示高效音频编码规格。

AUDIO_CODEC_PROFILE_HE_AAC_V2

2: HE-AAC v2 规格。

自从: v3.6.1.1

◆ VIDEO_CODEC_TYPE

enum agora_gaming_rtc.VIDEO_CODEC_TYPE

strong

视频编码格式。

枚举值
VIDEO_CODEC_VP8	1: 标准 VP8。
VIDEO_CODEC_H264	2: 标准 H264。
VIDEO_CODEC_EVP	3: 增强 VP8。
VIDEO_CODEC_E264	4: 增强 H264。

◆ AREA_CODE

enum agora_gaming_rtc.AREA_CODE : uint

strong

访问区域。

枚举值
AREA_CODE_CN	中国大陆。
AREA_CODE_NA	北美区域。
AREA_CODE_EUR	欧洲区域。
AREA_CODE_AS	亚洲区域（中国大陆除外）。
AREA_CODE_JP	日本。
AREA_CODE_IN	印度。
AREA_CODE_GLOBAL	（默认）全球。

◆ LOG_LEVEL

enum agora_gaming_rtc.LOG_LEVEL

strong

日志输出级别。

自从: v3.3.1

枚举值
LOG_LEVEL_NONE	0: 不输出任何日志。
LOG_LEVEL_INFO	0x0001: (默认) 输出 `FATAL`、`ERROR`、`WARN`、`INFO` 级别的日志。我们推荐你将日志级别设为该等级。
LOG_LEVEL_WARN	0x0002: 仅输出 `FATAL`、`ERROR`、`WARN` 级别的日志。
LOG_LEVEL_ERROR	0x0004: 仅输出 `FATAL`、`ERROR` 级别的日志。
LOG_LEVEL_FATAL	0x0008: 仅输出 `FATAL` 级别的日志。

◆ FRAME_RATE

enum agora_gaming_rtc.FRAME_RATE

strong

视频帧率。

枚举值
FRAME_RATE_FPS_1	1: 1 fps
FRAME_RATE_FPS_7	7: 7 fps
FRAME_RATE_FPS_10	10: 10 fps
FRAME_RATE_FPS_15	15: 15 fps
FRAME_RATE_FPS_24	24: 24 fps
FRAME_RATE_FPS_30	30: 30 fps
FRAME_RATE_FPS_60	60: 60 fps，仅适用于 WINDOWS 和 macOS 平台。

◆ ORIENTATION_MODE

enum agora_gaming_rtc.ORIENTATION_MODE

strong

视频编码的方向模式。

枚举值

ORIENTATION_MODE_ADAPTIVE

0: （默认）该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转。该模式适用于接收端可以调整视频方向的场景。

如果采集的视频是横屏模式，则输出的视频也是横屏模式；
如果采集的视频是竖屏模式，则输出的视频也是竖屏模式。

ORIENTATION_MODE_FIXED_LANDSCAPE

1: 该模式下 SDK 固定输出风景（横屏）模式的视频。如果采集到的视频是竖屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用旁路推流场景下。

ORIENTATION_MODE_FIXED_PORTRAIT

2: 该模式下 SDK 固定输出人像（竖屏）模式的视频，如果采集到的视频是横屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用旁路推流场景下。

◆ DEGRADATION_PREFERENCE

enum agora_gaming_rtc.DEGRADATION_PREFERENCE

strong

带宽受限时的视频编码降级偏好。

枚举值

MAINTAIN_QUALITY

0:（默认）带宽受限时，视频编码时优先降低视频帧率，维持视频质量不变。该降级偏好适用于画质优先的场景。

注解: 通信（COMMUNICATION）场景下，本地发送的视频分辨率可能改变，远端用户需能处理这种情况，详见 OnVideoSizeChangedHandler。

MAINTAIN_FRAMERATE

1: 带宽受限时，视频编码时优先降低视频质量，维持视频帧率不变。该降级偏好适用于流畅性优先且允许画质降低的场景。

MAINTAIN_BALANCED

2: 带宽受限时，视频编码时同时降低视频帧率和视频质量。 MAINTAIN_BALANCED 降幅比 MAINTAIN_QUALITY 和 MAINTAIN_FRAMERATE 降幅更低，适用于流畅性和画质均优先的场景。

注解: 本地发送的视频分辨率可能改变，远端用户需能处理这种情况，详见 OnVideoSizeChangedHandler。

◆ VIDEO_FRAME_TYPE

enum agora_gaming_rtc.VIDEO_FRAME_TYPE

strong

视频帧类型。仅支持 FRAME_TYPE_RGBA。

枚举值
FRAME_TYPE_YUV420	0: YUV420
FRAME_TYPE_RGBA	1: RGBA

◆ VIDEO_MIRROR_MODE_TYPE

enum agora_gaming_rtc.VIDEO_MIRROR_MODE_TYPE

strong

镜像模式类型。

枚举值
VIDEO_MIRROR_MODE_AUTO	0:（默认）SDK 启用镜像模式。
VIDEO_MIRROR_MODE_ENABLED	1: 启用镜像模式。
VIDEO_MIRROR_MODE_DISABLED	2: 关闭镜像模式。

◆ AUDIO_FRAME_TYPE

enum agora_gaming_rtc.AUDIO_FRAME_TYPE

strong

音频帧类型。

枚举值
FRAME_TYPE_PCM16	0: PCM16

◆ MEDIA_SOURCE_TYPE

enum agora_gaming_rtc.MEDIA_SOURCE_TYPE

strong

弃用:: 音频采集设备类型。

枚举值
AUDIO_PLAYOUT_SOURCE	0: 音频播放设备。
AUDIO_RECORDING_SOURCE	1: 音频采集设备。

◆ LASTMILE_PROBE_RESULT_STATE

enum agora_gaming_rtc.LASTMILE_PROBE_RESULT_STATE

strong

Last mile 质量探测结果的状态。

枚举值
LASTMILE_PROBE_RESULT_COMPLETE	1: 表示本次 last mile 质量探测的结果是完整的。
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE	2: 表示本次 last mile 质量探测未进行带宽预测，因此结果不完整。一个可能的原因是测试资源暂时受限。
LASTMILE_PROBE_RESULT_UNAVAILABLE	3: 未进行 last mile 质量探测。一个可能的原因是网络连接中断。

◆ CAMERA_DIRECTION

enum agora_gaming_rtc.CAMERA_DIRECTION

strong

摄像头方向。

枚举值
CAMERA_REAR	0: 后置摄像头。
CAMERA_FRONT	1: 前置摄像头。

◆ CAPTURER_OUTPUT_PREFERENCE

enum agora_gaming_rtc.CAPTURER_OUTPUT_PREFERENCE

strong

摄像头采集配置。

枚举值
CAPTURER_OUTPUT_PREFERENCE_AUTO	0: （默认）自动调整采集参数。SDK 根据实际的采集设备性能及网络情况，选择合适的摄像头输出参数，在设备性能及视频预览质量之间，维持平衡。
CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE	1: 优先保证设备性能。SDK 根据用户在 SetVideoEncoderConfiguration 中设置编码器的分辨率和帧率，选择最接近的摄像头输出参数，从而保证设备性能。在这种情况下，预览质量接近于编码器的输出质量。
CAPTURER_OUTPUT_PREFERENCE_PREVIEW	2: 中设置编码器的分辨率和帧率，选择最接近的摄像头输出参数，从而保证设备性能。在这种情况下，预览质量接近于编码器的输出质量。
CAPTURER_OUTPUT_PREFERENCE_MANUAL	3: 允许用户设置本地摄像头采集的视频宽高。自从 v3.3.1

◆ QUALITY_TYPE

enum agora_gaming_rtc.QUALITY_TYPE

strong

网络质量。

枚举值
QUALITY_UNKNOWN	0: 网络质量未知。
QUALITY_EXCELLENT	1: 网络质量极好。
QUALITY_GOOD	2: 用户主观感觉和 `QUALITY_EXCELLENT` 差不多，但码率可能略低于 `QUALITY_EXCELLENT`
QUALITY_POOR	3: 用户主观感受有瑕疵但不影响沟通。
QUALITY_BAD	4: 勉强能沟通但不顺畅。
QUALITY_VBAD	5: 网络质量非常差，基本不能沟通。
QUALITY_DOWN	6: 完全无法沟通。
QUALITY_UNSUPPORTED	7: 暂时无法检测网络质量（未使用）。
QUALITY_DETECTING	8: 网络质量检测已开始还没完成。

◆ MEDIA_DEVICE_STATE_TYPE

enum agora_gaming_rtc.MEDIA_DEVICE_STATE_TYPE

strong

设备状态。

枚举值
MEDIA_DEVICE_STATE_IDLE	0: 设备处于空闲状态。自从 v3.4.5
MEDIA_DEVICE_STATE_ACTIVE	1: 设备正在使用。自从 v3.4.5 Note 3.4.5 之前的版本中，`MEDIA_DEVICE_STATE_ACTIVE (1)` 表示设备处于空闲状态。
MEDIA_DEVICE_STATE_DISABLED	2: 设备被禁用。
MEDIA_DEVICE_STATE_NOT_PRESENT	4: 没有此设备。
MEDIA_DEVICE_STATE_UNPLUGGED	8: 设备被拔出。
MEDIA_DEVICE_STATE_UNRECOMMENDED	9: 不推荐使用该设备。

◆ PRIORITY_TYPE

enum agora_gaming_rtc.PRIORITY_TYPE

strong

远端用户的需求优先级。如果将某个用户的优先级设为高，那么发给这个用户的音视频流的优先级就会高于其他用户。

枚举值
PRIORITY_HIGH	50: 用户需求优先级为高。
PRIORITY_NORMAL	100: （默认）用户需求优先级为正常。

◆ LOCAL_AUDIO_STREAM_STATE

enum agora_gaming_rtc.LOCAL_AUDIO_STREAM_STATE

strong

本地音频状态。

枚举值
LOCAL_AUDIO_STREAM_STATE_STOPPED	0: 本地音频默认初始状态。
LOCAL_AUDIO_STREAM_STATE_RECORDING	1: 本地音频采集设备启动成功。
LOCAL_AUDIO_STREAM_STATE_ENCODING	2: 本地音频首帧编码成功。
LOCAL_AUDIO_STREAM_STATE_FAILED	3: 本地音频启动失败。

◆ LOCAL_AUDIO_STREAM_ERROR

enum agora_gaming_rtc.LOCAL_AUDIO_STREAM_ERROR

strong

本地音频出错原因。

枚举值
LOCAL_AUDIO_STREAM_ERROR_OK	0: 本地音频状态正常。
LOCAL_AUDIO_STREAM_ERROR_FAILURE	1: 本地音频出错原因不明确。
LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION	2: 没有权限启动本地音频采集设备。
LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY	3: 本地音频采集设备已经在使用中。
LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE	4: 本地音频采集失败，建议你检查采集设备是否正常工作。
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE	5: 本地音频编码失败。
LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE	6: 无本地音频采集设备。自从 v3.4.2
LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE	7: 无本地音频播放设备。自从 v3.4.2
LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED	8: 本地音频采集被系统电话中断。
LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID	9: 本地音频采集设备的 ID 无效。自从 v3.6.1.1
LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID	10: 本地音频播放设备的 ID 无效。自从 v3.6.1.1

◆ REMOTE_AUDIO_STATE

enum agora_gaming_rtc.REMOTE_AUDIO_STATE

strong

远端音频流状态。

枚举值
REMOTE_AUDIO_STATE_STOPPED	0: 远端音频流默认初始状态。在 `REMOTE_AUDIO_REASON_LOCAL_MUTED(3)`、 `REMOTE_AUDIO_REASON_REMOTE_MUTED(5)` 或 `REMOTE_AUDIO_REASON_REMOTE_OFFLINE(7)` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_STARTING	1: 本地用户已接收远端音频首包。
REMOTE_AUDIO_STATE_DECODING	2: 远端音频流正在解码，正常播放。在 `REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2)`、 `REMOTE_AUDIO_REASON_LOCAL_UNMUTED`(4)`或` REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6)` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_FROZEN	3: 远端音频流卡顿。在 `REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1)` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_FAILED	4: 远端音频流播放失败。在 `REMOTE_AUDIO_REASON_INTERNAL(0)` 的情况下，会报告该状态。

◆ REMOTE_AUDIO_STATE_REASON

enum agora_gaming_rtc.REMOTE_AUDIO_STATE_REASON

strong

远端音频流状态改变的具体原因。

枚举值
REMOTE_AUDIO_REASON_INTERNAL	0: 音频状态发生改变时，会报告该原因。
REMOTE_AUDIO_REASON_NETWORK_CONGESTION	1: 网络阻塞。
REMOTE_AUDIO_REASON_NETWORK_RECOVERY	2: 网络恢复正常。
REMOTE_AUDIO_REASON_LOCAL_MUTED	3: 本地用户停止接收远端音频流或本地用户禁用音频模块。
REMOTE_AUDIO_REASON_LOCAL_UNMUTED	4: 本地用户恢复接收远端音频流或本地用户启用音频模块。
REMOTE_AUDIO_REASON_REMOTE_MUTED	5: 远端用户停止发送音频流或远端用户禁用音频模块。
REMOTE_AUDIO_REASON_REMOTE_UNMUTED	6: 远端用户恢复发送音频流或远端用户启用音频模块。
REMOTE_AUDIO_REASON_REMOTE_OFFLINE	7: 远端用户离开频道。

◆ AUDIO_SESSION_OPERATION_RESTRICTION

enum agora_gaming_rtc.AUDIO_SESSION_OPERATION_RESTRICTION

strong

音频会话控制权限。

枚举值
AUDIO_SESSION_OPERATION_RESTRICTION_NONE	没有限制，SDK 可以完全控制 Audio Session 操作。
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY	SDK 不能更改 Audio Session 的 category。
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION	SDK 不能更改 Audio Session 的 category，mode，categoryOptions。
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION	离开某个频道时，SDK 会保持 Audio Session 处于活动状态。
AUDIO_SESSION_OPERATION_RESTRICTION_ALL	限制 SDK 对 Audio Session 进行任何操作，SDK 将不能再对 Audio Session 进行任何配置。

◆ CHANNEL_MEDIA_RELAY_EVENT

enum agora_gaming_rtc.CHANNEL_MEDIA_RELAY_EVENT

strong

跨频道媒体流转发事件码。

枚举值
RELAY_EVENT_NETWORK_DISCONNECTED	0: 网络中断导致用户与服务器连接断开。
RELAY_EVENT_NETWORK_CONNECTED	1: 用户与服务器建立连接。
RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL	2: 用户已加入源频道。
RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL	3: 用户已加入目标频道。
RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL	4: SDK 开始向目标频道发送数据包。
RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC	5: 服务器收到了频道发送的视频流。
RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC	6: 服务器收到了频道发送的音频流。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL	7: 目标频道已更新。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED	8: 内部原因导致目标频道更新失败。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE	9: 目标频道未发生改变，即目标频道更新失败。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL	10: 目标频道名为 NULL。
RELAY_EVENT_VIDEO_PROFILE_UPDATE	11: 视频属性已发送至服务器。
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS	12: 成功暂停向目标频道转发媒体流。自从 v3.6.1.1
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED	13: 暂停向目标频道转发媒体流失败。自从 v3.6.1.1
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS	14: 成功恢复向目标频道转发媒体流。自从 v3.6.1.1
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED	15: 恢复向目标频道转发媒体流失败。自从 v3.6.1.1

◆ CHANNEL_MEDIA_RELAY_STATE

enum agora_gaming_rtc.CHANNEL_MEDIA_RELAY_STATE

strong

跨频道媒体流转发状态码。

枚举值
RELAY_STATE_IDLE	0: 初始状态。在成功调用 StopChannelMediaRelay 停止跨频道媒体流转发后，OnChannelMediaRelayStateChangedHandler 会回调该状态。
RELAY_STATE_CONNECTING	1: SDK 尝试跨频道。
RELAY_STATE_RUNNING	2: 源频道主播成功加入目标频道。
RELAY_STATE_FAILURE	3: 发生异常，详见 `code` 中提示的错误信息。

◆ VIDEO_PROFILE_TYPE

enum agora_gaming_rtc.VIDEO_PROFILE_TYPE

strong

弃用:: 横屏模式视频属性。

枚举值
VIDEO_PROFILE_LANDSCAPE_120P	0: 160 × 120，帧率 15 fps，码率 65 Kbps。
VIDEO_PROFILE_LANDSCAPE_120P_3	2: 120 × 120，帧率 15 fps，码率 50 Kbps。
VIDEO_PROFILE_LANDSCAPE_180P	10: 320×180，帧率 15 fps，码率 140 Kbps。
VIDEO_PROFILE_LANDSCAPE_180P_3	12: 180 × 180，帧率 15 fps，码率 100 Kbps。
VIDEO_PROFILE_LANDSCAPE_180P_4	13: 240 × 180，帧率 15 fps，码率 120 Kbps。
VIDEO_PROFILE_LANDSCAPE_240P	20: 320 × 240，帧率 15 fps，码率 200 Kbps。
VIDEO_PROFILE_LANDSCAPE_240P_3	22: 240 × 240，帧率 15 fps，码率 140 Kbps。
VIDEO_PROFILE_LANDSCAPE_240P_4	23: 424 × 240，帧率 15 fps，码率 220 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P	30: 640 × 360，帧率 15 fps，码率 400 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_3	32: 360 × 360，帧率 15 fps，码率 260 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_4	33: 640 × 360，帧率 30 fps，码率 600 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_6	35: 360 × 360，帧率 30 fps，码率 400 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_7	36: 480 × 360，帧率 15 fps，码率 320 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_8	37: 480 × 360，帧率 30 fps，码率 490 Kbps。
VIDEO_PROFILE_LANDSCAPE_360P_9	38: 640 × 360，帧率 15 fps，码率 800 Kbps。注解 Live broadcast profile only.
VIDEO_PROFILE_LANDSCAPE_360P_10	39: 640 × 360，帧率 24 fps，码率 800 Kbps。注解 Live broadcast profile only.
VIDEO_PROFILE_LANDSCAPE_360P_11	100: 640 × 360，帧率 24 fps，码率 1000 Kbps。注解 Live broadcast profile only.
VIDEO_PROFILE_LANDSCAPE_480P	40: 640 × 480，帧率 15 fps，码率 500 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_3	42: 480 × 480，帧率 15 fps，码率 400 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_4	43: 640 × 480，帧率 30 fps，码率 750 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_6	45: 480 × 480，帧率 30 fps，码率 600 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_8	47: 848 × 480，帧率 15 fps，码率 610 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_9	48: 848 × 480，帧率 30 fps，码率 930 Kbps。
VIDEO_PROFILE_LANDSCAPE_480P_10	49: 640 × 480，帧率 10 fps，码率 400 Kbps。
VIDEO_PROFILE_LANDSCAPE_720P	50: 1280 × 720，帧率 15 fps，码率 1130 Kbps。
VIDEO_PROFILE_LANDSCAPE_720P_3	52: 1280 × 720，帧率 30 fps，码率 1710 Kbps。
VIDEO_PROFILE_LANDSCAPE_720P_5	54: 960 × 720，帧率 15 fps，码率 910 Kbps。
VIDEO_PROFILE_LANDSCAPE_720P_6	55: 960 × 720，帧率 30 fps，码率 1380 Kbps。
VIDEO_PROFILE_LANDSCAPE_1080P	60: 1920 × 1080，帧率 15 fps，码率 2080 Kbps。
VIDEO_PROFILE_LANDSCAPE_1080P_3	62: 1920 × 1080，帧率 30 fps，码率 3150 Kbps。
VIDEO_PROFILE_LANDSCAPE_1080P_5	64: 1920 × 1080，帧率 60 fps，码率 4780 Kbps。
VIDEO_PROFILE_LANDSCAPE_1440P	66: 2560 × 1440，帧率 30 fps，码率 4850 Kbps。
VIDEO_PROFILE_LANDSCAPE_1440P_2	67: 2560 × 1440，帧率 60 fps，码率 6500 Kbps。
VIDEO_PROFILE_LANDSCAPE_4K	70: 3840 × 2160，帧率 30 fps，码率 6500 Kbps。
VIDEO_PROFILE_LANDSCAPE_4K_3	72: 3840 × 2160，帧率 60 fps，码率 6500 Kbps。
VIDEO_PROFILE_PORTRAIT_120P	1000: 120 × 160，帧率 15 fps，码率 65 Kbps。
VIDEO_PROFILE_PORTRAIT_120P_3	1002: 120 × 120，帧率 15 fps，码率 50 Kbps。
VIDEO_PROFILE_PORTRAIT_180P	1010: 180 × 320，帧率 15 fps，码率 140 Kbps。
VIDEO_PROFILE_PORTRAIT_180P_3	1012: 180 × 180，帧率 15 fps，码率 100 Kbps。
VIDEO_PROFILE_PORTRAIT_180P_4	1013: 180 × 240，帧率 15 fps，码率 120 Kbps。
VIDEO_PROFILE_PORTRAIT_240P	1020: 240 × 320，帧率 15 fps，码率 200 Kbps。
VIDEO_PROFILE_PORTRAIT_240P_3	1022: 240 × 240，帧率 15 fps，码率 140 Kbps。
VIDEO_PROFILE_PORTRAIT_240P_4	1023: 240 × 424，帧率 15 fps，码率 220 Kbps。
VIDEO_PROFILE_PORTRAIT_360P	1030: 360 × 640，帧率 15 fps，码率 400 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_3	1032: 360 × 360，帧率 15 fps，码率 260 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_4	1033: 360 × 640，帧率 30 fps，码率 600 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_6	1035: 360 × 360，帧率 30 fps，码率 400 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_7	1036: 360 × 480，帧率 15 fps，码率 320 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_8	1037: 360 × 480，帧率 30 fps，码率 490 Kbps。
VIDEO_PROFILE_PORTRAIT_360P_9	1038: 360 × 640，帧率 15 fps，码率 800 Kbps。注解仅适用于直播频道场景。
VIDEO_PROFILE_PORTRAIT_360P_10	1039: 360 × 640，帧率 24 fps，码率 800 Kbps。注解仅适用于直播频道场景。
VIDEO_PROFILE_PORTRAIT_360P_11	1100: 360 × 640，帧率 24 fps，码率 1000 Kbps。注解仅适用于直播频道场景。
VIDEO_PROFILE_PORTRAIT_480P	1040: 480 × 640，帧率 15 fps，码率 500 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_3	1042: 480 × 480，帧率 15 fps，码率 400 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_4	1043: 480 × 640，帧率 30 fps，码率 750 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_6	1045: 480 × 480，帧率 30 fps，码率 600 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_8	1047: 480 × 848，帧率 15 fps，码率 610 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_9	1048: 480 × 848，帧率 30 fps，码率 930 Kbps。
VIDEO_PROFILE_PORTRAIT_480P_10	1049: 480 × 640，帧率 10 fps，码率 400 Kbps。
VIDEO_PROFILE_PORTRAIT_720P	1050: 720 × 1280，帧率 15 fps，码率 1130 Kbps。
VIDEO_PROFILE_PORTRAIT_720P_3	1052: 720 × 1280，帧率 30 fps，码率 1710 Kbps。
VIDEO_PROFILE_PORTRAIT_720P_5	1054: 720 × 960，帧率 15 fps，码率 910 Kbps。
VIDEO_PROFILE_PORTRAIT_720P_6	1055: 720 × 960，帧率 30 fps，码率 1380 Kbps。
VIDEO_PROFILE_PORTRAIT_1080P	1060: 1080 × 1920，帧率 15 fps，码率 2080 Kbps。
VIDEO_PROFILE_PORTRAIT_1080P_3	1062: 1080 × 1920，帧率 30 fps，码率 3150 Kbps。
VIDEO_PROFILE_PORTRAIT_1080P_5	1064: 1080 × 1920，帧率 60 fps，码率 4780 Kbps。
VIDEO_PROFILE_PORTRAIT_1440P	1066: 1440 × 2560，帧率 30 fps，码率 4850 Kbps。
VIDEO_PROFILE_PORTRAIT_1440P_2	1067: 1440 × 2560，帧率 60 fps，码率 6500 Kbps。
VIDEO_PROFILE_PORTRAIT_4K	1070: 2160 × 3840，帧率 30 fps，码率 6500 Kbps。
VIDEO_PROFILE_PORTRAIT_4K_3	1072: 2160 × 3840，帧率 60 fps，码率 6500 Kbps。
VIDEO_PROFILE_DEFAULT	Default 640 × 360，帧率 15 fps，码率 400 Kbps。

◆ CHANNEL_MEDIA_RELAY_ERROR

enum agora_gaming_rtc.CHANNEL_MEDIA_RELAY_ERROR

strong

跨频道媒体流转发出错的错误码。

枚举值
RELAY_OK	0: 一切正常。
RELAY_ERROR_SERVER_ERROR_RESPONSE	1: 服务器回应出错。
RELAY_ERROR_SERVER_NO_RESPONSE	2: 服务器无回应。你可以调用 LeaveChannel 方法离开频道。
RELAY_ERROR_NO_RESOURCE_AVAILABLE	3: SDK 无法获取服务，可能是因为服务器资源有限导致。
RELAY_ERROR_FAILED_JOIN_SRC	4: 发起跨频道转发媒体流请求失败。
RELAY_ERROR_FAILED_JOIN_DEST	5: 接受跨频道转发媒体流请求失败。
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC	6: 服务器接收跨频道转发媒体流失败。
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST	7: 服务器发送跨频道转发媒体流失败。
RELAY_ERROR_SERVER_CONNECTION_LOST	8: SDK 因网络质量不佳与服务器断开。你可以调用 LeaveChannel 方法离开当前频道。
RELAY_ERROR_INTERNAL_ERROR	9: 服务器内部出错。
RELAY_ERROR_SRC_TOKEN_EXPIRED	10: 源频道的 Token 已过期。
RELAY_ERROR_DEST_TOKEN_EXPIRED	11: 目标频道的 Token 已过期。

◆ METADATA_TYPE

enum agora_gaming_rtc.METADATA_TYPE

strong

观测器的 Metadata 类型。当前仅支持视频类型的 Metadata 。

枚举值
UNKNOWN_METADATA	-1: Metadata 类型未知。
VIDEO_METADATA	0: Metadata 类型为视频。

◆ RENDER_MODE_TYPE

enum agora_gaming_rtc.RENDER_MODE_TYPE

strong

设置视频显示模式。

枚举值
RENDER_MODE_HIDDEN	1: 视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉。
RENDER_MODE_FIT	2: 视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充黑色。
RENDER_MODE_ADAPTIVE	弃用: 3: 该模式已废弃。

◆ ENCRYPTION_MODE

enum agora_gaming_rtc.ENCRYPTION_MODE

strong

内置加密模式。声网推荐使用 AES_128_GCM2 或 AES_256_GCM2 加密模式。这两种模式支持使用盐，安全性更高。

枚举值
AES_128_XTS	1: 128 位 AES 加密，XTS 模式。
AES_128_ECB	2: 128 位 AES 加密，ECB 模式。
AES_256_XTS	3: 256 位 AES 加密，XTS 模式。
SM4_128_ECB	4: 128 位 SM4 加密，ECB 模式。
AES_128_GCM	5: 128 位 AES 加密，GCM 模式。自从 v3.3.1
AES_256_GCM	6: 256 位 AES 加密，GCM 模式。自从 v3.3.1
AES_128_GCM2	7:（默认）128 位 AES 加密，GCM 模式。相比于 `AES_128_GCM` 加密模式，`AES_128_GCM2` 加密模式安全性更高且需要设置盐（`encryptionKdfSalt`）。自从 v3.4.5
AES_256_GCM2	8: 256 位 AES 加密，GCM 模式。相比于 `AES_256_GCM` 加密模式，`AES_256_GCM2` 加密模式安全性更高且需要设置盐（`encryptionKdfSalt`）。自从 v3.4.5
MODE_END	枚举值边界。

◆ RTMP_STREAMING_EVENT

enum agora_gaming_rtc.RTMP_STREAMING_EVENT

strong

RTMP/RTMPS 推流时发生的事件。

枚举值
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE	1: RTMP/RTMPS 推流时，添加背景图或水印出错。
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE	2: 该推流 URL 已用于推流。如果你想开始新的推流，请使用新的推流 URL。自从 v3.4.5
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT	3: 功能不支持。自从 v3.6.1.1
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN	4: 预留参数。自从 v3.6.1.1

◆ STREAM_PUBLISH_STATE

enum agora_gaming_rtc.STREAM_PUBLISH_STATE

strong

发布状态。

枚举值
PUB_STATE_IDLE	0: 加入频道后的初始发布状态。
PUB_STATE_NO_PUBLISHED	1: 发布失败。可能是因为：本地用户调用 MuteLocalAudioStream(true) 或 MuteLocalVideoStream(true) 停止发送本地媒体流。本地用户调用 DisableAudio 或 DisableVideo 关闭本地音频或视频模块。本地用户调用 EnableLocalAudio(false) 或 EnableLocalVideo(false) 关闭本地音频或视频采集。本地用户角色为观众。
PUB_STATE_PUBLISHING	2: 正在发布。
PUB_STATE_PUBLISHED	3: 发布成功。

◆ STREAM_SUBSCRIBE_STATE

enum agora_gaming_rtc.STREAM_SUBSCRIBE_STATE

strong

订阅状态。

枚举值
SUB_STATE_IDLE	0: 加入频道后的初始订阅状态。
SUB_STATE_NO_SUBSCRIBED	1: 订阅失败。可能是因为：远端用户：调用 MuteLocalAudioStream(true) 或 MuteLocalVideoStream(true) 停止发送本地媒体流。调用 DisableAudio 或 DisableVideo 关闭本地音频或视频模块。调用 EnableLocalAudio(false) 或 EnableLocalVideo(false) 关闭本地音频或视频采集。用户角色为观众。本地用户调用以下方法停止接收远端媒体流：调用 MuteRemoteAudioStream(true)、MuteAllRemoteAudioStreams(true) 或 SetDefaultMuteAllRemoteAudioStreams(true) 停止接收远端音频流。调用 MuteRemoteVideoStream(true)、MuteAllRemoteVideoStreams(true) 或 SetDefaultMuteAllRemoteVideoStreams(true) 停止接收远端音频流。
SUB_STATE_SUBSCRIBING	2: 正在订阅。
SUB_STATE_SUBSCRIBED	3: 收到了远端流，订阅成功。

◆ AUDIENCE_LATENCY_LEVEL_TYPE

enum agora_gaming_rtc.AUDIENCE_LATENCY_LEVEL_TYPE

strong

直播频道中观众端（用户角色为观众的客户端）的延时级别。

注解: 仅在用户角色设为 CLIENT_ROLE_AUDIENCE 时才生效。

枚举值
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY	1: 低延时。
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY	2: （默认）超低延时。

◆ VOICE_BEAUTIFIER_PRESET

enum agora_gaming_rtc.VOICE_BEAUTIFIER_PRESET

strong

预设的美声效果选项。

枚举值
VOICE_BEAUTIFIER_OFF	原声，即关闭美声效果。
CHAT_BEAUTIFIER_MAGNETIC	磁性（男）。注解该设置仅对男声有效。请勿用于设置女声，否则音频会失真。
CHAT_BEAUTIFIER_FRESH	清新（女）。注解该设置仅对女声有效。请勿用于设置男声，否则音频会失真。
CHAT_BEAUTIFIER_VITALITY	活力（女）。注解该设置仅对女声有效。请勿用于设置男声，否则音频会失真。
SINGING_BEAUTIFIER	自从 v3.3.1 歌唱美声。如果调用 SetVoiceBeautifierPreset(SINGING_BEAUTIFIER)，你可以美化男声并添加歌声在小房间的混响效果。请勿用于设置女声，否则音频会失真。如果调用 SetVoiceBeautifierParameters(SINGING_BEAUTIFIER, param1, param2)，你可以美化男声或女声并添加混响效果。
TIMBRE_TRANSFORMATION_VIGOROUS	浑厚。
TIMBRE_TRANSFORMATION_DEEP	低沉。
TIMBRE_TRANSFORMATION_MELLOW	圆润。
TIMBRE_TRANSFORMATION_FALSETTO	假音。
TIMBRE_TRANSFORMATION_FULL	饱满。
TIMBRE_TRANSFORMATION_CLEAR	清澈。
TIMBRE_TRANSFORMATION_RESOUNDING	高亢。
TIMBRE_TRANSFORMATION_RINGING	嘹亮。

◆ AUDIO_EFFECT_PRESET

enum agora_gaming_rtc.AUDIO_EFFECT_PRESET

strong

预设的音效选项。

枚举值
AUDIO_EFFECT_OFF	原声，即关闭人声音效。
ROOM_ACOUSTICS_KTV	KTV。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_VOCAL_CONCERT	演唱会。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_STUDIO	录音棚。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_PHONOGRAPH	留声机。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_VIRTUAL_STEREO	虚拟立体声，即 SDK 将单声道的音频渲染出双声道的音效。注解你需要在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`，否则该枚举设置无效。
ROOM_ACOUSTICS_SPACIAL	空旷。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_ETHEREAL	空灵。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
ROOM_ACOUSTICS_3D_VOICE	3D 人声，即 SDK 将音频渲染出在用户周围环绕的效果，环绕周期为 10 秒。设置该音效后，你还可以调用 SetAudioEffectParameters 修改环绕周期。注解你需要在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`，否则该枚举设置无效。启用 3D 人声后，用户需要使用支持双声道的音频播放设备才能听到预期效果。
VOICE_CHANGER_EFFECT_UNCLE	大叔。注解建议用于处理男声，否则无法达到预期效果。为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_OLDMAN	老年男性。注解建议用于处理男声，否则无法达到预期效果。为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_BOY	男孩。注解建议用于处理男声，否则无法达到预期效果。为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_SISTER	少女。注解建议用于处理女声，否则无法达到预期效果。为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_GIRL	女孩。注解建议用于处理女声，否则无法达到预期效果。为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_PIGKING	猪八戒。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
VOICE_CHANGER_EFFECT_HULK	绿巨人。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。
STYLE_TRANSFORMATION_RNB	R&B。注解你需要在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`，否则该枚举设置无效。
STYLE_TRANSFORMATION_POPULAR	流行。注解你需要在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`，否则该枚举设置无效。
PITCH_CORRECTION	电音，即 SDK 以主音音高为 C 的自然大调为基础修正音频的实际音高。设置该音效后，你还可以调用 SetAudioEffectParameters 调整修音的基础调式和主音音高。注解为获取更好的人声效果，声网建议你在使用该枚举前将 SetAudioProfile 的 `profile` 参数设置为 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` 或 `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`。

◆ SUPER_RESOLUTION_STATE_REASON

enum agora_gaming_rtc.SUPER_RESOLUTION_STATE_REASON

strong

超级分辨率算法未成功开启的原因

自从: v3.6.1.1

枚举值
SR_STATE_REASON_SUCCESS	0: 超分辨率已成功开启。
SR_STATE_REASON_STREAM_OVER_LIMITATION	1: 远端用户的原始视频分辨率超出了可以应用超分辨率功能的范围。
SR_STATE_REASON_USER_COUNT_OVER_LIMITATION	2: 已对一个远端用户的视频使用超分辨率。
SR_STATE_REASON_DEVICE_NOT_SUPPORTED	3: 设备不支持使用超分辨率。
SR_STATE_REASON_INSUFFICIENT_PERFORMANCE	4: 开启或运行超分辨率功能时，SDK 检测到用户设备性能不足。收到该原因码后，声网建议用户关闭超分辨率功能。

◆ CAPTURE_BRIGHTNESS_LEVEL_TYPE

enum agora_gaming_rtc.CAPTURE_BRIGHTNESS_LEVEL_TYPE

strong

本地采集的画质亮度级别。

自从: v3.3.1

枚举值
CAPTURE_BRIGHTNESS_LEVEL_INVALID	-1: SDK 未检测出本地采集的画质亮度级别。请等待几秒，通过下一次回调的 `CAPTURE_BRIGHTNESS_LEVEL_TYPE` 获取亮度级别。
CAPTURE_BRIGHTNESS_LEVEL_NORMAL	0: 本地采集的画质亮度正常。
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT	1: 本地采集的画质亮度偏亮。
CAPTURE_BRIGHTNESS_LEVEL_DARK	2: 本地采集的画质亮度偏暗。

◆ PROXY_TYPE

enum agora_gaming_rtc.PROXY_TYPE

strong

云代理类型。

自从: v3.7.0

枚举值
NONE_PROXY	0: 调用 setLocalAccessPoint 并加入了频道，但未连接本地代理。
UDP_PROXY	1: UDP 协议的云代理，即 Force UDP 云代理模式。在该模式下，SDK 始终通过 UDP 协议传输数据。
TCP_PROXY	2: TCP（加密）协议的云代理，即 Force TCP 云代理模式。在该模式下，SDK 始终通过 TLS 443 传输数据。
LOCAL_PROXY_TYPE	3: 调用 setLocalAccessPoint 方法并连接到本地代理。
TCP_PROXY_AUTO_FALLBACK_TYPE	4: 自动模式。在该模式下，SDK 优先连接 SD-RTN™，如果连接失败，自动切换为 TLS 443。

◆ VOICE_CONVERSION_PRESET

enum agora_gaming_rtc.VOICE_CONVERSION_PRESET

strong

预设的变声效果选项。

自从: v3.3.1

枚举值
VOICE_CONVERSION_OFF	原声，即关闭变声效果。
VOICE_CHANGER_NEUTRAL	中性。为避免音频失真，请确保仅对女声设置该效果。
VOICE_CHANGER_SWEET	甜美。为避免音频失真，请确保仅对女声设置该效果。
VOICE_CHANGER_SOLID	稳重。为避免音频失真，请确保仅对男声设置该效果。
VOICE_CHANGER_BASS	低沉。为避免音频失真，请确保仅对男声设置该效果。

◆ EXPERIENCE_QUALITY_TYPE

enum agora_gaming_rtc.EXPERIENCE_QUALITY_TYPE

strong

接收远端音频时，本地用户的主观体验质量。

自从: v3.3.1

枚举值
EXPERIENCE_QUALITY_GOOD	0: 主观体验质量较好。
EXPERIENCE_QUALITY_BAD	1: 主观体验质量较差。

◆ EXPERIENCE_POOR_REASON

enum agora_gaming_rtc.EXPERIENCE_POOR_REASON

strong

接收远端音频时，本地用户主观体验质量较差的原因。

自从: v3.3.1

枚举值
EXPERIENCE_REASON_NONE	0: 无原因，说明主观体验质量较好。
REMOTE_NETWORK_QUALITY_POOR	1: 远端用户的网络较差。
LOCAL_NETWORK_QUALITY_POOR	2: 本地用户的网络较差。
WIRELESS_SIGNAL_POOR	4: 本地用户的 Wi-Fi 或者移动数据网络信号弱。
WIFI_BLUETOOTH_COEXIST	8: 本地用户同时开启 Wi-Fi 和蓝牙，二者信号互相干扰，导致音频传输质量下降。

◆ BACKGROUND_SOURCE_TYPE

enum agora_gaming_rtc.BACKGROUND_SOURCE_TYPE

strong

自定义的背景图类型。

自从: v3.4.5

枚举值

BACKGROUND_COLOR

1:（默认）背景图为纯色。

BACKGROUND_IMG

背景图为 PNG、JPG 格式的图片。

BACKGROUND_BLUR

背景图为虚化处理后的背景图。

自从: v3.6.1.1

◆ BACKGROUND_BLUR_DEGREE

enum agora_gaming_rtc.BACKGROUND_BLUR_DEGREE

strong

自定义背景图的虚化程度。

自从: v3.6.1.1

枚举值
BLUR_DEGREE_LOW	1: 自定义背景图的虚化程度为低。用户差不多能看清背景。
BLUR_DEGREE_MEDIUM	自定义背景图的虚化程度为中。用户较难看清背景。
BLUR_DEGREE_HIGH	（默认）自定义背景图的虚化程度为高。用户很难看清背景。

◆ VIRTUAL_BACKGROUND_SOURCE_STATE_REASON

enum agora_gaming_rtc.VIRTUAL_BACKGROUND_SOURCE_STATE_REASON

strong

虚拟背景开启失败的原因。

枚举值
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_SUCCESS	0: 虚拟背景已成功开启。
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_IMAGE_NOT_EXIST	1: 自定义的背景图不存在。请检查 VirtualBackgroundSource 中 `source` 的值。
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_COLOR_FORMAT_NOT_SUPPORTED	2: 自定义的背景图颜色格式出错。请检查 VirtualBackgroundSource 中 `color` 的值。
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_DEVICE_NOT_SUPPORTED	3: 设备不支持使用虚拟背景。
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_INSUFFICIENT_PERFORMANCE	4: 开启或运行虚拟背景功能时，SDK 检测到用户设备性能不足。收到该原因码后，声网建议用户关闭虚拟背景功能。

◆ AUDIO_MIXING_DUAL_MONO_MODE

enum agora_gaming_rtc.AUDIO_MIXING_DUAL_MONO_MODE

strong

声道模式。在 SetAudioMixingDualMonoMode 中设置。

自从: v3.6.1.1

枚举值
AUDIO_MIXING_DUAL_MONO_AUTO	0: 原始模式。
AUDIO_MIXING_DUAL_MONO_L	1: 左声道模式。该模式用左声道的音频替换右声道的音频，即用户只能听到左声道的音频。
AUDIO_MIXING_DUAL_MONO_R	2: 右声道模式。该模式用右声道的音频替换左声道的音频，即用户只能听到右声道的音频。
AUDIO_MIXING_DUAL_MONO_MIX	3: 混合模式。该模式将左右声道的数据叠加，即用户能同时听到左声道和右声道的音频。

◆ AUDIO_FILE_INFO_ERROR

enum agora_gaming_rtc.AUDIO_FILE_INFO_ERROR

strong

音频文件信息的获取状态。在 OnRequestAudioFileInfoHandler 中报告。

枚举值
AUDIO_FILE_INFO_ERROR_OK	0: 获取成功。
AUDIO_FILE_INFO_ERROR_FAILURE	1: 获取失败。

◆ CONTENT_INSPECT_RESULT

enum agora_gaming_rtc.CONTENT_INSPECT_RESULT

strong

鉴黄结果。

自从: v3.7.0

枚举值
CONTENT_INSPECT_NEUTRAL	1: 正常图片。
CONTENT_INSPECT_SEXY	2: 性感图片。
CONTENT_INSPECT_PORN	3: 色情图片。

◆ AVDATA_TYPE

enum agora_gaming_rtc.AVDATA_TYPE

strong

*‍/

枚举值
AVDATA_UNKNOWN	0: the metadata type is unknown.
AVDATA_VIDEO	1: the metadata type is video.
AVDATA_AUDIO	2: the metadata type is video.

◆ CODEC_VIDEO

enum agora_gaming_rtc.CODEC_VIDEO

strong

枚举值
CODEC_VIDEO_AVC	0: h264 avc codec.
CODEC_VIDEO_HEVC	1: h265 hevc codec.
CODEC_VIDEO_VP8	2: vp8 codec.

◆ CODEC_AUDIO

enum agora_gaming_rtc.CODEC_AUDIO

strong

枚举值
CODEC_AUDIO_PCM	0: PCM audio codec.
CODEC_AUDIO_AAC	1: aac audio codec.
CODEC_AUDIO_G722	2: G711 audio codec.

◆ MediaRecorderContainerFormat

enum agora_gaming_rtc.MediaRecorderContainerFormat

strong

录制文件的格式。

自从: v3.6.1.1

枚举值
FORMAT_MP4	（默认）MP4
FORMAT_FLV	预留参数

◆ MediaRecorderStreamType

enum agora_gaming_rtc.MediaRecorderStreamType

strong

录制内容。

自从: v3.6.1.1

枚举值
STREAM_TYPE_AUDIO	仅音频。
STREAM_TYPE_VIDEO	仅视频。
STREAM_TYPE_BOTH	（默认）音视频。

◆ RecorderState

enum agora_gaming_rtc.RecorderState

strong

当前的录制状态。

自从: v3.6.1.1

枚举值
RECORDER_STATE_ERROR	音视频流录制出错，错误原因详见 RecorderErrorCode 中的提示。
RECORDER_STATE_START	音视频流录制开始。
RECORDER_STATE_STOP	音视频流录制停止。

◆ RecorderErrorCode

enum agora_gaming_rtc.RecorderErrorCode

strong

录制状态出错的原因。

自从: v3.6.1.1

枚举值
RECORDER_ERROR_NONE	一切正常。
RECORDER_ERROR_WRITE_FAILED	录制文件写入失败。
RECORDER_ERROR_NO_STREAM	没有可录制的音视频流或者录制的音视频流中断超过 5 秒。
RECORDER_ERROR_OVER_MAX_DURATION	录制时长超出上限。
RECORDER_ERROR_CONFIG_CHANGED	录制配置改变。
RECORDER_ERROR_CUSTOM_STREAM_DETECTED	在通信场景下，捕捉到 3.0.1 之前版本的用户发送的音视频流。

◆ LOCAL_PROXY_MODE

enum agora_gaming_rtc.LOCAL_PROXY_MODE

strong

SDK 与本地代理的连接模式。

枚举值

ConnectivityFirst

0: 连通性优先。在该模式下，SDK 同时尝试连接指定的声网私有媒体服务器和声网 SD-RTN™。如果能连接到指定的声网私有媒体服务器，则连接私有媒体服务器，不会切换到声网 SD-RTN™。如果无法连接到指定的声网私有媒体服务器，则先连接声网 SD-RTN™ 以保持连通性，同时 SDK 继续尝试连接指定的声网私有媒体服务器，一旦连接上私有媒体服务器，SDK 会立即从声网 SD-RTN™ 切换到私有媒体服务器。

注解: 该模式在声网私有化平台中不生效。

LocalOnly

1: SDK 只尝试连接指定的声网私有媒体服务器。

◆ EXCLUDE_WINDOW_ERROR

enum agora_gaming_rtc.EXCLUDE_WINDOW_ERROR

strong

屏幕共享时，屏蔽窗口的错误码。

自从: v3.6.1.1

枚举值
EXCLUDE_WINDOW_FAIL	-1: 屏幕共享时，屏蔽窗口失败。用户的显卡不支持窗口屏蔽功能。
EXCLUDE_WINDOW_NONE	0: 预留参数。

◆ AudioDeviceTestVolumeType

enum agora_gaming_rtc.AudioDeviceTestVolumeType

strong

音量类型

自从: 3.7.0

枚举值
AudioTestRecordingVolume	0: 音频采集设备的音量。
AudioTestPlaybackVolume	1: 音频播放的音量。

◆ LOW_LIGHT_ENHANCE_MODE

enum agora_gaming_rtc.LOW_LIGHT_ENHANCE_MODE

strong

暗光增强模式。

自从: v3.7.0

枚举值
LOW_LIGHT_ENHANCE_AUTO	0:（默认）自动模式。SDK 会根据环境光亮度自动开启或关闭暗光增强功能，以适时补光和防止过曝。
LOW_LIGHT_ENHANCE_MANUAL	手动模式。用户需手动开启或关闭暗光增强功能。

◆ LOW_LIGHT_ENHANCE_LEVEL

enum agora_gaming_rtc.LOW_LIGHT_ENHANCE_LEVEL

strong

暗光增强等级。

自从: v3.7.0

枚举值
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY	0:（默认）优先画质的暗光增强，会处理视频图像的亮度、细节、噪声，消耗的性能适中，处理速度适中，综合画质最优。
LOW_LIGHT_ENHANCE_LEVEL_FAST	优先性能的暗光增强，会处理视频图像的亮度、细节，消耗的性能较少，处理速度较快。

◆ VIDEO_DENOISER_MODE

enum agora_gaming_rtc.VIDEO_DENOISER_MODE

strong

视频降噪模式。

自从: v3.7.0

枚举值
VIDEO_DENOISER_AUTO	0:（默认）自动模式。SDK 会根据环境光亮度自动开启或关闭视频降噪功能。
VIDEO_DENOISER_MANUAL	手动模式。用户需手动开启或关闭视频降噪功能。

◆ VIDEO_DENOISER_LEVEL

enum agora_gaming_rtc.VIDEO_DENOISER_LEVEL

strong

视频降噪等级

自从: v3.7.0

枚举值
VIDEO_DENOISER_LEVEL_HIGH_QUALITY	0:（默认）优先画质的视频降噪。`HIGH_QUALITY` 是在性能消耗和视频降噪效果中取平衡的等级。性能消耗适中，视频降噪速度适中，综合画质最优。
VIDEO_DENOISER_LEVEL_FAST	优先性能的视频降噪。`FAST` 是在性能消耗和视频降噪效果中侧重于节省性能的等级。性能消耗较少，视频降噪速度较快。为避免处理后的视频有明显的拖影效果，声网推荐你在摄像头固定的情况下使用 `FAST`。
VIDEO_DENOISER_LEVEL_STRENGTH	强效的视频降噪。`STRENGTH` 是在性能消耗和视频降噪效果中侧重于视频降噪效果的等级。性能消耗较多，视频降噪速度较慢，视频降噪效果较好。如果 `HIGH_QUALITY` 不能满足你的视频降噪需求，你可以使用 `STRENGTH`。

◆ CLIENT_ROLE_CHANGE_FAILED_REASON

enum agora_gaming_rtc.CLIENT_ROLE_CHANGE_FAILED_REASON

strong

切换用户角色失败的原因。

自从: 3.7.0

枚举值
CLIENT_ROLE_CHANGE_FAILED_BY_TOO_MANY_BROADCASTERS	1: 频道内主播人数达到上限。注解该枚举仅在开启 128 人功能后报告。主播人数的上限根据开启 128 人功能时实际配置的人数而定。
CLIENT_ROLE_CHANGE_FAILED_BY_NOT_AUTHORIZED	2: 请求被服务端拒绝。建议提示用户重新尝试切换用户角色。
CLIENT_ROLE_CHANGE_FAILED_BY_REQUEST_TIME_OUT	3: 请求超时。建议提示用户检查网络连接状况后重新尝试切换用户角色。
CLIENT_ROLE_CHANGE_FAILED_BY_CONNECTION_FAILED	4: 网络连接断开。可根据 `OnConnectionStateChangedHandler` 报告的 `reason`，排查网络连接失败的具体原因。

◆ WLACC_MESSAGE_REASON

enum agora_gaming_rtc.WLACC_MESSAGE_REASON

strong

Wi-Fi 连接质量不佳的原因。

自从: 3.7.0

枚举值
WLACC_MESSAGE_REASON_WEAK_SIGNAL	0: Wi-Fi 信号弱。
WLACC_MESSAGE_REASON_2G_CHANNEL_CONGESTION	1: 网络拥塞。

◆ WLACC_SUGGEST_ACTION

enum agora_gaming_rtc.WLACC_SUGGEST_ACTION

strong

改善 Wi-Fi 连接质量的操作建议。

自从: 3.7.0

枚举值
WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI	0: 由于路由器接收到的 Wi-Fi 信号弱，请用户靠近路由器。
WLACC_SUGGEST_ACTION_CONNECT_5G	1: 请用户连接到指定的无线网络。无线网络名称（SSID）详见 `wlAccMsg` 参数。
WLACC_SUGGEST_ACTION_CHECK_5G	2: 当前路由器不支持 5G 频道。请用户检查路由器是否支持并开启了 5G 频道，或更换支持 5G 频道的路由器。开启 5G 频道的步骤详见 `wlAccMsg` 参数。
WLACC_SUGGEST_ACTION_MODIFY_SSID	3: 2.4G 频段和 5G 频道的网络名称（SSID）相同。请用户修改 2.4G 频段或 5G 频道的网络名称。修改步骤详见 `wlAccMsg` 参数。

◆ CLOUD_PROXY_TYPE

enum agora_gaming_rtc.CLOUD_PROXY_TYPE

strong

云代理类型。

枚举值

NONE_PROXY

0: 自动模式。在该模式下，SDK 优先连接 SD-RTN™，如果连接失败，自动切换到 TLS 443。自 v3.7.0 起，SDK 默认开启该模式。

UDP_PROXY

1: UDP 协议的云代理，即 Force UDP 云代理模式。在该模式下，SDK 始终通过 UDP 协议传输数据。

TCP_PROXY

TCP（加密）协议的云代理，即 Force TCP 云代理模式。在该模式下，SDK 始终通过 TLS 443 传输数据。

自从: 3.7.0

◆ SCREEN_SCENARIO_TYPE

enum agora_gaming_rtc.SCREEN_SCENARIO_TYPE

strong

屏幕共享的场景。

自从: 3.7.0

枚举值
SCREEN_SCENARIO_DOCUMENT	1:（默认）文档。该场景下，优先保障共享的画质，并降低了接收端看到共享视频的延时。如果你共享文档、幻灯片、表格，可以设置该场景。
SCREEN_SCENARIO_GAMING	2: 游戏。该场景下，优先保障共享的流畅性。如果你共享游戏，可以设置该场景。
SCREEN_SCENARIO_VIDEO	3: 视频。该场景下，优先保障共享的流畅性。如果你共享电影、视频直播，可以设置该场景。
SCREEN_SCENARIO_RDC	4: 远程控制。该场景下，优先保障共享的画质，并降低了接收端看到共享视频的延时。如果你共享被远程控制的设备桌面，可以设置该场景。

◆ ScreenCaptureSourceType

enum agora_gaming_rtc.ScreenCaptureSourceType

strong

屏幕共享目标的类型。

枚举值
ScreenCaptureSourceType_Unknown	-1: 未知。
ScreenCaptureSourceType_Window	0: 屏幕共享目标为某一个窗口。
ScreenCaptureSourceType_Screen	1: 屏幕共享目标为某一个显示器的屏幕。
ScreenCaptureSourceType_Custom	2: 预留参数。

◆ SR_MODE

enum agora_gaming_rtc.SR_MODE

strong

超分辨率的模式。

自从: v3.7.1

枚举值
SR_MODE_MANUAL	0: 对你指定的远端用户进行超分辨率处理。
SR_MODE_AUTO	对频道内最大的渲染窗口所对应的远端用户进行超分辨率处理。

◆ AgoraVideoSurfaceType

enum agora_gaming_rtc.AgoraVideoSurfaceType

strong

视频渲染器类型。

枚举值
Renderer	0: 该渲染器通常用于渲染 3D GameObject，例如 Cube、Cylinder 和 Plane。
RawImage	1: 该渲染器通常用于渲染 UI 组件下的 Raw Image。

函数说明

◆ OnJoinChannelSuccessHandler()

delegate void agora_gaming_rtc.OnJoinChannelSuccessHandler	(	string	channelName,
		uint	uid,
		int	elapsed
	)

加入频道回调。

该回调方法表示该客户端成功加入了指定的频道。

频道名基于 JoinChannelByKey 中指定的 channelName 分配。

如果调用 JoinChannelByKey 时并没有指定 uid。服务器会自动分配一个。

参数

channelName	频道名。
uid	用户 ID。如果 `JoinChannelByKey` 中指定了 uid，则此处返回该 ID；否则使用声网服务器自动分配的 ID。
elapsed	从 `JoinChannelByKey` 开始到发生此事件过去的时间（毫秒）。

◆ OnLeaveChannelHandler()

delegate void agora_gaming_rtc.OnLeaveChannelHandler ( RtcStats stats )

离开频道回调。

app 调用 LeaveChannel 方法时，SDK 提示 app 离开频道成功。在该回调方法中，app 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。App 通过该回调获取通话时长以及 SDK 接收到或发送的数据统计信息。

参数

stats 通话的统计数据: RtcStats 。

◆ OnReJoinChannelSuccessHandler()

delegate void agora_gaming_rtc.OnReJoinChannelSuccessHandler	(	string	channelName,
		uint	uid,
		int	elapsed
	)

重新加入频道回调。

有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。

参数

channelName	频道名。
uid	用户 ID。
elapsed	从开始重连到重连成功的时间（毫秒）。

◆ OnConnectionLostHandler()

delegate void agora_gaming_rtc.OnConnectionLostHandler ( )

网络连接丢失回调。

SDK 在调用 JoinChannelByKey 后无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。

与 OnConnectionInterruptedHandler 的区别是：

OnConnectionInterruptedHandler 回调一定是发生在加入频道成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
OnConnectionLostHandler 回调是无论之前加入频道是否成功，只要 10 秒内和服务器无法建立连接都会触发。

如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

◆ OnConnectionInterruptedHandler()

delegate void agora_gaming_rtc.OnConnectionInterruptedHandler ( )

网络连接中断回调。

弃用:: 该回调自 v2.3.2 起废弃，请改用 OnConnectionStateChangedHandler。

SDK 在和服务器建立连接后，失去了网络连接超过 4 秒，会触发该回调。在触发事件后，SDK 会主动重连服务器，所以该事件可以用于 UI 提示。

与 OnConnectionLostHandler 回调的区别是：

OnConnectionInterruptedHandler 回调一定是发生在加入频道成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
OnConnectionLostHandler 回调是无论之前加入频道是否成功，只要 10 秒内和服务器无法建立连接都会触发。

如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

◆ OnRequestTokenHandler()

delegate void agora_gaming_rtc.OnRequestTokenHandler ( )

Token 已过期回调。

在调用 JoinChannelByKey , 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中 SDK 可能由于网络原因和服务器失去连接，重连时可能需要新的 Token。

该回调通知 app 需要生成新的 Token，并调用 RenewToken 更新 Token。

◆ OnUserJoinedHandler()

delegate void agora_gaming_rtc.OnUserJoinedHandler	(	uint	uid,
		int	elapsed
	)

远端用户（通信场景）/主播（直播场景）加入当前频道回调。

通信场景下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
直播场景下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。声网建议连麦主播不超过 17 人。

该回调在如下情况下会被触发：

远端用户/主播调用 JoinChannelByKey 方法加入频道。
远端用户加入频道后调用 SetClientRole 将用户角色改变为主播。
远端用户/主播网络中断后重新加入频道。

注解

直播场景下：

主播间能相互收到新主播加入频道的回调，并能获得该主播的 uid。
观众也能收到新主播加入频道的回调，并能获得该主播的 uid。
当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调。

参数

uid	新加入频道的远端用户/主播 ID。
elapsed	从本地用户调用 `JoinChannelByKey` 到该回调触发的延迟（毫秒)。

◆ OnUserOfflineHandler()

delegate void agora_gaming_rtc.OnUserOfflineHandler	(	uint	uid,
		USER_OFFLINE_REASON	reason
	)

远端用户（通信场景）/主播（直播场景）离开当前频道回调。

提示有远端用户/主播离开了频道（或掉线）。用户离开频道有两个原因，即正常离开和超时掉线：

正常离开的时候，远端用户/主播会发送类似“再见”的消息。接收此消息后，判断用户离开频道。
超时掉线的依据是，在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。建议使用声网 RTM SDK 来做可靠的掉线检测。

参数

uid	离线用户或主播的用户 ID。
reason	离线原因: USER_OFFLINE_REASON 。

◆ OnVolumeIndicationHandler()

delegate void agora_gaming_rtc.OnVolumeIndicationHandler	(	AudioVolumeInfo[]	speakers,
		int	speakerNumber,
		int	totalVolume
	)

用户音量提示回调。

该回调默认禁用，你可以通过 EnableAudioVolumeIndication 开启；开启后，只要频道内有发流用户，SDK 会在加入频道后按 EnableAudioVolumeIndication 中设置的时间间隔触发 OnVolumeIndicationHandler 回调。每次会触发两个 OnVolumeIndicationHandler 回调，一个报告本地发流用户的音量相关信息，另一个报告瞬时音量最高的远端用户（最多 3 位）的音量相关信息。

注解

启用该功能后，如果有用户将自己静音（调用了 MuteLocalAudioStream），SDK 行为会受如下影响：

本地用户静音后 SDK 立即停止报告本地用户的音量提示回调。
远端说话者静音后 20 秒，远端的音量提示回调中将不再包含该用户；如果远端所有用户都将自己静音，20 秒后 SDK 不再报告远端用户的音量提示回调。

参数

speakers	用户音量信息，详见 AudioVolumeInfo 数组。如果 `speakers` 为空，则表示远端用户不发流或没有远端用户。
speakerNumber	用户数量。在本地用户的回调中，只要本地用户在发流，`speakerNumber` 始终为 `1`。在远端用户的回调中，`speakerNumber` 取值范围为 [0,3]。如果远端发流用户数量大于 3，则此回调中 `speakerNumber` 值为 `3`。
totalVolume	混音后的总音量，取值范围为 [0,255]。在本地用户的回调中，`totalVolume` 为本地发流用户的音量。在远端用户的回调中，`totalVolume` 为瞬时音量最高的远端用户（最多 3 位）混音后的总音量。

如果用户调用了 StartAudioMixing，则 totalVolume 为音乐文件和用户声音的总音量。

◆ OnLocalVoicePitchInHzHandler()

delegate void agora_gaming_rtc.OnLocalVoicePitchInHzHandler ( int pitchInHz )

报告本地用户的语音音调。

自从: v3.7.0 开启本地音频采集并调用 EnableLocalVoicePitchCallback 后，SDK 会按 EnableLocalVoicePitchCallback 中设置的时间间隔触发该回调，报告本地用户的语音音调。

注解: 启用该功能后，如果用户关闭了本地音频采集，例如，调用了 EnableLocalAudio(false)，SDK 会停止发送 OnLocalVoicePitchInHzHandler 回调。

参数

pitchInHz 本地用户的语音音调，单位为 Hz。

◆ OnUserMutedAudioHandler()

delegate void agora_gaming_rtc.OnUserMutedAudioHandler	(	uint	uid,
		bool	muted
	)

远端用户静音回调。

提示有远端用户已将其音频流静音（或取消静音）。该回调是由远端用户调用 MuteLocalAudioStream 方法关闭或开启音频发送触发的。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid	用户 ID。
muted	该用户是否静音： true: 该用户已将音频静音； false: 该用户取消了音频静音。

◆ OnSDKWarningHandler()

delegate void agora_gaming_rtc.OnSDKWarningHandler	(	int	warn,
		string	msg
	)

发生警告回调。

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）警告。通常情况下，SDK 上报的警告信息 app 可以忽略，SDK 会自动恢复。比如和服务器失去连接时，SDK 可能会上报 WARN_OPEN_CHANNEL_TIMEOUT(106) 警告，同时自动尝试重连。

参数

warn	警告代码：Warning Code。
msg	警告描述。

◆ OnSDKErrorHandler()

delegate void agora_gaming_rtc.OnSDKErrorHandler	(	int	error,
		string	msg
	)

发生错误回调。

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）错误。通常情况下，SDK 上报的错误意味着 SDK 无法自动恢复，需要 app 干预或提示用户。比如启动通话失败时，SDK 会上报 ERR_START_CALL(1002) 错误。App 可以提示用户启动通话失败，并调用 LeaveChannel 退出频道。

参数

error	错误代码：Error Code。
msg	错误描述。

◆ OnRtcStatsHandler()

delegate void agora_gaming_rtc.OnRtcStatsHandler ( RtcStats stats )

当前通话统计回调。SDK 定期向 app 报告当前通话的统计信息，每两秒触发一次。

参数

stats RTC 引擎统计数据: RtcStats 。

◆ OnAudioMixingFinishedHandler()

delegate void agora_gaming_rtc.OnAudioMixingFinishedHandler ( )

本地音乐文件播放已结束回调。

弃用:: 该回调已废弃，请改用 OnAudioMixingStateChangedHandler。

当调用 StartAudioMixing 播放本地音乐文件结束后，会触发该回调。如果调用 StartAudioMixing 失败，会在 OnSDKErrorHandler 回调里，返回错误码 WARN_AUDIO_MIXING_OPEN_ERROR(701) 。

◆ OnAudioRouteChangedHandler()

delegate void agora_gaming_rtc.OnAudioRouteChangedHandler ( AUDIO_ROUTE route )

音频路由已发生变化回调。

当音频路由发生变化时，SDK 会触发此回调。

注解: 该回调仅适用于 Android、iOS 和 macOS。

参数

route 音频路由。详见： AUDIO_ROUTE 。

◆ OnFirstRemoteVideoDecodedHandler()

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

已接收到远端视频并完成解码回调。

引擎收到第一帧远端视频流并解码成功时，触发此调用。 app 可在此回调中设置该用户的 view。有两种情况：

远端用户首次上线后发送视频。
远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括：
- 远端用户离开频道。
- 远端用户掉线。
- 远端用户调用 MuteLocalVideoStream 方法停止发送本地视频流。
- 远端用户调用 the DisableVideo 方法关闭视频模块。

参数

uid	用户 ID，指定是哪个用户的视频流。
width	视频流宽（px）。
height	视频流高（px）。
elapsed	从本地调用 JoinChannelByKey 开始到该回调触发的延迟（毫秒）。

◆ OnVideoSizeChangedHandler()

delegate void agora_gaming_rtc.OnVideoSizeChangedHandler	(	uint	uid,
		int	width,
		int	height,
		int	rotation
	)

本地或远端视频大小和旋转信息发生改变回调。

参数

uid	图像尺寸和旋转信息发生变化的用户的用户 ID（本地用户的 uid 为 0）。
width	视频流的宽度（像素）。
height	视频流的高度（像素）。
rotation	旋转信息 [0,360) 。

◆ OnClientRoleChangedHandler()

delegate void agora_gaming_rtc.OnClientRoleChangedHandler	(	CLIENT_ROLE_TYPE	oldRole,
		CLIENT_ROLE_TYPE	newRole
	)

直播场景下用户角色切换成功回调。

直播场景下，本地用户加入频道后调用 SetClientRole 成功改变用户角色时，例如主播切换为观众，或观众切换为主播，SDK 会触发该回调，报告切换前和切换后的角色。 *

参数

oldRole	切换前的角色: CLIENT_ROLE_TYPE 。
newRole	切换后的角色: CLIENT_ROLE_TYPE 。

◆ OnUserMuteVideoHandler()

delegate void agora_gaming_rtc.OnUserMuteVideoHandler	(	uint	uid,
		bool	muted
	)

远端用户暂停/恢复发送视频流回调。

你也可以使用 OnRemoteVideoStateChangedHandler 回调的：

该回调是由远端用户调用 MuteLocalVideoStream 方法关闭或开启视频发送触发的。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid	远端用户 ID。
muted	该用户是否暂停发送其视频流： true: 该用户已暂停发送其视频流； false: 该用户已恢复发送其视频流。

◆ OnMicrophoneEnabledHandler()

delegate void agora_gaming_rtc.OnMicrophoneEnabledHandler ( bool isEnabled )

麦克风状态已改变回调。

弃用:: 该回调已被废弃，请改用 OnLocalAudioStateChangedHandler 回调的：LOCAL_AUDIO_STREAM_STATE_STOPPED(0) 或 LOCAL_AUDIO_STREAM_STATE_RECORDING(1)。

该回调由本地用户调用 EnableLocalAudio 方法开启或关闭本地音频采集触发的。

参数

isEnabled

true: 麦克风已启用；
false: 麦克风已禁用。

◆ OnApiExecutedHandler()

delegate void agora_gaming_rtc.OnApiExecutedHandler	(	int	err,
		string	api,
		string	result
	)

API 方法已执行回调。

参数

err	当该方法调用失败时 SDK 返回的错误码。如果方法调用失败，会返回错误码 Error Code。如果该方法调用成功，SDK 将返回 0。
api	SDK 执行的 API。
result	SDK 调用 API 的调用结果。

◆ OnLastmileQualityHandler()

delegate void agora_gaming_rtc.OnLastmileQualityHandler ( int quality )

通话前网络上下行 last mile 质量报告回调。

该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到声网边缘服务器的网络状态。在调用 EnableLastmileTest 之后，该回调函数每 2 秒触发一次。如果远端有多个用户/主播，该回调每 2 秒会被触发多次。

参数

quality 网络上下行质量，基于上下行网络的丢包率和抖动计算，探测结果主要反映上行网络的状态。详见: QUALITY_TYPE 。

◆ OnFirstLocalAudioFrameHandler()

delegate void agora_gaming_rtc.OnFirstLocalAudioFrameHandler ( int elapsed )

已发送本地音频首帧回调。

弃用:: 该回调自 v3.2.0 废弃，请改用 OnFirstLocalAudioFramePublishedHandler 回调。

参数

elapsed 从调用 JoinChannelByKey 方法直至该回调被触发的时间。

◆ OnFirstRemoteAudioFrameHandler()

delegate void agora_gaming_rtc.OnFirstRemoteAudioFrameHandler	(	uint	userId,
		int	elapsed
	)

已接收远端音频首帧回调。

弃用:: 该回调自 v3.0.1 起废弃，请改用 OnRemoteAudioStateChangedHandler。

参数

userId	发送音频帧的远端用户的用户 ID。
elapsed	从调用 JoinChannelByKey 方法直至该回调被触发的时间。

◆ OnAudioQualityHandler()

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

远端声音质量回调。

弃用:: 该回调自 v2.3.2 起废弃。请改用 OnRemoteAudioStatsHandler 回调。

该回调描述远端用户在通话中的音频质量，针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。

参数

userId	用户 ID，指定是谁发的音频流。
quality	语音质量，详见: QUALITY_TYPE 。
delay	音频包从发送端到接收端的延迟（毫秒）。包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。
lost	音频包从发送端到接收端的丢包率 (%)。

◆ OnStreamUnpublishedHandler()

delegate void agora_gaming_rtc.OnStreamUnpublishedHandler ( string url )

旁路推流已停止回调。

弃用:: 该回调自 v3.0.1 起废弃。请改用 OnRtmpStreamingStateChangedHandler。

回调用于通知主播停止推流成功。

参数

url	被删除的 RTMP/RTMPS 推流地址。

◆ OnStreamPublishedHandler()

delegate void agora_gaming_rtc.OnStreamPublishedHandler	(	string	url,
		int	error
	)

旁路推流已开启回调。该回调用于通知主播推流状态。

弃用:: 该回调自 v3.0.1 起废弃，请改用 OnRtmpStreamingStateChangedHandler。

参数

url 主播推流的 URL 地址。

error

Error code: Error Code。

ERR_OK(0): 推流成功。
ERR_FAILED(1): 推流失败。
ERR_INVALID_ARGUMENT(2): 参数错误。如果你在调用 AddPublishStreamUrl 前没有调用 SetLiveTranscoding 配置 LiveTranscoding ，SDK 会回调 ERR_INVALID_ARGUMENT(2)。
ERR_TIMEDOUT(10): 推流超时未成功。
ERR_ALREADY_IN_USE(19): 推流地址已推流。
ERR_ABORTED(20): SDK 与推流服务器断开连接。推流中断。
ERR_RESOURCE_LIMITED(22): 后台没有足够资源推流。
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH(130): 推流已加密不能推流。
ERR_PUBLISH_STREAM_CDN_ERROR(151)
ERR_PUBLISH_STREAM_NUM_REACH_LIMIT(152)
ERR_PUBLISH_STREAM_NOT_AUTHORIZED(153)
ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR(154)
ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED(156)

◆ OnStreamMessageErrorHandler()

delegate void agora_gaming_rtc.OnStreamMessageErrorHandler	(	uint	userId,
		int	streamId,
		int	code,
		int	missed,
		int	cached
	)

接收对方数据流消息发生错误的回调。

该回调表示本地用户未收到远端用户调用 SendStreamMessage 方法发送的流消息。

参数

userId	发送消息的用户 ID。
streamId	Stream ID。
code	错误码: Error Code。
missed	丢失的消息数量。
cached	数据流中断时，后面缓存的消息数量。

◆ OnStreamMessageHandler()

delegate void agora_gaming_rtc.OnStreamMessageHandler	(	uint	userId,
		int	streamId,
		string	data,
		int	length
	)

接收到对方数据流消息的回调。

该回调表示本地用户收到了远端用户调用 SendStreamMessage 方法发送的流消息。

参数

userId	发送消息的用户 ID。
streamId	数据流 ID。
data	接收到的数据流。
length	数据流长度。

◆ OnConnectionBannedHandler()

delegate void agora_gaming_rtc.OnConnectionBannedHandler ( )

连接已被服务器禁止回调。

弃用:: 该回调自 v2.3.2 起废弃，请改用 OnConnectionStateChangedHandler。

当你被服务端禁掉连接的权限时，会触发该回调。

◆ OnConnectionStateChangedHandler()

delegate void agora_gaming_rtc.OnConnectionStateChangedHandler	(	CONNECTION_STATE_TYPE	state,
		CONNECTION_CHANGED_REASON_TYPE	reason
	)

网络连接状态已改变回调。该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态和引起网络状态改变的原因。

参数

state	详见： CONNECTION_STATE_TYPE 。
reason	详见： CONNECTION_CHANGED_REASON_TYPE 。

◆ OnTokenPrivilegeWillExpireHandler()

delegate void agora_gaming_rtc.OnTokenPrivilegeWillExpireHandler ( string token )

Token 服务即将过期回调。

在调用 JoinChannelByKey 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 app 更新 Token。当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 RenewToken 将新生成的 Token 传给 SDK。

参数

token 即将服务失效的 Token。

◆ OnActiveSpeakerHandler()

delegate void agora_gaming_rtc.OnActiveSpeakerHandler ( uint uid )

监测到最活跃用户回调。

成功调用 EnableAudioVolumeIndication 后，SDK 会持续监测音量最大的远端用户，并统计该用户被判断为音量最大者的次数。当前时间段内，该次数累积最多的远端用户为最活跃的用户。

当频道内用户数量大于或等于 2 且有活跃用户时，SDK 会触发该回调并报告最活跃用户的 uid。

如果最活跃用户一直是同一位用户，则 SDK 不会再次触发 OnActiveSpeakerHandler 回调。
如果最活跃用户有变化，则 SDK 会再次触发该回调并报告新的最活跃用户的 uid。

参数

uid	远端最活跃用户的 ID。

◆ OnVideoStoppedHandler()

delegate void agora_gaming_rtc.OnVideoStoppedHandler ( )

视频功能已停止回调。

弃用:: 该回调自 v2.4.1 起废弃。请改用 OnLocalVideoStateChangedHandler 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。

提示视频功能已停止。 app 如需在停止视频后对 view 做其他处理（比如显示其他画面），可以在这个回调中进行。

◆ OnFirstLocalVideoFrameHandler()

delegate void agora_gaming_rtc.OnFirstLocalVideoFrameHandler	(	int	width,
		int	height,
		int	elapsed
	)

已显示本地视频首帧回调。本地视频首帧显示在本地视图上时，SDK 会触发此回调。

参数

width	本地渲染视频的宽 (px) 。
height	本地渲染视频的高 (px)。
elapsed	从调用 JoinChannelByKey 到发生此事件过去的时间（毫秒）。如果在 `JoinChannelByKey` 前调用了 StartPreview ，则是从 `StartPreview` 到发生此事件过去的时间。

◆ OnFirstRemoteVideoFrameHandler()

delegate void agora_gaming_rtc.OnFirstRemoteVideoFrameHandler	(	uint	uid,
		int	width,
		int	height,
		int	elapsed
	)

已显示首帧远端视频回调。

第一帧远端视频显示在视图上时，触发此调用。 app 可在此调用中获知出图时间（elapsed）。

参数

uid	用户 ID，指定是哪个用户的视频流。
width	视频流宽（px）。
height	视频流高（px）。
elapsed	从本地调用 JoinChannelByKey 到发生此事件过去的时间（毫秒)。

◆ OnUserEnableVideoHandler()

delegate void agora_gaming_rtc.OnUserEnableVideoHandler	(	uint	uid,
		bool	enabled
	)

远端用户开关本地视频采集回调。

弃用:

该回调已被废弃，请改用 OnRemoteVideoStateChangedHandler 回调的：

提示有远端用户开关了本地视频采集。关闭视频功能是指该用户只能进行语音通话，不能显示、发送自己的视频，也不能接收、显示别人的视频。

该回调是由远端用户调用 EnableVideo 或 DisableVideo 方法开启或关闭视频模块触发的。

参数

uid	用户 ID，提示是哪个用户的视频流。
enabled	true: 该用户已启用了视频功能。启用后，该用户可以进行视频通话或直播。 false: 该用户已关闭了视频功能。关闭后，该用户只能进行语音通话或直播，不能显示、发送自己的视频，也不能接收、显示别人的视频。

◆ OnUserEnableLocalVideoHandler()

delegate void agora_gaming_rtc.OnUserEnableLocalVideoHandler	(	uint	uid,
		bool	enabled
	)

其他用户启用/关闭本地视频。

弃用:

该回调已被废弃，请改用 OnRemoteVideoStateChangedHandler 回调的：

提示有其他用户启用/关闭了本地视频功能。关闭视频功能是指该用户只能进行语音通话，不能显示、发送自己的视频，也不能接收、显示别人的视频。

该回调是由远端用户调用 EnableLocalVideo 方法开启或关闭视频采集触发的。

参数

uid	用户 ID，提示是哪个用户的视频流。
enabled	true: 该用户已启用视频功能。启用后，其他用户可以接收到该用户的视频流。 false: 该用户已关闭视频功能。关闭后，该用户仍然可以接收其他用户的视频流，但其他用户接收不到该用户的视频流。

◆ OnRemoteVideoStateChangedHandler()

delegate void agora_gaming_rtc.OnRemoteVideoStateChangedHandler	(	uint	uid,
		REMOTE_VIDEO_STATE	state,
		REMOTE_VIDEO_STATE_REASON	reason,
		int	elapsed
	)

远端视频状态发生改变回调。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid	发生视频状态改变的远端用户 ID。
state	远端视频流状态。详见 REMOTE_VIDEO_STATE 。
reason	远端视频流状态改变的具体原因。详见 REMOTE_VIDEO_STATE_REASON 。
elapsed	从本地用户调用 JoinChannelByKey 方法到发生本事件经历的时间，单位为 ms。

◆ OnLocalPublishFallbackToAudioOnlyHandler()

delegate void agora_gaming_rtc.OnLocalPublishFallbackToAudioOnlyHandler ( bool isFallbackOrRecover )

本地发布流已回退为音频流回调。

如果你调用了 SetLocalPublishFallbackOption 接口并将 option 设置为 STREAM_FALLBACK_OPTION_AUDIO_ONLY(2) ，当上行网络环境不理想、本地发布的媒体流回退为音频流时，或当上行网络改善、媒体流恢复为音视频流时，会触发该回调。

注解: 如果本地推流已回退为音频流，远端的 app 上会收到 OnUserMuteVideoHandler 的回调事件。

参数

isFallbackOrRecover

true: 由于网络环境不理想，本地发布的媒体流已回退为音频流；
false: 由于网络环境改善，发布的音频流已恢复为音视频流。

◆ OnRemoteSubscribeFallbackToAudioOnlyHandler()

delegate void agora_gaming_rtc.OnRemoteSubscribeFallbackToAudioOnlyHandler	(	uint	uid,
		bool	isFallbackOrRecover
	)

远端订阅流已回退为音频流回调。

如果你调用了 SetRemoteSubscribeFallbackOption 接口并将 option 设置为 STREAM_FALLBACK_OPTION_AUDIO_ONLY(2)，当下行网络环境不理想、仅接收远端音频流时，或当下行网络改善、恢复订阅音视频流时，会触发该回调。

注解: 远端订阅流因弱网环境不能同时满足音视频而回退为小流时，你可以使用 RemoteVideoStats 来监控远端视频大小流的切换。

参数

uid	远端用户的用户 ID。
isFallbackOrRecover	true: 由于网络环境不理想，远端订阅流已回退为音频流； false: 由于网络环境改善，订阅的音频流已恢复为音视频流。

◆ OnNetworkQualityHandler()

delegate void agora_gaming_rtc.OnNetworkQualityHandler	(	uint	uid,
		int	txQuality,
		int	rxQuality
	)

通话中每个用户的网络上下行 last mile 质量报告回调。

该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。该回调每 2 秒触发一次。如果远端有多个用户，该回调每 2 秒会被触发多次。

参数

uid	用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。当 uid 为 0 时，返回的是本地用户的网络质量。
txQuality	该用户的上行网络质量，基于发送码率、上行丢包率、平均往返时延和网络抖动计算。该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。假设上行码率是 1000 Kbps，那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题，但是支持 1280 × 720 的分辨率就会有困难。详见 QUALITY_TYPE 。
rxQuality	该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 QUALITY_TYPE 。

◆ OnLocalVideoStatsHandler()

delegate void agora_gaming_rtc.OnLocalVideoStatsHandler ( LocalVideoStats localVideoStats )

本地视频流统计信息回调。

该回调描述本地设备发送视频流的统计信息，每 2 秒触发一次。

参数

localVideoStats 本地视频流统计信息。详见 LocalVideoStats 。

◆ OnRemoteVideoStatsHandler()

delegate void agora_gaming_rtc.OnRemoteVideoStatsHandler ( RemoteVideoStats remoteVideoStats )

通话中远端视频流的统计信息回调。

该回调描述远端用户在通话中端到端的视频流统计信息，针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。

参数

remoteVideoStats 远端视频统计数据。详见: RemoteVideoStats 。

◆ OnRemoteAudioStatsHandler()

delegate void agora_gaming_rtc.OnRemoteAudioStatsHandler ( RemoteAudioStats remoteAudioStats )

通话中远端音频流的统计信息回调。用于取代 OnAudioQualityHandler 回调。

该回调描述远端用户在通话中端到端的音频流统计信息。该回调函数针对每个发送音频流的远端用户/主播每 2 秒触发一次。如果远端有多个用户/主播发送音频流，该回调每 2 秒会被触发多次。

参数

remoteAudioStats 接收到的远端音频统计数据，详细定义见: RemoteAudioStats 。

◆ OnAudioDeviceStateChangedHandler()

delegate void agora_gaming_rtc.OnAudioDeviceStateChangedHandler	(	string	deviceId,
		int	deviceType,
		int	deviceState
	)

音频设备变化回调。

提示系统音频设备状态发生改变，比如耳机被拔出。

参数

deviceId	设备 ID。
deviceType	设备类型: MEDIA_DEVICE_TYPE 。
deviceState	设备状态: macOS 平台： 0: 设备就绪。 8: 设备被拔出。 Windows 平台：详见 MEDIA_DEVICE_STATE_TYPE 。

◆ OnCameraReadyHandler()

delegate void agora_gaming_rtc.OnCameraReadyHandler ( )

摄像头就绪回调。

弃用:: 该回调自 v2.4.1 起废弃。请改用 OnLocalVideoStateChangedHandler 回调中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。

提示已成功打开摄像头，可以开始捕获视频。如果摄像头打开失败，可在 OnSDKErrorHandler 中处理相应错误。

◆ OnCameraFocusAreaChangedHandler()

delegate void agora_gaming_rtc.OnCameraFocusAreaChangedHandler	(	int	x,
		int	y,
		int	width,
		int	height
	)

摄像头对焦区域已改变回调。

该回调是由本地用户调用 SetCameraFocusPositionInPreview 方法改变对焦位置触发的。

注解: 该回调只适用于 Android 和 iOS 平台。

参数

x	发生改变的对焦区域的 x 坐标。
y	发生改变的对焦区域的 y 坐标。
width	发生改变的对焦区域的宽度。
height	发生改变的对焦区域的高度。

◆ OnCameraExposureAreaChangedHandler()

delegate void agora_gaming_rtc.OnCameraExposureAreaChangedHandler	(	int	x,
		int	y,
		int	width,
		int	height
	)

摄像头曝光区域已改变回调。

该回调是由本地用户调用 SetCameraExposurePosition 方法改变曝光位置触发的。

注解: 该回调只适用于 Android 和 iOS 平台。

参数

x	发生改变的曝光区域的 x 坐标。
y	发生改变的曝光区域的 y 坐标。
width	发生改变的曝光区域的宽度。
height	发生改变的曝光区域的高度。

◆ OnRemoteAudioMixingBeginHandler()

delegate void agora_gaming_rtc.OnRemoteAudioMixingBeginHandler ( )

远端音乐文件播放已开始回调。

当远端有用户调用 StartAudioMixing 播放本地音乐文件，会触发该回调。

◆ OnRemoteAudioMixingEndHandler()

delegate void agora_gaming_rtc.OnRemoteAudioMixingEndHandler ( )

远端音乐文件播放已结束回调。当远端有用户播放本地音乐文件结束，会触发该回调。

◆ OnAudioEffectFinishedHandler()

delegate void agora_gaming_rtc.OnAudioEffectFinishedHandler ( int soundId )

本地音效文件播放已结束回调。

当播放音效结束后，会触发该回调。

参数

soundId 指定音效的 ID。每个音效均有唯一的 ID。

◆ OnVideoDeviceStateChangedHandler()

delegate void agora_gaming_rtc.OnVideoDeviceStateChangedHandler	(	string	deviceId,
		int	deviceType,
		int	deviceState
	)

视频设备变化回调。

该回调提示系统视频设备状态发生改变，比如被拔出或移除。如果设备已使用外接摄像头采集，外接摄像头被拔开后，视频会中断。

参数

deviceId	设备 ID。
deviceType	设备类型: MEDIA_DEVICE_TYPE
deviceState	设备状态: macOS 平台： 0: 设备就绪。 8: 设备被拔出。 Windows 平台：详见 MEDIA_DEVICE_STATE_TYPE

◆ OnRemoteVideoTransportStatsHandler()

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

通话中远端视频流传输的统计信息回调。

弃用:: 该回调已被废弃，请改用 OnRemoteVideoStatsHandler。

该回调描述远端用户通话中端到端的网络统计信息，通过视频包计算，用客观的数据，如丢包、网络延迟等，展示当前网络状态。通话中，当用户收到远端用户/主播发送的视频数据包后，会每 2 秒触发一次该回调。

和 OnRemoteVideoStatsHandler 回调相比，该回调以数据展示当前网络状态，因此更客观。

参数

uid	用户 ID，指定是哪个用户/主播的视频包。
delay	视频包从发送端到接收端的延时（毫秒）。
lost	视频包从发送端到接收端的丢包率 (%)。
rxKBitRate	远端视频包的接收码率（Kbps）。

◆ OnRemoteAudioTransportStatsHandler()

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

通话中远端音频流传输的统计信息回调。

弃用:: 该回调已被废弃，请改用 OnRemoteAudioStatsHandler。

该回调描述远端用户通话中端到端的网络统计信息，通过音频包计算，用客观的数据，如丢包、网络延迟等，展示当前网络状态。通话中，当用户收到远端用户/主播发送的音频数据包后，会每 2 秒触发一次该回调。和 OnRemoteAudioStatsHandler 回调相比，该回调以数据展示当前网络状态，因此更客观。

参数

uid	用户 ID，指定是哪个用户/主播的音频包。
delay	音频包从发送端到接收端的延时（毫秒）。
lost	音频包从发送端到接收端的丢包率 (%)。
rxKBitRate	远端音频包的接收码率（Kbps）。

◆ OnTranscodingUpdatedHandler()

delegate void agora_gaming_rtc.OnTranscodingUpdatedHandler ( )

旁路推流设置已被更新回调。

当 SetLiveTranscoding 方法中的直播参数 LiveTranscoding 更新时，OnTranscodingUpdatedHandler 回调会被触发并向主播报告更新信息。

注解: 首次调用SetLiveTranscoding 方法设置转码参数 LiveTranscoding 时，不会触发此回调。

◆ OnAudioDeviceVolumeChangedHandler()

delegate void agora_gaming_rtc.OnAudioDeviceVolumeChangedHandler	(	MEDIA_DEVICE_TYPE	deviceType,
		int	volume,
		bool	muted
	)

回放、采集设备、或 app 的音量发生改变。

注解: 仅适用于 Windows 平台。

参数

deviceType	设备类型定义: MEDIA_DEVICE_TYPE 。
volume	音量：范围 [0,255]。
muted	true: 音频设备已被静音； false: 音频设备未被静音。

◆ OnMediaEngineStartCallSuccessHandler()

delegate void agora_gaming_rtc.OnMediaEngineStartCallSuccessHandler ( )

媒体引擎成功启动的回调。

◆ OnMediaEngineLoadSuccessHandler()

delegate void agora_gaming_rtc.OnMediaEngineLoadSuccessHandler ( )

媒体引擎成功加载的回调。

◆ OnAudioMixingStateChangedHandler()

delegate void agora_gaming_rtc.OnAudioMixingStateChangedHandler	(	AUDIO_MIXING_STATE_TYPE	state,
		AUDIO_MIXING_REASON_TYPE	reason
	)

本地用户的音乐文件播放状态已改变回调。

自从: v3.4.2

该回调在音乐文件播放状态发生改变时触发，并报告当前的播放状态和播放状态改变的原因。

参数

state	当前音乐文件播放状态，详见 AUDIO_MIXING_STATE_TYPE
reason	音乐文件播放状态改变的原因，详见 AUDIO_MIXING_REASON_TYPE

◆ OnFirstRemoteAudioDecodedHandler()

delegate void agora_gaming_rtc.OnFirstRemoteAudioDecodedHandler	(	uint	uid,
		int	elapsed
	)

已解码远端音频首帧的回调。

弃用:: 该方法自 v3.0.1 起废弃，请改用 OnRemoteAudioStateChangedHandler。

SDK 完成远端音频首帧解码，并发送给音频模块用以播放时，会触发此回调。有两种情况：

远端用户首次上线后发送音频。
远端用户音频离线再上线发送音频。音频离线指本地在 15 秒内没有收到音频包，可能有如下原因：
- 远端用户离开频道。
- 远端用户掉线。
- 远端用户调用 MuteLocalAudioStream 方法停止发送音频流。
- 远端用户调用 DisableAudio 方法关闭音频。

参数

uid	远端用户 ID。
elapsed	从本地用户调用 JoinChannelByKey 直至该回调触发的延迟，单位为毫秒。

◆ OnLocalVideoStateChangedHandler()

delegate void agora_gaming_rtc.OnLocalVideoStateChangedHandler	(	LOCAL_VIDEO_STREAM_STATE	localVideoState,
		LOCAL_VIDEO_STREAM_ERROR	error
	)

本地视频状态发生改变回调。

本地视频的状态发生改变时，SDK 会触发该回调返回当前的本地视频状态。在本地视频出现故障时，你可以通过该回调了解当前视频的状态以及出现故障的原因，方便排查问题。

注解: 对某些机型而言，当本地视频采集设备正在使用中时，SDK 不会在本地视频状态发生改变时触发该回调，你需要自行做超时判断。

参数

localVideoState	本地视频状态，详见: LOCAL_VIDEO_STREAM_STATE 。当本地视频状态为 LOCAL_VIDEO_STREAM_STATE_FAILED(3) 时，你可以在 `error` 参数中查看返回的错误原因。
error	本地视频出错原因，详见: LOCAL_VIDEO_STREAM_ERROR 。

◆ OnRtmpStreamingStateChangedHandler()

delegate void agora_gaming_rtc.OnRtmpStreamingStateChangedHandler	(	string	url,
		RTMP_STREAM_PUBLISH_STATE	state,
		RTMP_STREAM_PUBLISH_ERROR	errCode
	)

RTMP/RTMPS 推流状态发生改变回调。

该回调返回本地用户调用 AddPublishStreamUrl 或 RemovePublishStreamUrl 方法的结果。

RTMP/RTMPS 推流状态发生改变时，SDK 会触发该回调，并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态；推流出错时，你可以通过返回的错误码了解出错的原因，方便排查问题。

参数

url	推流状态发生改变的 URL 地址。
state	当前的推流状态，详见 RTMP_STREAM_PUBLISH_STATE 。
errCode	推流错误信息，详见 RTMP_STREAM_PUBLISH_ERROR 。

◆ OnNetworkTypeChangedHandler()

delegate void agora_gaming_rtc.OnNetworkTypeChangedHandler ( NETWORK_TYPE type )

本地网络类型发生改变回调。

本地网络类型发生改变回调。你可以通过该回调获取正在使用的网络类型；当连接中断时，该回调能辨别引起中断的原因是网络切换还是网络条件不好。

参数

type	详见 NETWORK_TYPE 。

◆ OnLastmileProbeResultHandler()

delegate void agora_gaming_rtc.OnLastmileProbeResultHandler ( LastmileProbeResult result )

通话前网络质量探测报告回调。

通话前网络上下行 Last mile 质量探测报告回调。在调用 StartLastmileProbeTest 之后，SDK 会在约 30 秒内返回该回调。

参数

result 上下行 Last mile 质量探测结果。详见: LastmileProbeResult 。

◆ OnLocalUserRegisteredHandler()

delegate void agora_gaming_rtc.OnLocalUserRegisteredHandler	(	uint	uid,
		string	userAccount
	)

本地用户成功注册 User Account 回调。本地用户成功调用 RegisterLocalUserAccount 方法注册用户 User Account 或调用 JoinChannelByKey 加入频道后，SDK 会触发该回调，并告知本地用户的 UID 和 User Account。

参数

uid	本地用户的 UID。
userAccount	本地用户的 User Account。

◆ OnUserInfoUpdatedHandler()

delegate void agora_gaming_rtc.OnUserInfoUpdatedHandler	(	uint	uid,
		UserInfo	userInfo
	)

远端用户信息已更新回调。

远端用户加入频道后， SDK 会获取到该远端用户的 UID 和 User Account，然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表，并在本地触发该回调。

参数

uid	远端用户的 UID。
userInfo	标识用户信息的 `UserInfo` 对象，包含用户 UID 和 User Account。

◆ OnLocalAudioStateChangedHandler()

delegate void agora_gaming_rtc.OnLocalAudioStateChangedHandler	(	LOCAL_AUDIO_STREAM_STATE	state,
		LOCAL_AUDIO_STREAM_ERROR	error
	)

本地音频状态发生改变回调。

本地音频的状态发生改变时（包括本地麦克风录制状态和音频编码状态），SDK 会触发该回调报告当前的本地音频状态。在本地音频出现故障时，该回调可以帮助你了解当前音频的状态以及出现故障的原因，方便你排查问题。

注解: 当状态为 LOCAL_AUDIO_STREAM_STATE_FAILED(3) 时，你可以在 error 参数中查看返回的错误信息。

参数

state	当前的本地音频状态。详见 LOCAL_AUDIO_STREAM_STATE 。
error	本地音频出错原因。详见 LOCAL_AUDIO_STREAM_ERROR 。

◆ OnRemoteAudioStateChangedHandler()

delegate void agora_gaming_rtc.OnRemoteAudioStateChangedHandler	(	uint	uid,
		REMOTE_AUDIO_STATE	state,
		REMOTE_AUDIO_STATE_REASON	reason,
		int	elapsed
	)

远端音频流状态发生改变回调。

远端用户/主播音频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端音频流状态。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid	发生音频状态改变的远端用户 ID。
state	远端音频流状态。详见 REMOTE_AUDIO_STATE 。
reason	远端音频流状态改变的具体原因。详见 REMOTE_AUDIO_STATE_REASON 。
elapsed	从本地用户调用 JoinChannelByKey 方法到发生本事件经历的时间，单位为 ms。

◆ OnLocalAudioStatsHandler()

delegate void agora_gaming_rtc.OnLocalAudioStatsHandler ( LocalAudioStats localAudioStats )

通话中本地音频流的统计信息回调。

该回调描述本地设备发送音频流的统计信息。SDK 每 2 秒触发该回调一次。

参数

localAudioStats 本地音频统计数据。详见 LocalAudioStats 。

◆ OnChannelMediaRelayStateChangedHandler()

delegate void agora_gaming_rtc.OnChannelMediaRelayStateChangedHandler	(	CHANNEL_MEDIA_RELAY_STATE	state,
		CHANNEL_MEDIA_RELAY_ERROR	code
	)

跨频道媒体流转发状态发生改变回调。

当跨频道媒体流转发状态发生改变时，SDK 会触发该回调，并报告当前的转发状态以及相关的错误信息。

参数

state	跨频道媒体流转发状态。详见 CHANNEL_MEDIA_RELAY_STATE 。
code	跨频道媒体流转发出错的错误码。详见 CHANNEL_MEDIA_RELAY_ERROR 。

◆ OnChannelMediaRelayEventHandler()

delegate void agora_gaming_rtc.OnChannelMediaRelayEventHandler ( CHANNEL_MEDIA_RELAY_EVENT events )

跨频道媒体流转发事件回调。该回调报告跨频道媒体流转发过程中发生的事件。

参数

events 跨频道媒体流转发事件码。详见 CHANNEL_MEDIA_RELAY_EVENT 。

◆ OnFacePositionChangedHandler()

delegate void agora_gaming_rtc.OnFacePositionChangedHandler	(	int	imageWidth,
		int	imageHeight,
		Rectangle	vecRectangle,
		int	vecDistance,
		int	numFaces
	)

报告本地人脸检测结果。仅适用于 Android 和 iOS 平台。

自从: v3.0.1

调用 EnableFaceDetection(true) 开启本地人脸检测后，你可以通过该回调实时获取以下人脸检测的信息：

摄像头采集的画面大小
人脸在画面中的位置
人脸距设备屏幕的距离

其中，人脸距设备屏幕的距离由 SDK 通过摄像头采集的画面大小和人脸在画面中的位置拟合计算得出。

注解

当检测到摄像头前没有人脸时，该回调触发频率会降低，以节省设备耗能。
当人脸距离设备屏幕过近时，SDK 不会触发该回调。
Android 平台上，人脸距设备屏幕的距离（vecDistance）值有一定误差，请不要用它进行精确计算。

参数

imageWidth	摄像头采集画面的宽度 (px)。
imageHeight	摄像头采集画面的高度 (px)。
vecRectangle	检测到的人脸信息： `x`：人脸在画面中的 x 坐标 (px)。以摄像头采集画面的左上角为原点，x 坐标为人脸左上角相对于原点的横向位移。 `y`：人脸在画面中的 y 坐标 (px)。以摄像头采集画面的左上角为原点，y 坐标为人脸左上角相对原点的纵向位移。 `width`：人脸在画面中的宽度 (px)。 `height`：人脸在画面中的高度 (px)。
vecDistance	人脸距设备屏幕的距离 (cm)。
numFaces	检测的人脸数量。如果为 `0`，则表示没有检测到人脸。

◆ OnRtmpStreamingEventHandler()

delegate void agora_gaming_rtc.OnRtmpStreamingEventHandler	(	string	url,
		RTMP_STREAMING_EVENT	eventCode
	)

RTMP/RTMPS 推流事件回调。

自从: v3.2.0

参数

url	RTMP/RTMPS 推流 URL。
eventCode	RTMP/RTMPS 推流事件码。详见 RTMP_STREAMING_EVENT

◆ OnAudioPublishStateChangedHandler()

delegate void agora_gaming_rtc.OnAudioPublishStateChangedHandler	(	string	channel,
		STREAM_PUBLISH_STATE	oldState,
		STREAM_PUBLISH_STATE	newState,
		int	elapseSinceLastState
	)

音频发布状态改变回调。

自从: v3.2.0

参数

channel	频道名
oldState	之前的发布状态，详见 STREAM_PUBLISH_STATE
newState	当前的发布状态，详见 STREAM_PUBLISH_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）

◆ OnVideoPublishStateChangedHandler()

delegate void agora_gaming_rtc.OnVideoPublishStateChangedHandler	(	string	channel,
		STREAM_PUBLISH_STATE	oldState,
		STREAM_PUBLISH_STATE	newState,
		int	elapseSinceLastState
	)

视频发布状态改变回调。

自从: v3.2.0

参数

channel	频道名
oldState	之前的发布状态，详见 STREAM_PUBLISH_STATE
newState	当前的发布状态，详见 STREAM_PUBLISH_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）

◆ OnAudioSubscribeStateChangedHandler()

delegate void agora_gaming_rtc.OnAudioSubscribeStateChangedHandler	(	string	channel,
		uint	uid,
		STREAM_SUBSCRIBE_STATE	oldState,
		STREAM_SUBSCRIBE_STATE	newState,
		int	elapseSinceLastState
	)

音频订阅状态发生改变回调。

自从: v3.2.0

参数

channel	频道名
uid	远端用户的 ID。
oldState	之前的发布状态，详见 STREAM_SUBSCRIBE_STATE
newState	当前的发布状态，详见 STREAM_SUBSCRIBE_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）

◆ OnVideoSubscribeStateChangedHandler()

delegate void agora_gaming_rtc.OnVideoSubscribeStateChangedHandler	(	string	channel,
		uint	uid,
		STREAM_SUBSCRIBE_STATE	oldState,
		STREAM_SUBSCRIBE_STATE	newState,
		int	elapseSinceLastState
	)

视频订阅状态发生改变回调。

自从: v3.2.0

参数

channel	频道名
uid	远端用户的 ID。
oldState	之前的发布状态，详见 STREAM_SUBSCRIBE_STATE
newState	当前的发布状态，详见 STREAM_SUBSCRIBE_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）

◆ OnFirstLocalAudioFramePublishedHandler()

delegate void agora_gaming_rtc.OnFirstLocalAudioFramePublishedHandler ( int elapsed )

已发布本地音频首帧回调。

自从: v3.2.0

SDK 会在以下三种时机触发该回调：

开启本地音频的情况下，调用 JoinChannelByKey 成功加入频道后。
调用 MuteLocalAudioStream(true)，再调用 MuteLocalAudioStream(false) 后。
调用 DisableAudio，再调用 EnableAudio 后。

参数

elapsed 从调用 JoinChannelByKey 方法到触发该回调的时间间隔（毫秒）。

◆ OnFirstLocalVideoFramePublishedHandler()

delegate void agora_gaming_rtc.OnFirstLocalVideoFramePublishedHandler ( int elapsed )

已发布本地视频首帧回调。

自从: v3.2.0

SDK 会在以下三种时机触发该回调：

开启本地视频的情况下，调用 JoinChannelByKey 成功加入频道后。
调用 MuteLocalVideoStream(true)，再调用 MuteLocalVideoStream(false) 后。
调用 DisableVideo，再调用 EnableVideo 后。

参数

elapsed 从调用 JoinChannelByKey 到触发该回调的时间间隔（毫秒）。

◆ OnUserSuperResolutionEnabledHandler()

delegate void agora_gaming_rtc.OnUserSuperResolutionEnabledHandler	(	uint	uid,
		bool	enabled,
		SUPER_RESOLUTION_STATE_REASON	reason
	)

报告超分辨率功能是否成功开启。

自从: v3.6.1.1

调用 EnableRemoteSuperResolution后， SDK 触发该回调报告超分辨率是否成功开启。如果未成功开启，请通过 reason 排查问题。

参数

uid	远端用户 ID。
enabled	是否对远端视频成功开启超分辨率： true: 成功开启超分辨率。 false: 未成功开启超分辨率。
reason	超分辨率未成功开启的原因，详见 SUPER_RESOLUTION_STATE_REASON 。

◆ OnVirtualBackgroundSourceEnabledHandler()

delegate void agora_gaming_rtc.OnVirtualBackgroundSourceEnabledHandler	(	bool	enabled,
		VIRTUAL_BACKGROUND_SOURCE_STATE_REASON	reason
	)

报告虚拟背景是否成功开启。（beta 功能）

自从: v3.4.5

调用 EnableVirtualBackground 后，SDK 触发该回调报告虚拟背景是否成功开启。

注解: 如果虚拟背景中自定义的背景图为 PNG、JPG 格式的图片，该回调的触发时机会延迟到图片读取完毕。

参数

enabled	是否已成功开启虚拟背景： true: 成功开启虚拟背景。 false: 未成功开启虚拟背景。
reason	虚拟背景开启出错的原因或开启成功的提示。详见 VIRTUAL_BACKGROUND_SOURCE_STATE_REASON 。

◆ OnRequestAudioFileInfoHandler()

delegate void agora_gaming_rtc.OnRequestAudioFileInfoHandler	(	AudioFileInfo	info,
		AUDIO_FILE_INFO_ERROR	error
	)

音频文件信息回调。

自从: v3.6.1.1

成功调用 GetAudioFileInfo 后，SDK 会触发该回调并报告音频文件的路径、时长等信息。

参数

info	音频文件信息，详见 AudioFileInfo 。
error	信息获取状态，详见 AUDIO_FILE_INFO_ERROR 。

◆ OnSnapshotTakenHandler()

delegate void agora_gaming_rtc.OnSnapshotTakenHandler	(	string	channel,
		uint	uid,
		string	filePath,
		int	width,
		int	height,
		int	errCode
	)

视频截图结果回调。

自从: v3.6.1.1

成功调用 TakeSnapshot 后，SDK 触发该回调报告截图是否成功和获取截图的详情。

参数

channel	频道名。
uid	用户 ID。如果 `uid` 为 0，表示本地用户。
filePath	截图的本地保存路径。
width	图片宽度（px）。
height	图片高度（px）。
errCode	截图成功的提示或失败的原因。 `0`: 截图成功。 < 0: 截图失败: `-1`: 写入文件失败或 JPEG 编码失败。 `-2`: TakeSnapshot 方法调用成功后 1 秒内没有发现指定用户的视频流。

◆ OnClientRoleChangeFailedHandler()

delegate void agora_gaming_rtc.OnClientRoleChangeFailedHandler	(	CLIENT_ROLE_CHANGE_FAILED_REASON	reason,
		CLIENT_ROLE_TYPE	currentRole
	)

直播场景下切换用户角色失败回调。

自从: v3.7.0 直播场景下，本地用户加入频道后调用 SetClientRole 切换用户角色失败时，SDK 会触发该回调，报告切换失败的原因和当前的用户角色。

参数

reason	切换用户角色失败的原因。详见 CLIENT_ROLE_CHANGE_FAILED_REASON 。
currentRole	当前的用户角色。详见 CLIENT_ROLE_TYPE 。

◆ OnAudioDeviceTestVolumeIndicationHandler()

delegate void agora_gaming_rtc.OnAudioDeviceTestVolumeIndicationHandler	(	AudioDeviceTestVolumeType	volumeType,
		int	volume
	)

音频设备测试回调。

自从: 3.7.0 成功调用 StartAudioRecordingDeviceTest、 StartAudioPlaybackDeviceTest 或 StartAudioDeviceLoopbackTest 方法开启音频设备测试后， SDK 会按设置的时间间隔触发该回调，报告被测试音频设备的音量信息。

参数

volumeType	音量类型。详见 AudioDeviceTestVolumeType。
volume	音量大小，范围为 [0,255]。

◆ OnProxyConnectedHandler()

delegate void agora_gaming_rtc.OnProxyConnectedHandler	(	string	channel,
		uint	uid,
		PROXY_TYPE	proxyType,
		string	localProxyIp,
		int	elapsed
	)

代理连接状态回调。

自从: 3.7.0 通过该回调你可以监听 SDK 连接代理的状态。例如，当用户调用 SetCloudProxy 或 setLocalAccessPoint 设置代理或本地代理并成功加入频道后， SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 JoinChannel 到触发该回调经过的时间等。

参数

channel	频道名称。
uid	用户 ID。
proxyType	连接上的代理类型。详见 PROXY_TYPE 。
localProxyIp	本地代理的 IP 地址。当 proxyType 的值不为 3 时，该参数的值为空。
elapsed	从调用 `JoinChannel` 到 SDK 触发该回调的经过的时间（毫秒）。

◆ OnWlAccMessageHandler()

delegate void agora_gaming_rtc.OnWlAccMessageHandler	(	WLACC_MESSAGE_REASON	reason,
		WLACC_SUGGEST_ACTION	action,
		string	wlAccMsg
	)

报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。

自从: 3.7.0 调用 EnableWirelessAccelerate(true) 开启 Wi-Fi 加速功能后，当 Wi-Fi 连接质量不佳时，SDK 会触发该回调，报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。

注解: 声网强烈建议你在 app 中展示将该回调报告的 action 和 wlAccMsg，提示用户采取网络优化措施，以获得更好的音视频体验。

参数

reason	Wi-Fi 连接质量不佳的原因。详见 WLACC_MESSAGE_REASON 。
action	改善 Wi-Fi 连接质量的操作建议。详见 WLACC_SUGGEST_ACTION 。
wlAccMsg	根据 `action` 的值提供的详细帮助信息：当 `action` 为 `WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI`，该参数的值为 `NULL`。当 `action` 为 `WLACC_SUGGEST_ACTION_CONNECT_SSID`，该参数的值为推荐用户连接的网络名称（SSID）。当 `action` 为 `WLACC_SUGGEST_ACTION_CHECK_5G`，该参数的值为开启路由器 5G 频道的操作步骤的链接。当 `action` 为 `WLACC_SUGGEST_ACTION_MODIFY_SSID`，该参数的值为修改网络名称（SSID）的操作步骤的链接。

◆ OnWlAccStatsHandler()

delegate void agora_gaming_rtc.OnWlAccStatsHandler	(	WlAccStats	currentStats,
		WlAccStats	averageStats
	)

报告 Wi-Fi 加速效果。

自从: 3.7.0 调用 EnableWirelessAccelerate(true) 开启 Wi-Fi 加速功能后，SDK 每隔两秒触发一次该回调，报告当前的 Wi-Fi 加速效果和自加入频道后平均的 Wi-Fi 加速效果。Wi-Fi 加速效果用端到端延时、丢包率和音视频卡顿率三个指标下降的百分比来衡量。

参数

currentStats	当前的 Wi-Fi 加速效果。详见 WlAccStats。
averageStats	自加入频道后平均的 Wi-Fi 加速效果。详见 WlAccStats。

◆ OnScreenCaptureInfoUpdatedHandler()

delegate void agora_gaming_rtc.OnScreenCaptureInfoUpdatedHandler ( ScreenCaptureInfo info )

屏幕共享信息更新回调。

自从: 3.7.0 调用 StartScreenCaptureByDisplayId 或 StartScreenCaptureByScreenRect 开启屏幕共享，并通过 excludeWindowList 屏蔽指定窗口时，如果窗口屏蔽失败，SDK 会触发该回调。

注解: 该回调仅适用于 Windows。

参数

info	屏幕共享信息。详见 ScreenCaptureInfo。

◆ ChannelOnWarningHandler()

delegate void agora_gaming_rtc.ChannelOnWarningHandler	(	string	channelId,
		int	warn,
		string	message
	)

发生警告回调。

参数

channelId	频道 ID。
warn	警告代码：Warning Code。
message	警告描述。

◆ ChannelOnErrorHandler()

delegate void agora_gaming_rtc.ChannelOnErrorHandler	(	string	channelId,
		int	err,
		string	message
	)

发生错误回调。

参数

channelId	频道 ID。
err	错误代码：Error Code。
message	错误描述。

◆ ChannelOnJoinChannelSuccessHandler()

delegate void agora_gaming_rtc.ChannelOnJoinChannelSuccessHandler	(	string	channelId,
		uint	uid,
		int	elapsed
	)

加入频道回调。

该回调方法表示该客户端成功加入了指定的频道。

频道名基于 JoinChannel 中指定的 channelId 分配。

如果调用 JoinChannel 时并没有指定 uid。服务器会自动分配一个。

参数

channelId	频道 ID。
uid	用户 ID。如果 `JoinChannel` 中指定了 `uid`，则此处返回该 ID；否则使用声网服务器自动分配的 ID。
elapsed	从 `JoinChannel` 开始到发生此事件过去的时间（毫秒）。

◆ ChannelOnReJoinChannelSuccessHandler()

delegate void agora_gaming_rtc.ChannelOnReJoinChannelSuccessHandler	(	string	channelId,
		uint	uid,
		int	elapsed
	)

重新加入频道回调。

有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。

参数

channelId	频道 ID。
uid	用户 ID。
elapsed	从开始重连到重连成功的时间（毫秒）。

◆ ChannelOnLeaveChannelHandler()

delegate void agora_gaming_rtc.ChannelOnLeaveChannelHandler	(	string	channelId,
		RtcStats	rtcStats
	)

离开频道回调。

app 调用 LeaveChannel 方法时，SDK 提示 app 离开频道成功。在该回调方法中，app 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。app 通过该回调获取通话时长以及 SDK 接收到或发送的数据统计信息。

参数

channelId	频道 ID。
rtcStats	通话的统计数据: RtcStats 。

◆ ChannelOnClientRoleChangedHandler()

delegate void agora_gaming_rtc.ChannelOnClientRoleChangedHandler	(	string	channelId,
		CLIENT_ROLE_TYPE	oldRole,
		CLIENT_ROLE_TYPE	newRole
	)

直播场景下用户角色切换成功回调。

参数

channelId	频道 ID。
oldRole	切换前的角色: CLIENT_ROLE_TYPE 。
newRole	切换后的角色: CLIENT_ROLE_TYPE 。

◆ ChannelOnUserJoinedHandler()

delegate void agora_gaming_rtc.ChannelOnUserJoinedHandler	(	string	channelId,
		uint	uid,
		int	elapsed
	)

远端用户（通信场景）/主播（直播场景）加入当前频道回调。

通信场景下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
直播场景下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。声网建议连麦主播不超过 17 人。

该回调在如下情况下会被触发：

远端用户/主播调用 JoinChannel 方法加入频道。
远端用户加入频道后调用 SetClientRole 将用户角色改变为主播。
远端用户/主播网络中断后重新加入频道。

注解

直播场景下：

主播间能相互收到新主播加入频道的回调，并能获得该主播的 uid。
观众也能收到新主播加入频道的回调，并能获得该主播的 uid。
当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调。

参数

channelId	频道 ID。
uid	新加入频道的远端用户/主播 ID。
elapsed	从本地用户调用 `JoinChannel` 到该回调触发的延迟（毫秒)。

◆ ChannelOnUserOffLineHandler()

delegate void agora_gaming_rtc.ChannelOnUserOffLineHandler	(	string	channelId,
		uint	uid,
		USER_OFFLINE_REASON	reason
	)

远端用户（通信场景）/主播（直播场景）离开当前频道回调。

提示有远端用户/主播离开了频道（或掉线）。用户离开频道有两个原因，即正常离开和超时掉线：

正常离开的时候，远端用户/主播会发送类似“再见”的消息。接收此消息后，判断用户离开频道。
超时掉线的依据是，在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。建议使用声网 RTM SDK 来做可靠的掉线检测。

参数

channelId	频道 ID。
uid	离线用户或主播的用户 ID。
reason	离线原因: USER_OFFLINE_REASON 。

◆ ChannelOnConnectionLostHandler()

delegate void agora_gaming_rtc.ChannelOnConnectionLostHandler ( string channelId )

网络连接丢失回调。

SDK 在调用 JoinChannel 后无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。

与 OnConnectionInterruptedHandler 的区别是：

OnConnectionInterruptedHandler 回调一定是发生在加入频道成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
ChannelOnConnectionLostHandler 回调是无论之前加入频道是否成功，只要 10 秒内和服务器无法建立连接都会触发。

如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

参数

channelId 频道 ID。

◆ ChannelOnRequestTokenHandler()

delegate void agora_gaming_rtc.ChannelOnRequestTokenHandler ( string channelId )

Token 已过期回调。

在调用 JoinChannel, 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中 SDK 可能由于网络原因和服务器失去连接，重连时可能需要新的 Token。

该回调通知 app 需要生成新的 Token，然后调用 JoinChannel，并使用新的 Token 重新加入频道。

参数

channelId 频道 ID。

◆ ChannelOnTokenPrivilegeWillExpireHandler()

delegate void agora_gaming_rtc.ChannelOnTokenPrivilegeWillExpireHandler	(	string	channelId,
		string	token
	)

Token 服务即将过期回调。

在调用 JoinChannel 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 app 更新 Token。当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 RenewToken 将新生成的 Token 传给 SDK。

参数

channelId	频道 ID。
token	即将服务失效的 Token。

◆ ChannelOnRtcStatsHandler()

delegate void agora_gaming_rtc.ChannelOnRtcStatsHandler	(	string	channelId,
		RtcStats	rtcStats
	)

当前通话统计回调。SDK 定期向 app 报告当前通话的统计信息，每两秒触发一次。

参数

channelId	频道 ID。
rtcStats	AgoraChannel 引擎统计数据: RtcStats 。

◆ ChannelOnNetworkQualityHandler()

delegate void agora_gaming_rtc.ChannelOnNetworkQualityHandler	(	string	channelId,
		uint	uid,
		int	txQuality,
		int	rxQuality
	)

通话中每个用户的网络上下行 last mile 质量报告回调。

参数

channelId	频道 ID。
uid	用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。当 `uid` 为 `0` 时，返回的是本地用户的网络质量。
txQuality	该用户的上行网络质量，基于发送码率、上行丢包率、平均往返时延和网络抖动计算。该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。假设上行码率是 1000 Kbps，那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题，但是支持 1280 × 720 的分辨率就会有困难。详见 QUALITY_TYPE 。
rxQuality	该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 QUALITY_TYPE 。

◆ ChannelOnRemoteVideoStatsHandler()

delegate void agora_gaming_rtc.ChannelOnRemoteVideoStatsHandler	(	string	channelId,
		RemoteVideoStats	remoteVideoStats
	)

通话中远端视频流的统计信息回调。

参数

channelId	频道 ID。
remoteVideoStats	远端视频统计数据。详见: RemoteVideoStats 。

◆ ChannelOnRemoteAudioStatsHandler()

delegate void agora_gaming_rtc.ChannelOnRemoteAudioStatsHandler	(	string	channelId,
		RemoteAudioStats	remoteAudioStats
	)

通话中远端音频流的统计信息回调。用于取代 OnAudioQualityHandler 回调。

参数

channelId	频道 ID。
remoteAudioStats	接收到的远端音频统计数据，详细定义见: RemoteAudioStats 。

◆ ChannelOnRemoteAudioStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnRemoteAudioStateChangedHandler	(	string	channelId,
		uint	uid,
		REMOTE_AUDIO_STATE	state,
		REMOTE_AUDIO_STATE_REASON	reason,
		int	elapsed
	)

远端音频流状态发生改变回调。

远端用户/主播音频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端音频流状态。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

channelId	频道 ID。
uid	发生音频状态改变的远端用户 ID。
state	远端音频流状态。详见 REMOTE_AUDIO_STATE 。
reason	远端音频流状态改变的具体原因。详见 REMOTE_AUDIO_STATE_REASON 。
elapsed	从本地用户调用 JoinChannel 方法到发生本事件经历的时间，单位为 ms。

◆ ChannelOnActiveSpeakerHandler()

delegate void agora_gaming_rtc.ChannelOnActiveSpeakerHandler	(	string	channelId,
		uint	uid
	)

监测到最活跃用户回调。

当频道内用户数量大于或等于 2 且有活跃用户时，SDK 会触发该回调并报告最活跃用户的 uid。

如果最活跃用户一直是同一位用户，则 SDK 不会再次触发 ChannelOnActiveSpeakerHandler 回调。
如果最活跃用户有变化，则 SDK 会再次触发该回调并报告新的最活跃用户的 uid。

参数

channelId	频道 ID。
uid	远端最活跃用户的 ID。

◆ ChannelOnVideoSizeChangedHandler()

delegate void agora_gaming_rtc.ChannelOnVideoSizeChangedHandler	(	string	channelId,
		uint	uid,
		int	width,
		int	height,
		int	rotation
	)

本地或远端视频大小和旋转信息发生改变回调。

参数

channelId	频道 ID。
uid	图像尺寸和旋转信息发生变化的用户的用户 ID（本地用户的 `uid` 为 `0`）。
width	视频流的宽度（像素）。
height	视频流的高度（像素）。
rotation	旋转信息 [0,360) 。

◆ ChannelOnRemoteVideoStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnRemoteVideoStateChangedHandler	(	string	channelId,
		uint	uid,
		REMOTE_VIDEO_STATE	state,
		REMOTE_VIDEO_STATE_REASON	reason,
		int	elapsed
	)

远端视频状态发生改变回调。

注解: 频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

channelId	频道 ID。
uid	发生视频状态改变的远端用户 ID。
state	远端视频流状态。详见 REMOTE_VIDEO_STATE 。
reason	远端视频流状态改变的具体原因。详见 REMOTE_VIDEO_STATE_REASON 。
elapsed	从本地用户调用 JoinChannel 方法到发生本事件经历的时间，单位为 ms。

◆ ChannelOnStreamMessageHandler()

delegate void agora_gaming_rtc.ChannelOnStreamMessageHandler	(	string	channelId,
		uint	uid,
		int	streamId,
		string	data,
		int	length
	)

接收到对方数据流消息的回调。

该回调表示本地用户收到了远端用户调用 SendStreamMessage 方法发送的流消息。

参数

channelId	频道 ID。
uid	发送消息的用户 ID。
streamId	数据流 ID。
data	接收到的数据流。
length	数据流长度。

◆ ChannelOnStreamMessageErrorHandler()

delegate void agora_gaming_rtc.ChannelOnStreamMessageErrorHandler	(	string	channelId,
		uint	uid,
		int	streamId,
		int	code,
		int	missed,
		int	cached
	)

接收对方数据流消息发生错误的回调。

该回调表示本地用户未收到远端用户调用 SendStreamMessage 方法发送的流消息。

参数

channelId	频道 ID。
uid	发送消息的用户 ID。
streamId	Stream ID。
code	错误码: Error Code。
missed	丢失的消息数量。
cached	数据流中断时，后面缓存的消息数量。

◆ ChannelOnMediaRelayStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnMediaRelayStateChangedHandler	(	string	channelId,
		CHANNEL_MEDIA_RELAY_STATE	state,
		CHANNEL_MEDIA_RELAY_ERROR	code
	)

跨频道媒体流转发状态发生改变回调。

当跨频道媒体流转发状态发生改变时，SDK 会触发该回调，并报告当前的转发状态以及相关的错误信息。

参数

channelId	频道 ID。
state	跨频道媒体流转发状态。详见 CHANNEL_MEDIA_RELAY_STATE 。
code	跨频道媒体流转发出错的错误码。详见 CHANNEL_MEDIA_RELAY_ERROR 。

◆ ChannelOnMediaRelayEventHandler()

delegate void agora_gaming_rtc.ChannelOnMediaRelayEventHandler	(	string	channelId,
		CHANNEL_MEDIA_RELAY_EVENT	events
	)

跨频道媒体流转发事件回调。该回调报告跨频道媒体流转发过程中发生的事件。

参数

channelId	频道 ID。
events	跨频道媒体流转发事件码。详见 CHANNEL_MEDIA_RELAY_EVENT 。

◆ ChannelOnRtmpStreamingStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnRtmpStreamingStateChangedHandler	(	string	channelId,
		string	url,
		RTMP_STREAM_PUBLISH_STATE	state,
		RTMP_STREAM_PUBLISH_ERROR	errCode
	)

RTMP 推流状态发生改变回调。

该回调返回本地用户调用 AddPublishStreamUrl 或 RemovePublishStreamUrl 方法的结果。

RTMP 推流状态发生改变时，SDK 会触发该回调，并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态；推流出错时，你可以通过返回的错误码了解出错的原因，方便排查问题。

参数

channelId	频道 ID。
url	推流状态发生改变的 URL 地址。
state	当前的推流状态，详见 RTMP_STREAM_PUBLISH_STATE 。当推流状态为 `RTMP_STREAM_PUBLISH_STATE_FAILURE(4)`，你可以在 `errCode` 参数中查看返回的错误信息。
errCode	推流错误信息，详见 RTMP_STREAM_PUBLISH_ERROR_TYPE 。

◆ ChannelOnTranscodingUpdatedHandler()

delegate void agora_gaming_rtc.ChannelOnTranscodingUpdatedHandler ( string channelId )

旁路推流设置已被更新回调。

当 SetLiveTranscoding 方法中的直播参数 LiveTranscoding 更新时，ChannelOnTranscodingUpdatedHandler 回调会被触发并向主播报告更新信息。

注解: 首次调用SetLiveTranscoding 方法设置转码参数 LiveTranscoding 时，不会触发此回调。

参数

channelId 频道 ID。

◆ ChannelOnRemoteSubscribeFallbackToAudioOnlyHandler()

delegate void agora_gaming_rtc.ChannelOnRemoteSubscribeFallbackToAudioOnlyHandler	(	string	channelId,
		uint	uid,
		bool	isFallbackOrRecover
	)

远端订阅流已回退为音频流回调。

注解: 远端订阅流因弱网环境不能同时满足音视频而回退为小流时，你可以使用 ChannelOnRemoteVideoStatsHandler 来监控远端视频大小流的切换。

参数

channelId	频道 ID。
uid	远端用户的用户 ID。
isFallbackOrRecover	true: 由于网络环境不理想，远端订阅流已回退为音频流； false: 由于网络环境改善，订阅的音频流已恢复为音视频流。

◆ ChannelOnConnectionStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnConnectionStateChangedHandler	(	string	channelId,
		CONNECTION_STATE_TYPE	state,
		CONNECTION_CHANGED_REASON_TYPE	reason
	)

网络连接状态已改变回调。该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态和引起网络状态改变的原因。

参数

channelId	频道 ID。
state	详见： CONNECTION_STATE_TYPE 。
reason	详见： CONNECTION_CHANGED_REASON_TYPE 。

◆ ChannelOnLocalPublishFallbackToAudioOnlyHandler()

delegate void agora_gaming_rtc.ChannelOnLocalPublishFallbackToAudioOnlyHandler	(	string	channelId,
		bool	isFallbackOrRecover
	)

本地发布流已回退为音频流回调。

参数

channelId	频道 ID。
isFallbackOrRecover	true: 由于网络环境不理想，本地发布的媒体流已回退为音频流； false: 由于网络环境改善，发布的音频流已恢复为音视频流。

◆ ChannelOnRtmpStreamingEventHandler()

delegate void agora_gaming_rtc.ChannelOnRtmpStreamingEventHandler	(	string	channelId,
		string	url,
		RTMP_STREAMING_EVENT	eventCode
	)

RTMP/RTMPS 推流事件回调。

自从: v3.2.0

参数

channelId	频道 ID。
url	RTMP/RTMPS 推流 URL。
eventCode	CDN 推流事件码。详见 RTMP_STREAMING_EVENT

◆ ChannelOnAudioPublishStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnAudioPublishStateChangedHandler	(	string	channelId,
		STREAM_PUBLISH_STATE	oldState,
		STREAM_PUBLISH_STATE	newState,
		int	elapseSinceLastState
	)

音频发布状态改变回调。

自从: v3.2.0

参数

channelId	频道 ID。
oldState	之前的发布状态，详见 STREAM_PUBLISH_STATE
newState	当前的发布状态，详见 STREAM_PUBLISH_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）。

◆ ChannelOnVideoPublishStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnVideoPublishStateChangedHandler	(	string	channelId,
		STREAM_PUBLISH_STATE	oldState,
		STREAM_PUBLISH_STATE	newState,
		int	elapseSinceLastState
	)

视频发布状态改变回调。

自从: v3.2.0

参数

channelId	频道 ID。
oldState	之前的发布状态，详见 STREAM_PUBLISH_STATE
newState	当前的发布状态，详见 STREAM_PUBLISH_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）。

◆ ChannelOnAudioSubscribeStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnAudioSubscribeStateChangedHandler	(	string	channelId,
		uint	uid,
		STREAM_SUBSCRIBE_STATE	oldState,
		STREAM_SUBSCRIBE_STATE	newState,
		int	elapseSinceLastState
	)

音频订阅状态发生改变回调。

自从: v3.2.0

参数

channelId	频道 ID。
uid	远端用户的 ID。
oldState	之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE
newState	当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）。

◆ ChannelOnVideoSubscribeStateChangedHandler()

delegate void agora_gaming_rtc.ChannelOnVideoSubscribeStateChangedHandler	(	string	channelId,
		uint	uid,
		STREAM_SUBSCRIBE_STATE	oldState,
		STREAM_SUBSCRIBE_STATE	newState,
		int	elapseSinceLastState
	)

视频订阅状态发生改变回调。

自从: v3.2.0

参数

channelId	频道 ID。
uid	远端用户的 ID。
oldState	之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE
newState	当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE
elapseSinceLastState	两次状态变化时间间隔（毫秒）。

◆ ChannelOnUserSuperResolutionEnabledHandler()

delegate void agora_gaming_rtc.ChannelOnUserSuperResolutionEnabledHandler	(	string	channelId,
		uint	uid,
		bool	enabled,
		SUPER_RESOLUTION_STATE_REASON	reason
	)

报告超分辨率算法是否成功开启。

自从: v3.2.0

调用 EnableRemoteSuperResolution 后， SDK 触发该回调报告超级分辨率算法是否成功开启。如果未成功开启，请通过 reason 排查问题。

参数

channelId	频道 ID。
uid	远端用户 ID。
enabled	是否对远端视频成功开启超级分辨率算法： true: 成功开启超级分辨率算法。 false: 未成功开启超级分辨率算法。
reason	超级分辨率算法未成功开启的原因，详见 SUPER_RESOLUTION_STATE_REASON

◆ ChannelOnClientRoleChangeFailedHandler()

delegate void agora_gaming_rtc.ChannelOnClientRoleChangeFailedHandler	(	string	channelId,
		CLIENT_ROLE_CHANGE_FAILED_REASON	reason,
		CLIENT_ROLE_TYPE	currentRole
	)

直播场景下切换用户角色失败回调。

自从: v3.7.0 直播场景下，本地用户加入频道后调用 SetClientRole 切换用户角色失败时，SDK 会触发该回调，报告切换失败的原因和当前的用户角色。

参数

channelId	频道 ID。
reason	切换用户角色失败的原因。详见 CLIENT_ROLE_CHANGE_FAILED_REASON 。
currentRole	当前的用户角色。详见 CLIENT_ROLE_TYPE 。

◆ ChannelOnFirstRemoteVideoFrameHandler()

delegate void agora_gaming_rtc.ChannelOnFirstRemoteVideoFrameHandler	(	string	channelId,
		uint	uid,
		int	width,
		int	height,
		int	elapsed
	)

已显示首帧远端视频回调。

自从: v3.7.0 第一帧远端视频显示在视图上时，触发此调用。 App 可在此调用中获知出图时间（elapsed）。

参数

channelId	频道 ID。
uid	用户 ID，指定是哪个用户的视频流。
width	视频流宽（px）。
height	视频流高（px）。
elapsed	从本地调用 `JoinChannel` 到发生此事件过去的时间（毫秒)。

◆ ChannelOnChannelProxyConnectedHandler()

delegate void agora_gaming_rtc.ChannelOnChannelProxyConnectedHandler	(	string	channelId,
		uint	uid,
		PROXY_TYPE	proxyType,
		string	localProxyIp,
		int	elapsed
	)

代理连接状态回调。

自从: 3.7.0 通过该回调你可以监听 SDK 连接代理的状态。例如，当用户调用 SetCloudProxy 或 setLocalAccessPoint 设置云代理或本地代理并成功加入频道后， SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 JoinChannel 到触发该回调经过的时间等。

参数

channelId	AgoraChannel 对象。
uid	用户 ID。
proxyType	连接上的代理类型。详见 PROXY_TYPE 。
localProxyIp	本地代理的 IP 地址。当 proxyType 的值不为 3 时，该参数的值为空。
elapsed	从调用 `JoinChannel` 到 SDK 触发该回调的经过的时间（毫秒）。