

语音通话 (Legacy)





C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

类
class	AAudioDeviceManager

struct	AdvancedConfigInfo

class	AParameter

struct	AudioFileInfo

struct	AudioRecordingConfiguration

struct	AudioVolumeInfo

class	AVideoDeviceManager

struct	BeautyOptions

struct	CameraCapturerConfiguration

struct	ChannelMediaInfo

struct	ChannelMediaOptions

struct	ChannelMediaRelayConfiguration

struct	ClientRoleOptions

struct	ColorEnhanceOptions

struct	ContentInspectConfig

struct	ContentInspectModule

struct	DataStreamConfig

struct	EchoTestConfiguration

struct	EncryptionConfig

class	IAudioDeviceCollection

class	IAudioDeviceManager

class	IChannel

class	IChannelEventHandler

class	IMediaRecorder

class	IMediaRecorderObserver

class	IMetadataObserver

class	IPacketObserver

class	IRtcEngine

class	IRtcEngine2

class	IRtcEngineEventHandler

class	IRtcEngineParameter

class	IScreenCaptureSourceList

class	IVideoDeviceCollection

class	IVideoDeviceManager

class	IVideoFrameConsumer

class	IVideoSink

class	IVideoSource

struct	LastmileProbeConfig

struct	LastmileProbeOneWayResult

struct	LastmileProbeResult

struct	LiveStreamAdvancedFeature

struct	LiveTranscoding

struct	LocalAccessPointConfiguration

struct	LocalAudioStats

struct	LocalVideoStats

struct	LogConfig

struct	LogUploadServerInfo

struct	LowLightEnhanceOptions

struct	MediaRecorderConfiguration

struct	RecorderInfo

struct	Rect

struct	Rectangle

struct	RemoteAudioStats

struct	RemoteVideoStats

struct	RtcEngineContext

struct	RtcImage

struct	RtcStats

struct	ScreenCaptureInfo

struct	ScreenCaptureParameters

struct	ScreenCaptureSourceInfo

struct	SIZE

struct	ThumbImageBuffer

struct	TranscodingUser

struct	UserInfo

struct	VideoCanvas

struct	VideoDenoiserOptions

struct	VideoDimensions

struct	VideoEncoderConfiguration

struct	VirtualBackgroundSource

struct	WatermarkOptions

struct	WlAccStats

类型定义
typedef unsigned int	uid_t

typedef void *	view_t

typedef struct agora::rtc::TranscodingUser	TranscodingUser

typedef struct agora::rtc::RtcImage	RtcImage

typedef struct agora::rtc::LiveStreamAdvancedFeature	LiveStreamAdvancedFeature

typedef struct agora::rtc::LiveTranscoding	LiveTranscoding

typedef struct agora::rtc::Rect	Rect

typedef struct agora::rtc::WatermarkOptions	WatermarkOptions

typedef int	ContentInspectType

枚举
enum	MAX_DEVICE_ID_LENGTH_TYPE { MAX_DEVICE_ID_LENGTH = 512 }

enum	MAX_USER_ACCOUNT_LENGTH_TYPE { MAX_USER_ACCOUNT_LENGTH = 256 }

enum	MAX_CHANNEL_ID_LENGTH_TYPE { MAX_CHANNEL_ID_LENGTH = 65 }

enum	QUALITY_REPORT_FORMAT_TYPE { QUALITY_REPORT_JSON = 0 , QUALITY_REPORT_HTML = 1 }

enum	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	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	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	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	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	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	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	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	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	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	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	RENDER_MODE_TYPE { RENDER_MODE_HIDDEN = 1 , RENDER_MODE_FIT = 2 , RENDER_MODE_ADAPTIVE = 3 , RENDER_MODE_FILL = 4 }

enum	SR_MODE { SR_MODE_MANUAL = 0 , SR_MODE_AUTO }

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

enum	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	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 }

enum	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 = 9 }

enum	CHANNEL_PROFILE_TYPE { CHANNEL_PROFILE_COMMUNICATION = 0 , CHANNEL_PROFILE_LIVE_BROADCASTING = 1 , CHANNEL_PROFILE_GAME = 2 }

enum	AUDIENCE_LATENCY_LEVEL_TYPE { AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1 , AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2 }

enum	CLIENT_ROLE_TYPE { CLIENT_ROLE_BROADCASTER = 1 , CLIENT_ROLE_AUDIENCE = 2 }

enum	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	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	USER_OFFLINE_REASON_TYPE { USER_OFFLINE_QUIT = 0 , USER_OFFLINE_DROPPED = 1 , USER_OFFLINE_BECOME_AUDIENCE = 2 }

enum	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	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	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	REMOTE_VIDEO_STREAM_TYPE { REMOTE_VIDEO_STREAM_HIGH = 0 , REMOTE_VIDEO_STREAM_LOW = 1 }

enum	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	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	AUDIO_SAMPLE_RATE_TYPE { AUDIO_SAMPLE_RATE_32000 = 32000 , AUDIO_SAMPLE_RATE_44100 = 44100 , AUDIO_SAMPLE_RATE_48000 = 48000 }

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

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

enum	VIDEO_CODEC_TYPE_FOR_STREAM { VIDEO_CODEC_H264_FOR_STREAM = 1 , VIDEO_CODEC_H265_FOR_STREAM = 2 }

enum	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	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	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	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 , AUDIO_ELECTRONIC_VOICE = 0x00300001 , AUDIO_THREEDIM_VOICE = 0x00400001 }

enum	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	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	VOICE_CONVERSION_PRESET { VOICE_CONVERSION_OFF = 0x00000000 , VOICE_CHANGER_NEUTRAL = 0x03010100 , VOICE_CHANGER_SWEET = 0x03010200 , VOICE_CHANGER_SOLID = 0x03010300 , VOICE_CHANGER_BASS = 0x03010400 }

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

enum	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	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	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	STREAM_PUBLISH_STATE { PUB_STATE_IDLE = 0 , PUB_STATE_NO_PUBLISHED = 1 , PUB_STATE_PUBLISHING = 2 , PUB_STATE_PUBLISHED = 3 }

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

enum	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	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	ORIENTATION_MODE { ORIENTATION_MODE_ADAPTIVE = 0 , ORIENTATION_MODE_FIXED_LANDSCAPE = 1 , ORIENTATION_MODE_FIXED_PORTRAIT = 2 }

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

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

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

enum	PRIORITY_TYPE { PRIORITY_HIGH = 50 , PRIORITY_NORMAL = 100 }

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

enum	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	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	LASTMILE_PROBE_RESULT_STATE { LASTMILE_PROBE_RESULT_COMPLETE = 1 , LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2 , LASTMILE_PROBE_RESULT_UNAVAILABLE = 3 }

enum	AUDIO_ROUTE_TYPE { 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 = 5 , AUDIO_ROUTE_USB = 6 , AUDIO_ROUTE_HDMI = 7 , AUDIO_ROUTE_DISPLAYPORT = 8 , AUDIO_ROUTE_AIRPLAY = 9 }

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

enum	LOCAL_PROXY_MODE { ConnectivityFirst = 0 , LocalOnly = 1 }

enum	EXCLUDE_WINDOW_ERROR { EXCLUDE_WINDOW_ERROR_FAIL = -1 , EXCLUDE_WINDOW_ERROR_NONE = 0 }

enum	PROXY_TYPE { NONE_PROXY_TYPE = 0 , UDP_PROXY_TYPE = 1 , TCP_PROXY_TYPE = 2 , LOCAL_PROXY_TYPE = 3 , TCP_PROXY_AUTO_FALLBACK_TYPE = 4 }

enum	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	CAMERA_DIRECTION { CAMERA_REAR = 0 , CAMERA_FRONT = 1 }

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

enum	AUDIO_FILE_INFO_ERROR { AUDIO_FILE_INFO_ERROR_OK = 0 , AUDIO_FILE_INFO_ERROR_FAILURE = 1 }

enum	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	WLACC_MESSAGE_REASON { WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0 , WLACC_MESSAGE_REASON_CHANNEL_CONGESTION = 1 }

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

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

enum	EXPERIENCE_QUALITY_TYPE { EXPERIENCE_QUALITY_GOOD = 0 , EXPERIENCE_QUALITY_BAD = 1 }

enum	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	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	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	CHANNEL_MEDIA_RELAY_STATE { RELAY_STATE_IDLE = 0 , RELAY_STATE_CONNECTING = 1 , RELAY_STATE_RUNNING = 2 , RELAY_STATE_FAILURE = 3 }

enum	AudioDeviceTestVolumeType { AudioTestRecordingVolume = 0 , AudioTestPlaybackVolume = 1 }

enum	RTMP_STREAM_LIFE_CYCLE_TYPE { RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1 , RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2 }

enum	VideoContentHint { CONTENT_HINT_NONE , CONTENT_HINT_MOTION , CONTENT_HINT_DETAILS }

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

enum	AREA_CODE { AREA_CODE_CN = 0x00000001 , AREA_CODE_NA = 0x00000002 , AREA_CODE_EU = 0x00000004 , AREA_CODE_AS = 0x00000008 , AREA_CODE_JP = 0x00000010 , AREA_CODE_IN = 0x00000020 , AREA_CODE_GLOB = 0xFFFFFFFF }

enum	ENCRYPTION_CONFIG { ENCRYPTION_FORCE_SETTING = (1 << 0) , ENCRYPTION_FORCE_DISABLE_PACKET = (1 << 1) }

enum	MAX_CONTENT_INSPECT_MODULE_TYPE { MAX_CONTENT_INSPECT_MODULE_COUNT = 32 }

enum	VIDEO_CAPTURE_TYPE { VIDEO_CAPTURE_UNKNOWN , VIDEO_CAPTURE_CAMERA , VIDEO_CAPTURE_SCREEN }

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

enum	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	MediaRecorderContainerFormat { FORMAT_MP4 = 1 , FORMAT_FLV = 2 }

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

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

enum	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 }

变量
const int	STANDARD_BITRATE = 0

const int	COMPATIBLE_BITRATE = -1

const int	DEFAULT_MIN_BITRATE = -1

const ContentInspectType	kContentInspectInvalid = 0

const ContentInspectType	kContentInspectModeration = 1

const ContentInspectType	kContentInspectSupervise = 2

类型定义说明

◆ uid_t

typedef unsigned int agora::rtc::uid_t

◆ view_t

typedef void* agora::rtc::view_t

◆ TranscodingUser

typedef struct agora::rtc::TranscodingUser agora::rtc::TranscodingUser

TranscodingUser 用于管理参与旁路直播的音视频转码合图的用户。最多支持 17 人同时参与转码合图。

◆ RtcImage

typedef struct agora::rtc::RtcImage agora::rtc::RtcImage

图像属性。

用于设置直播视频的水印和背景图片的属性。

◆ LiveStreamAdvancedFeature

typedef struct agora::rtc::LiveStreamAdvancedFeature agora::rtc::LiveStreamAdvancedFeature

转码推流的高级功能配置。

◆ LiveTranscoding

typedef struct agora::rtc::LiveTranscoding agora::rtc::LiveTranscoding

LiveTranscoding 定义。

◆ Rect

typedef struct agora::rtc::Rect agora::rtc::Rect

弃用:

◆ WatermarkOptions

typedef struct agora::rtc::WatermarkOptions agora::rtc::WatermarkOptions

待添加的水印图片的设置选项。

◆ ContentInspectType

typedef int agora::rtc::ContentInspectType

截图上传模块的类型:

0: （默认）该功能模块无实际功能。请不要将 type 设为该值。
1: 预留参数。
2: 截图。SDK 会对视频流进行截图并上传。

自从: v3.6.2

枚举类型说明

◆ MAX_DEVICE_ID_LENGTH_TYPE

enum agora::rtc::MAX_DEVICE_ID_LENGTH_TYPE

设备 ID 的最大长度。

枚举值
MAX_DEVICE_ID_LENGTH	设备 ID 的最大长度为 512 字

◆ MAX_USER_ACCOUNT_LENGTH_TYPE

enum agora::rtc::MAX_USER_ACCOUNT_LENGTH_TYPE

用户 User Account 的最大长度。

枚举值
MAX_USER_ACCOUNT_LENGTH	用户 User Account 的最大长度为 255 字。

◆ MAX_CHANNEL_ID_LENGTH_TYPE

enum agora::rtc::MAX_CHANNEL_ID_LENGTH_TYPE

频道名的最大长度。

枚举值
MAX_CHANNEL_ID_LENGTH	频道名的最大长度为 64 字。

◆ QUALITY_REPORT_FORMAT_TYPE

enum agora::rtc::QUALITY_REPORT_FORMAT_TYPE

质量报告的格式。

枚举值
QUALITY_REPORT_JSON	0: 质量报告格式为 JSON。
QUALITY_REPORT_HTML	1: 质量报告格式为 HTML。

◆ AUDIO_MIXING_STATE_TYPE

enum agora::rtc::AUDIO_MIXING_STATE_TYPE

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

枚举值
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::rtc::AUDIO_MIXING_ERROR_TYPE

混音音乐文件错误码。

弃用:: 自 v3.4.0 废弃，请改用 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: 音乐文件状态正常。

◆ AUDIO_MIXING_REASON_TYPE

enum agora::rtc::AUDIO_MIXING_REASON_TYPE

自从: v3.4.0

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

枚举值
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 恢复播放音乐文件。

◆ MEDIA_DEVICE_STATE_TYPE

enum agora::rtc::MEDIA_DEVICE_STATE_TYPE

设备状态（仅 Windows）。

枚举值
MEDIA_DEVICE_STATE_IDLE	0: 设备就绪。自从 v3.4.5
MEDIA_DEVICE_STATE_ACTIVE	1: 设备正在使用。自从 v3.4.5
MEDIA_DEVICE_STATE_DISABLED	2: 设备被禁用。
MEDIA_DEVICE_STATE_NOT_PRESENT	4: 没有此设备。
MEDIA_DEVICE_STATE_UNPLUGGED	8: 设备被拔出。
MEDIA_DEVICE_STATE_UNRECOMMENDED	16: 不推荐使用该设备。

◆ MEDIA_DEVICE_TYPE

enum agora::rtc::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: 音频应用播放设备。

◆ LOCAL_VIDEO_STREAM_STATE

enum agora::rtc::LOCAL_VIDEO_STREAM_STATE

本地视频状态

枚举值
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::rtc::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:（仅适用于 iOS）应用处于后台。请提示用户应用处于后台时，无法正常进行视频采集。自从 v3.3.0
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS	7:（仅支持 iOS）当前应用窗口处于侧拉、分屏、画中画模式，且其他应用正占用摄像头时，SDK 会报告该错误码。请提示用户应用窗口处于侧拉、分屏、画中画模式，且其他应用正占用摄像头时，无法正常进行视频采集。自从 v3.3.0
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND	8: 找不到本地视频采集设备。请检查摄像头是否与设备连接正常，检查摄像头是否正常工作，或者尝试重新加入频道。自从 v3.4.0
LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED	9:（仅支持 macOS）当前正在使用的外部摄像头已经断开连接（例如，被拔出）。自从 v3.5.0
LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID	10: （仅 macOS 和 Windows）SDK 无法在视频设备列表中找到该视频设备。请检查视频设备 ID 是否有效。自从 v3.5.2
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED	11: 调用 startScreenCaptureByWindowId 方法共享窗口时，共享窗口处于最小化的状态。SDK 无法共享被最小化的窗口。请在应用层对此类窗口取消最小化，例如，将窗口最大化。自从 v3.1.0
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED	12:（仅 macOS，Windows）该错误码表示通过窗口 ID 共享的窗口已关闭，或通过窗口 ID 共享的全屏窗口已退出全屏。退出全屏模式后，远端用户将无法看到共享的窗口。为避免远端用户看到黑屏，声网建议你立即结束本次共享。报告该错误码的常见场景：本地用户关闭共享的窗口时，SDK 会报告该错误码。本地用户先放映幻灯片，然后共享放映中的幻灯片。结束放映时，SDK 会报告该错误码。本地用户先全屏观看网页视频或网页文档，然后共享网页视频或网页文档。结束全屏时，SDK 会报告该错误码。自从 v3.2.0
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED	13:（仅 Windows）待共享的窗口被其他窗口遮挡住，被遮挡住的部分在共享时会被 SDK 涂黑。自从 v3.5.2
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED	自从 v3.5.2 20:（仅 Windows）SDK 不支持共享该类型的窗口。请提示用户当前类型的窗口不支持共享，请使用屏幕共享而非窗口共享。弃用: 该错误码自 v3.7.0 废弃。自 v3.7.0 起，SDK 不再抛出该错误码，并会自动调整采集方式以采集更多类型的窗口。

◆ LOCAL_AUDIO_STREAM_STATE

enum agora::rtc::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: 本地音频启动失败。

◆ LOCAL_AUDIO_STREAM_ERROR

enum agora::rtc::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:（仅 Android，iOS）本地音频采集设备已经在使用中。请提示用户检查麦克风是否被其他应用占用。麦克风空闲约 5 秒后本地音频采集会自动恢复，你也可以在麦克风空闲后尝试重新加入频道。
LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE	4: 本地音频采集失败。
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE	5: 本地音频编码失败。
LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE	6:（仅 Windows）无本地音频采集设备。请提示用户在设备的控制面板中检查麦克风是否与设备连接正常，检查麦克风是否正常工作。自从 v3.4.0
LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE	7:（仅 Windows）无本地音频播放设备。请提示用户在设备的控制面板中检查扬声器是否与设备连接正常，检查扬声器是否正常工作。自从 v3.4.0
LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED	8:（仅 Android，iOS）本地音频采集被系统来电、Siri、闹钟中断。如需恢复本地音频采集，请用户中止电话、Siri、闹钟。
LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID	9:（仅 Windows）本地音频采集设备的 ID 无效。请检查音频采集设备 ID。自从 v3.5.1
LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID	10:（仅 Windows）本地音频播放设备的 ID 无效。请检查音频播放设备 ID。自从 v3.5.1

◆ AUDIO_RECORDING_QUALITY_TYPE

enum agora::rtc::AUDIO_RECORDING_QUALITY_TYPE

录音音质。在 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。自从 v3.6.2

◆ QUALITY_TYPE

enum agora::rtc::QUALITY_TYPE

网络质量。

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

◆ RENDER_MODE_TYPE

enum agora::rtc::RENDER_MODE_TYPE

设置视频显示模式。

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

◆ SR_MODE

enum agora::rtc::SR_MODE

超分辨率的模式。

自从: v3.7.1

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

◆ VIDEO_MIRROR_MODE_TYPE

enum agora::rtc::VIDEO_MIRROR_MODE_TYPE

镜像模式类型。

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

◆ VIDEO_PROFILE_TYPE

enum agora::rtc::VIDEO_PROFILE_TYPE

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

枚举值
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。注解该视频属性仅适用于直播频道模式。
VIDEO_PROFILE_LANDSCAPE_360P_10	弃用: 39：分辨率 640 × 360，帧率 24 fps，码率 800 Kbps。注解该视频属性仅适用于直播频道模式。
VIDEO_PROFILE_LANDSCAPE_360P_11	弃用: 100: 分辨率 640 × 360，帧率 24 fps，码率 1000 Kbps。注解该属性仅适用于直播频道场景。
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，码率 7350 Kbps。
VIDEO_PROFILE_LANDSCAPE_4K	弃用: 70：分辨率 3840 × 2160，分辨率 30 fps，码率 8910 Kbps。
VIDEO_PROFILE_LANDSCAPE_4K_3	弃用: 72：分辨率 3840 × 2160，帧率 60 fps，码率 13500 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: 分辨率 1440 × 3840，帧率 30 fps，码率 6500 Kbps。
VIDEO_PROFILE_PORTRAIT_4K_3	弃用: 1072: 分辨率 2160 × 3840，帧率 60 fps，码率 6500 Kbps。
VIDEO_PROFILE_DEFAULT	弃用: （默认）分辨率 640 × 360，帧率 15 fps，码率 400 Kbps。

◆ AUDIO_PROFILE_TYPE

enum agora::rtc::AUDIO_PROFILE_TYPE

音频属性。

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

枚举值
AUDIO_PROFILE_DEFAULT	0: 默认值。直播场景下：48 KHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。通信场景下： Windows 平台：16 KHz 采样率，语音编码，单声道，编码码率最大值为 16 Kbps。 Android、macOS、iOS 平台：32 KHz 采样率，语音编码，单声道，编码码率最大值为 18 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_SCENARIO_TYPE

enum agora::rtc::AUDIO_SCENARIO_TYPE

设置音频应用场景。

枚举值
AUDIO_SCENARIO_DEFAULT	0: 默认的音频应用场景。注解如果你在 M1 Mac 上运行 iOS app，由于 M1 Mac 和 iPhone、iPad 存在硬件差异，iOS SDK 默认应用的音频场景与 macOS SDK 一致。
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	枚举的数量。

◆ CHANNEL_PROFILE_TYPE

enum agora::rtc::CHANNEL_PROFILE_TYPE

频道使用场景。

枚举值

CHANNEL_PROFILE_COMMUNICATION

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

CHANNEL_PROFILE_LIVE_BROADCASTING

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

CHANNEL_PROFILE_GAME

2: 游戏语音场景。该场景默认使用低功耗低码率的编解码器，且频道内任何用户都可以自由发言，适用于游戏场景。

注解: 声网不推荐使用该场景。

◆ AUDIENCE_LATENCY_LEVEL_TYPE

enum agora::rtc::AUDIENCE_LATENCY_LEVEL_TYPE

直播频道中观众端（用户角色为观众的客户端）的延时级别。仅在用户角色设为 CLIENT_ROLE_AUDIENCE 时才生效。

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

◆ CLIENT_ROLE_TYPE

enum agora::rtc::CLIENT_ROLE_TYPE

直播场景里的用户角色。

枚举值
CLIENT_ROLE_BROADCASTER	1: 主播。主播可以发流也可以收流。如果你在频道中设置该角色，SDK 会自动调用 `muteLocalAudioStream(false)` 和 `muteLocalVideoStream(false)`。
CLIENT_ROLE_AUDIENCE	2:（默认）观众。观众只能收流不能发流。如果你在频道中设置该角色，SDK 会自动调用 `muteLocalAudioStream(true)` 和 `muteLocalVideoStream(true)`。

◆ SUPER_RESOLUTION_STATE_REASON

enum agora::rtc::SUPER_RESOLUTION_STATE_REASON

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

自从: v3.5.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 检测到用户设备性能不足。收到该原因码后，声网建议用户关闭超分辨率功能。自从 v3.7.1

◆ VIRTUAL_BACKGROUND_SOURCE_STATE_REASON

enum agora::rtc::VIRTUAL_BACKGROUND_SOURCE_STATE_REASON

虚拟背景开启出错的原因或开启成功的提示。

自从: v3.4.5

枚举值
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 检测到用户设备性能不足。收到该原因码后，声网建议用户关闭虚拟背景功能。自从 v3.7.1

◆ USER_OFFLINE_REASON_TYPE

enum agora::rtc::USER_OFFLINE_REASON_TYPE

用户离线原因。

枚举值

USER_OFFLINE_QUIT

0: 用户主动离开。在 iOS 系统上，用户通过手势滑动杀死 app 后，SDK 会报告该原因码。

USER_OFFLINE_DROPPED

1: 因过长时间收不到对方数据包，超时掉线。

注解

由于 SDK 使用的是不可靠通道，也有可能对方主动离开本方没收到对方离开消息而误判为超时掉线。
在 Android 系统上，用户通过手势滑动杀死 app 后，因系统限制，SDK 会报告 USER_OFFLINE_DROPPED(1)，而非报告 USER_OFFLINE_QUIT(0)。

USER_OFFLINE_BECOME_AUDIENCE

2: 用户身份从主播切换为观众时触发。

◆ RTMP_STREAM_PUBLISH_STATE

enum agora::rtc::RTMP_STREAM_PUBLISH_STATE

推流状态

枚举值
RTMP_STREAM_PUBLISH_STATE_IDLE	0: 推流未开始或已结束。成功调用 removePublishStreamUrl 方法删除推流地址后，也会返回该状态。
RTMP_STREAM_PUBLISH_STATE_CONNECTING	1: 正在连接声网推流服务器和 CDN 服务器。调用 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.0

◆ RTMP_STREAM_PUBLISH_ERROR_TYPE

enum agora::rtc::RTMP_STREAM_PUBLISH_ERROR_TYPE

推流错误信息

枚举值
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: CDN 服务器出现错误。
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.0
RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM	13: 非转码推流情况下，调用了 `updateRtmpTranscoding` 或 `setLiveTranscoding` 方法更新转码属性。请检查你的应用代码逻辑。自从 v3.6.0
RTMP_STREAM_PUBLISH_ERROR_NET_DOWN	14: 主播的网络出错。自从 v3.6.0
RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID	15: 你的 App ID 没有使用声网推流服务的权限。请参考前提条件开启推流服务。自从 v3.6.0
RTMP_STREAM_UNPUBLISH_ERROR_OK	100: 推流已正常结束。当你调用 removePublishStreamUrl 结束推流后，SDK 会返回该值。自从 v3.4.5

◆ RTMP_STREAMING_EVENT

enum agora::rtc::RTMP_STREAMING_EVENT

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.0
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN	4: 预留参数。自从 v3.6.0

◆ REMOTE_VIDEO_STREAM_TYPE

enum agora::rtc::REMOTE_VIDEO_STREAM_TYPE

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

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

◆ CAPTURE_BRIGHTNESS_LEVEL_TYPE

enum agora::rtc::CAPTURE_BRIGHTNESS_LEVEL_TYPE

本地采集的画质亮度级别

自从: v3.3.0

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

◆ RAW_AUDIO_FRAME_OP_MODE_TYPE

enum agora::rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE

onRecordAudioFrame 或 onPlaybackAudioFrame 回调中返回的音频数据的使用模式

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

◆ AUDIO_SAMPLE_RATE_TYPE

enum agora::rtc::AUDIO_SAMPLE_RATE_TYPE

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

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

◆ VIDEO_CODEC_PROFILE_TYPE

enum agora::rtc::VIDEO_CODEC_PROFILE_TYPE

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

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

◆ VIDEO_CODEC_TYPE

enum agora::rtc::VIDEO_CODEC_TYPE

视频编码格式

枚举值
VIDEO_CODEC_VP8	1: 标准 VP8
VIDEO_CODEC_H264	2: 标准 H.264
VIDEO_CODEC_EVP	3: 增强 VP8
VIDEO_CODEC_E264	4: 增强 H.264

◆ VIDEO_CODEC_TYPE_FOR_STREAM

enum agora::rtc::VIDEO_CODEC_TYPE_FOR_STREAM

用于旁路直播的输出视频的编解码类型。

自从: v3.2.0

枚举值
VIDEO_CODEC_H264_FOR_STREAM	1:（默认）H.264
VIDEO_CODEC_H265_FOR_STREAM	2: H.265

◆ AUDIO_EQUALIZATION_BAND_FREQUENCY

enum agora::rtc::AUDIO_EQUALIZATION_BAND_FREQUENCY

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

枚举值
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

◆ AUDIO_REVERB_TYPE

enum agora::rtc::AUDIO_REVERB_TYPE

各混响音效 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], 混响持续的强度。

◆ VOICE_CHANGER_PRESET

enum agora::rtc::VOICE_CHANGER_PRESET

弃用:: 自 v3.2.0 废弃。

预设的语音变声效果。

设置语聊美声效果时，声网推荐使用 GENERAL_BEAUTY_VOICE_MALE_MAGNETIC 处理男声，使用 GENERAL_BEAUTY_VOICE_FEMALE_FRESH 或 GENERAL_BEAUTY_VOICE_FEMALE_VITALITY 处理女声，否则音频可能会产生失真。

枚举值
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::rtc::AUDIO_REVERB_PRESET

弃用:: 自 v3.2.0 废弃。

预设的语音混响效果

枚举值
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_ELECTRONIC_VOICE	电音，即 SDK 以主音音高为 C 的自然大调为基础修正音频的实际音高。
AUDIO_THREEDIM_VOICE	3D 人声，即 SDK 将音频渲染出在用户周围环绕的效果。

◆ VOICE_BEAUTIFIER_PRESET

enum agora::rtc::VOICE_BEAUTIFIER_PRESET

预设的美声效果选项。

枚举值
VOICE_BEAUTIFIER_OFF	原声，即关闭美声效果。
CHAT_BEAUTIFIER_MAGNETIC	磁性（男）。注解该设置仅对男声有效。请勿用于设置女声，否则音频会失真。
CHAT_BEAUTIFIER_FRESH	清新（女）。注解该设置仅对女声有效。请勿用于设置男声，否则音频会失真。
CHAT_BEAUTIFIER_VITALITY	活力（女）。注解该设置仅对女声有效。请勿用于设置男声，否则音频会失真。
SINGING_BEAUTIFIER	自从 v3.3.0 歌唱美声。如果调用 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::rtc::AUDIO_EFFECT_PRESET

预设的音效选项。

枚举值
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)`。

◆ VOICE_CONVERSION_PRESET

enum agora::rtc::VOICE_CONVERSION_PRESET

预设的变声效果选项。

自从: v3.3.1

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

◆ AUDIO_CODEC_PROFILE_TYPE

enum agora::rtc::AUDIO_CODEC_PROFILE_TYPE

用于旁路推流的输出音频的编解码规格，默认为 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.0

◆ REMOTE_AUDIO_STATE

enum agora::rtc::REMOTE_AUDIO_STATE

远端音频流状态

枚举值
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::rtc::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: 远端用户离开频道。请在应用界面的用户列表中移除该远端用户。

◆ REMOTE_VIDEO_STATE

enum agora::rtc::REMOTE_VIDEO_STATE

远端视频流状态。

枚举值
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) 的情况下，会报告该状态。

◆ STREAM_PUBLISH_STATE

enum agora::rtc::STREAM_PUBLISH_STATE

发布状态。

枚举值
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::rtc::STREAM_SUBSCRIBE_STATE

订阅状态。

枚举值
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: 收到了远端流，订阅成功。

◆ REMOTE_VIDEO_STATE_REASON

enum agora::rtc::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: 当远端用户使用 iOS 应用且应用处于后台时，SDK 会向本地用户报告该错误码。此时，本地用户看到远端用户视频卡住。

◆ FRAME_RATE

enum agora::rtc::FRAME_RATE

视频帧率。

枚举值
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::rtc::ORIENTATION_MODE

视频编码的方向模式。

枚举值

ORIENTATION_MODE_ADAPTIVE

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

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

ORIENTATION_MODE_FIXED_LANDSCAPE

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

ORIENTATION_MODE_FIXED_PORTRAIT

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

◆ DEGRADATION_PREFERENCE

enum agora::rtc::DEGRADATION_PREFERENCE

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

枚举值

MAINTAIN_QUALITY

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

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

MAINTAIN_FRAMERATE

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

MAINTAIN_BALANCED

自从: v3.4.0

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

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

◆ STREAM_FALLBACK_OPTIONS

enum agora::rtc::STREAM_FALLBACK_OPTIONS

音视频流回退处理选项。

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

◆ CAPTURER_OUTPUT_PREFERENCE

enum agora::rtc::CAPTURER_OUTPUT_PREFERENCE

摄像头采集偏好。

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

◆ PRIORITY_TYPE

enum agora::rtc::PRIORITY_TYPE

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

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

◆ CONNECTION_STATE_TYPE

enum agora::rtc::CONNECTION_STATE_TYPE

网络连接状态。

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

◆ CONNECTION_CHANGED_REASON_TYPE

enum agora::rtc::CONNECTION_CHANGED_REASON_TYPE

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

枚举值
CONNECTION_CHANGED_CONNECTING	0: 建立网络连接中。
CONNECTION_CHANGED_JOIN_SUCCESS	1: 成功加入频道。
CONNECTION_CHANGED_INTERRUPTED	2: 网络连接中断。
CONNECTION_CHANGED_BANNED_BY_SERVER	3: 网络连接被服务器禁止。可能是由于服务端调用封禁用户权限 API 将用户踢出频道。请在应用中弹框提示“用户被踢出频道”。
CONNECTION_CHANGED_JOIN_FAILED	4: 加入频道失败。当 SDK 收到 onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED) 后连续 20 分钟无法重新加入频道时，会报告该状态并停止重连。请在应用中弹框显示“因网络问题无法加入频道。请尝试切换网络并重新加入频道。”
CONNECTION_CHANGED_LEAVE_CHANNEL	5: 离开频道。
CONNECTION_CHANGED_INVALID_APP_ID	6: 不是有效的 APP ID。请更换有效的 APP ID 重新加入频道。请检查用户使用的 App ID 是否与从声网控制台获取的项目的 App ID 一致，并更换有效的 APP ID 重新加入频道。
CONNECTION_CHANGED_INVALID_CHANNEL_NAME	7: 不是有效的频道名。频道名不能为空，且字符长度不能超过 64 字节，支持的字符集详见 joinChannel 的 `channelName` 参数描述。请在应用中弹框提示“频道名不合法。请更换有效的频道名并重新加入频道。”
CONNECTION_CHANGED_INVALID_TOKEN	8: Token 无效。一般有以下原因：在控制台上启用了 App Certificate，但加入频道未使用 Token。当启用了 App Certificate，必须使用 Token。在调用 joinChannel 加入频道时指定的 uid 与生成 Token 时传入的 uid 不一致。请检查用户使用的 Token 是否与业务服务器上生成的 Token 一致，并更换有效的 Token 重新加入频道。
CONNECTION_CHANGED_TOKEN_EXPIRED	9: 当前使用的 Token 过期，用户被迫退出频道。客户端需要重新向自己的业务服务器申请 Token，并使用新的 Token 重新加入频道。
CONNECTION_CHANGED_REJECTED_BY_SERVER	10: 此用户被服务器禁止。一般有以下原因：用户已进入频道，再次调用加入频道的 API，例如 joinChannel，会返回此状态。停止调用该方法即可。用户在调用 startEchoTest 进行通话测试时尝试加入频道。等待通话测试结束后再加入频道即可。
CONNECTION_CHANGED_SETTING_PROXY_SERVER	11: 由于设置了代理服务器，SDK 尝试重连。
CONNECTION_CHANGED_RENEW_TOKEN	12: 更新 Token 引起网络连接状态改变。
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED	13: 由于网络类型，或网络运营商的 IP 或端口发生改变，客户端 IP 地址变更，SDK 尝试重连。如果多次出现该状态，请在应用中弹框提示“您的网络连接不稳定，建议切换网络。”
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT	14: SDK 和服务器连接保活超时，进入自动重连状态 CONNECTION_STATE_RECONNECTING(4)。
CONNECTION_CHANGED_SAME_UID_LOGIN	19: 使用相同的 UID 从不同的设备加入同一频道。自从 v3.7.0
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS	20: 频道内主播人数已达上限。注解该枚举仅在开启 128 人功能后报告。主播人数的上限根据开启 128 人功能时实际配置的人数而定。自从 v3.7.0

◆ NETWORK_TYPE

enum agora::rtc::NETWORK_TYPE

网络连接类型

枚举值
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.5.1

◆ LASTMILE_PROBE_RESULT_STATE

enum agora::rtc::LASTMILE_PROBE_RESULT_STATE

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 质量探测。一个可能的原因是网络连接中断。

◆ AUDIO_ROUTE_TYPE

enum agora::rtc::AUDIO_ROUTE_TYPE

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

枚举值
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_USB	6: 音频路由为 USB 外围设备（仅适用于 macOS）
AUDIO_ROUTE_HDMI	7: 音频路由为 HDMI 外围设备（仅适用于 macOS）
AUDIO_ROUTE_DISPLAYPORT	8: 音频路由为 DisplayPort 外围设备（仅适用于 macOS）
AUDIO_ROUTE_AIRPLAY	9: 音频路由为 Apple AirPlay（仅适用于 iOS 和 macOS）

◆ CLOUD_PROXY_TYPE

enum agora::rtc::CLOUD_PROXY_TYPE

云代理类型

自从: v3.3.0

枚举值

NONE_PROXY

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

UDP_PROXY

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

TCP_PROXY

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

自从: v3.6.2

◆ LOCAL_PROXY_MODE

enum agora::rtc::LOCAL_PROXY_MODE

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

自从: v3.7.1

枚举值

ConnectivityFirst

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

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

LocalOnly

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

◆ EXCLUDE_WINDOW_ERROR

enum agora::rtc::EXCLUDE_WINDOW_ERROR

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

自从: v3.6.1

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

◆ PROXY_TYPE

enum agora::rtc::PROXY_TYPE

代理类型。

自从: v3.6.2

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

◆ AUDIO_SESSION_OPERATION_RESTRICTION

enum agora::rtc::AUDIO_SESSION_OPERATION_RESTRICTION

SDK 对 Audio Session 的操作权限。

枚举值
AUDIO_SESSION_OPERATION_RESTRICTION_NONE	0: 没有限制，SDK 可以对 Audio Session 进行更改。
AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY	1: SDK 不能更改 Audio Session 的 category。
AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION	2: SDK 不能更改 Audio Session 的 category、mode 或 categoryOptions。
AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION	4: 离开频道时，SDK 会保持 Audio Session 处于活动状态，例如在后台播放音频。
AUDIO_SESSION_OPERATION_RESTRICTION_ALL	128: 完全限制 SDK 对 Audio Session 的操作权限，SDK 不能再对 Audio Session 进行任何更改。

◆ CAMERA_DIRECTION

enum agora::rtc::CAMERA_DIRECTION

摄像头方向。

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

◆ AUDIO_RECORDING_POSITION

enum agora::rtc::AUDIO_RECORDING_POSITION

自从: v3.4.0

录音内容。在 startAudioRecording 中设置。

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

◆ AUDIO_FILE_INFO_ERROR

enum agora::rtc::AUDIO_FILE_INFO_ERROR

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

自从: v3.5.1

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

◆ CLIENT_ROLE_CHANGE_FAILED_REASON

enum agora::rtc::CLIENT_ROLE_CHANGE_FAILED_REASON

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

自从: v3.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：网络连接断开。可根据 `onConnectionStateChanged` 报告的 `reason`，排查网络连接失败的具体原因。

◆ WLACC_MESSAGE_REASON

enum agora::rtc::WLACC_MESSAGE_REASON

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

自从: v3.6.2

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

◆ WLACC_SUGGEST_ACTION

enum agora::rtc::WLACC_SUGGEST_ACTION

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

自从: v3.6.2

枚举值
WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI	0: 由于路由器接收到的 Wi-Fi 信号弱，请用户靠近路由器。
WLACC_SUGGEST_ACTION_CONNECT_SSID	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` 参数。

◆ QUALITY_ADAPT_INDICATION

enum agora::rtc::QUALITY_ADAPT_INDICATION

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

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

◆ EXPERIENCE_QUALITY_TYPE

enum agora::rtc::EXPERIENCE_QUALITY_TYPE

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

自从: v3.3.0

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

◆ EXPERIENCE_POOR_REASON

enum agora::rtc::EXPERIENCE_POOR_REASON

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

自从: v3.3.0

枚举值
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 和蓝牙，二者信号互相干扰，导致音频传输质量下降。

◆ CHANNEL_MEDIA_RELAY_ERROR

enum agora::rtc::CHANNEL_MEDIA_RELAY_ERROR

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

枚举值
RELAY_OK	0: 一切正常。
RELAY_ERROR_SERVER_ERROR_RESPONSE	1: 服务器回应出错。
RELAY_ERROR_SERVER_NO_RESPONSE	2: 服务器无回应。该错误可能是网络状况不佳导致的。如果在发起跨频道连麦时报告该错误，你可以稍后重试；如果在跨频道连麦过程中报告该错误，你可以调用 leaveChannel 方法离开频道。该错误也可能是由于当前的 App ID 未开启跨频道连麦服务导致的。你可以联系技术支持申请开通跨频道连麦服务。
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 已过期。

◆ CHANNEL_MEDIA_RELAY_EVENT

enum agora::rtc::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: SDK 开始向目标频道发送数据包。
RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC	5: 服务器收到了频道发送的视频流。
RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC	6: 服务器收到了频道发送的音频流。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL	7: 目标频道已更新。成功调用 updateChannelMediaRelay 方法会返回该状态码，表示成功将流转发到目标频道，或成功退出当前的转发频道。
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: 成功暂停向目标频道转发媒体流。
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: 恢复向目标频道转发媒体流失败。

◆ CHANNEL_MEDIA_RELAY_STATE

enum agora::rtc::CHANNEL_MEDIA_RELAY_STATE

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

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

◆ AudioDeviceTestVolumeType

enum agora::rtc::AudioDeviceTestVolumeType

音量类型。

自从: v3.6.2

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

◆ RTMP_STREAM_LIFE_CYCLE_TYPE

enum agora::rtc::RTMP_STREAM_LIFE_CYCLE_TYPE

弃用:: 服务端转码推流的生命周期。

枚举值
RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL	弃用: 跟频道生命周期绑定，即频道内所有主播离开，服务端转码推流会在 30 秒之后停止。
RTMP_STREAM_LIFE_CYCLE_BIND2OWNER	弃用: 跟启动服务端转码推流的主播生命周期绑定，即该主播离开，服务端转码推流会立即停止。

◆ VideoContentHint

enum agora::rtc::VideoContentHint

屏幕共享的内容类型

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

◆ SCREEN_SCENARIO_TYPE

enum agora::rtc::SCREEN_SCENARIO_TYPE

屏幕共享的场景

自从: v3.7.0

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

◆ AREA_CODE

enum agora::rtc::AREA_CODE

访问区域。

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

◆ ENCRYPTION_CONFIG

enum agora::rtc::ENCRYPTION_CONFIG

枚举值
ENCRYPTION_FORCE_SETTING
ENCRYPTION_FORCE_DISABLE_PACKET

◆ MAX_CONTENT_INSPECT_MODULE_TYPE

enum agora::rtc::MAX_CONTENT_INSPECT_MODULE_TYPE

截图上传模块的最大数量。

自从: v3.6.2

枚举值
MAX_CONTENT_INSPECT_MODULE_COUNT	截图上传模块的最大数量为 32。

◆ VIDEO_CAPTURE_TYPE

enum agora::rtc::VIDEO_CAPTURE_TYPE

外部视频源的类型。

枚举值
VIDEO_CAPTURE_UNKNOWN	未知类型。
VIDEO_CAPTURE_CAMERA	（默认）摄像头采集的视频。
VIDEO_CAPTURE_SCREEN	屏幕共享的视频。

◆ ScreenCaptureSourceType

enum agora::rtc::ScreenCaptureSourceType

共享目标的类型。

自从: v3.5.2

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

◆ ENCRYPTION_MODE

enum agora::rtc::ENCRYPTION_MODE

内置加密模式。声网推荐使用 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	枚举值边界。

◆ MediaRecorderContainerFormat

enum agora::rtc::MediaRecorderContainerFormat

录制文件的格式。

自从: v3.5.2

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

◆ MediaRecorderStreamType

enum agora::rtc::MediaRecorderStreamType

录制内容。

自从: v3.5.2

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

◆ RecorderState

enum agora::rtc::RecorderState

当前的录制状态。

自从: v3.5.2

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

◆ RecorderErrorCode

enum agora::rtc::RecorderErrorCode

录制状态出错的原因。

自从: v3.5.2

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

变量说明

◆ STANDARD_BITRATE

const int agora::rtc::STANDARD_BITRATE = 0

setVideoEncoderConfiguration 的标准码率。

（推荐）标准码率模式。该模式下，视频在通信和直播场景下的码率有所不同：通信场景下，码率与基准码率一致；直播场景下，码率对照基准码率翻倍。

◆ COMPATIBLE_BITRATE

const int agora::rtc::COMPATIBLE_BITRATE = -1

setVideoEncoderConfiguration 的兼容码率。

适配码率模式。该模式下，视频在通信和直播场景下的码率均与基准码率一致。直播下如果选择该模式，视频帧率可能会低于设置的值。

◆ DEFAULT_MIN_BITRATE

const int agora::rtc::DEFAULT_MIN_BITRATE = -1

使用系统默认最低编码码率。

◆ kContentInspectInvalid

const ContentInspectType agora::rtc::kContentInspectInvalid = 0

0:（默认）该功能模块无实际功能。请不要将 type 设为该值。

◆ kContentInspectModeration

const ContentInspectType agora::rtc::kContentInspectModeration = 1

1: 预留参数。

◆ kContentInspectSupervise

const ContentInspectType agora::rtc::kContentInspectSupervise = 2

2: 截图。SDK 会对视频流进行截图并上传。