class  AgoraChannel
 
class  AudioEffectManagerImpl
 
struct  AudioFrame
 
class  AudioPlaybackDeviceManager
 
class  AudioRawDataManager
 
class  AudioRecordingDeviceManager
 
struct  AudioVolumeInfo
 
struct  BeautyOptions
 
struct  CameraCapturerConfiguration
 
struct  ChannelMediaInfo
 
struct  ChannelMediaRelayConfiguration
 
struct  ExternalVideoFrame
 
struct  InjectStreamConfig
 
class  IRtcEngine
 
struct  LastmileProbeConfig
 
struct  LastmileProbeOneWayResult
 
struct  LastmileProbeResult
 
struct  LiveTranscoding
 
struct  LocalAudioStats
 
struct  LocalVideoStats
 
struct  Metadata
 
class  MetadataObserver
 
struct  Packet
 
class  PacketObserver
 
struct  PublisherConfiguration
 
struct  Rectangle
 
struct  RemoteAudioStats
 
struct  RemoteVideoStats
 
struct  RtcEngineConfig
 
struct  RtcImage
 
struct  RtcStats
 
struct  ScreenCaptureParameters
 
struct  TranscodingUser
 
struct  UserInfo
 
struct  VideoCanvas
 
class  VideoDeviceManager
 
struct  VideoDimensions
 
struct  VideoEncoderConfiguration
 
struct  VideoFrame
 
class  VideoRawDataManager
 
struct  WatermarkOptions
 

枚举

enum  VIDEO_RENDER_MODE { VIDEO_RENDER_MODE.RENDER_RAWDATA = 100, VIDEO_RENDER_MODE.REDNER_OPENGL_ES2 = 101, VIDEO_RENDER_MODE.RENDER_UNITY_LOW_LEVEL_INTERFACE = 102 }
 
enum  ERROR_CODE { ERROR_CODE.ERROR_NOT_INIT_ENGINE = -7, ERROR_CODE.ERROR_OK = 0, ERROR_CODE.ERROR_INVALID_ARGUMENT = -2, ERROR_CODE.ERROR_NO_DEVICE_PLUGIN = -100 }
 
enum  REMOTE_VIDEO_STREAM_TYPE { REMOTE_VIDEO_STREAM_TYPE.REMOTE_VIDEO_STREAM_HIGH = 0, REMOTE_VIDEO_STREAM_TYPE.REMOTE_VIDEO_STREAM_LOW = 1 }
 
enum  REMOTE_VIDEO_STATE {
  REMOTE_VIDEO_STATE.REMOTE_VIDEO_STATE_STOPPED = 0, REMOTE_VIDEO_STATE.REMOTE_VIDEO_STATE_STARTING = 1, REMOTE_VIDEO_STATE.REMOTE_VIDEO_STATE_DECODING = 2, REMOTE_VIDEO_STATE.REMOTE_VIDEO_STATE_FROZEN = 3,
  REMOTE_VIDEO_STATE.REMOTE_VIDEO_STATE_FAILED = 4
}
 
enum  USER_OFFLINE_REASON { USER_OFFLINE_REASON.QUIT = 0, USER_OFFLINE_REASON.DROPPED = 1, USER_OFFLINE_REASON.BECOME_AUDIENCE = 2 }
 
enum  LOG_FILTER {
  LOG_FILTER.OFF = 0, LOG_FILTER.DEBUG = 0x80f, LOG_FILTER.INFO = 0x0f, LOG_FILTER.WARNING = 0x0e,
  LOG_FILTER.ERROR = 0x0c, LOG_FILTER.CRITICAL = 0x08
}
 
enum  CHANNEL_PROFILE { CHANNEL_PROFILE.CHANNEL_PROFILE_COMMUNICATION = 0, CHANNEL_PROFILE.CHANNEL_PROFILE_LIVE_BROADCASTING = 1, CHANNEL_PROFILE.CHANNEL_PROFILE_GAME = 2 }
 
enum  AUDIO_RECORDING_QUALITY_TYPE { AUDIO_RECORDING_QUALITY_TYPE.AUDIO_RECORDING_QUALITY_LOW = 0, AUDIO_RECORDING_QUALITY_TYPE.AUDIO_RECORDING_QUALITY_MEDIUM = 1, AUDIO_RECORDING_QUALITY_TYPE.AUDIO_RECORDING_QUALITY_HIGH = 2 }
 
enum  AUDIO_ROUTE {
  AUDIO_ROUTE.AUDIO_ROUTE_DEFAULT = -1, AUDIO_ROUTE.AUDIO_ROUTE_HEADSET = 0, AUDIO_ROUTE.AUDIO_ROUTE_EARPIECE = 1, AUDIO_ROUTE.AUDIO_ROUTE_HEADSET_NO_MIC = 2,
  AUDIO_ROUTE.AUDIO_ROUTE_SPEAKERPHONE = 3, AUDIO_ROUTE.AUDIO_ROUTE_LOUDSPEAKER = 4, AUDIO_ROUTE.AUDIO_ROUTE_BLUETOOTH = 5
}
 
enum  CONNECTION_STATE_TYPE {
  CONNECTION_STATE_TYPE.CONNECTION_STATE_DISCONNECTED = 1, CONNECTION_STATE_TYPE.CONNECTION_STATE_CONNECTING = 2, CONNECTION_STATE_TYPE.CONNECTION_STATE_CONNECTED = 3, CONNECTION_STATE_TYPE.CONNECTION_STATE_RECONNECTING = 4,
  CONNECTION_STATE_TYPE.CONNECTION_STATE_FAILED = 5
}
 
enum  CONNECTION_CHANGED_REASON_TYPE {
  CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_CONNECTING = 0, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_JOIN_SUCCESS = 1, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_INTERRUPTED = 2, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_BANNED_BY_SERVER = 3,
  CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_JOIN_FAILED = 4, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_LEAVE_CHANNEL = 5, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_INVALID_APP_ID = 6, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7,
  CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_INVALID_TOKEN = 8, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_TOKEN_EXPIRED = 9, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_REJECTED_BY_SERVER = 10, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11,
  CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_RENEW_TOKEN = 12, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13, CONNECTION_CHANGED_REASON_TYPE.CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14
}
 
enum  STREAM_FALLBACK_OPTIONS { STREAM_FALLBACK_OPTIONS.STREAM_FALLBACK_OPTION_DISABLED = 0, STREAM_FALLBACK_OPTIONS.STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1, STREAM_FALLBACK_OPTIONS.STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2 }
 
enum  VideoContentHint { VideoContentHint.CONTENT_HINT_NONE = 0, VideoContentHint.CONTENT_HINT_MOTION = 1, VideoContentHint.CONTENT_HINT_DETAILS = 2 }
 
enum  REMOTE_VIDEO_STATE_REASON {
  REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_INTERNAL = 0, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3,
  REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7,
  REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8, REMOTE_VIDEO_STATE_REASON.REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9
}
 
enum  LOCAL_VIDEO_STREAM_STATE { LOCAL_VIDEO_STREAM_STATE.LOCAL_VIDEO_STREAM_STATE_STOPPED = 0, LOCAL_VIDEO_STREAM_STATE.LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1, LOCAL_VIDEO_STREAM_STATE.LOCAL_VIDEO_STREAM_STATE_ENCODING = 2, LOCAL_VIDEO_STREAM_STATE.LOCAL_VIDEO_STREAM_STATE_FAILED = 3 }
 
enum  LOCAL_VIDEO_STREAM_ERROR {
  LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_OK = 0, LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1, LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3,
  LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4, LOCAL_VIDEO_STREAM_ERROR.LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5
}
 
enum  CLIENT_ROLE_TYPE { CLIENT_ROLE_TYPE.CLIENT_ROLE_BROADCASTER = 1, CLIENT_ROLE_TYPE.CLIENT_ROLE_AUDIENCE = 2 }
 
enum  MEDIA_DEVICE_TYPE {
  MEDIA_DEVICE_TYPE.UNKNOWN_AUDIO_DEVICE = -1, MEDIA_DEVICE_TYPE.AUDIO_PLAYOUT_DEVICE = 0, MEDIA_DEVICE_TYPE.AUDIO_RECORDING_DEVICE = 1, MEDIA_DEVICE_TYPE.VIDEO_RENDER_DEVICE = 2,
  MEDIA_DEVICE_TYPE.VIDEO_CAPTURE_DEVICE = 3, MEDIA_DEVICE_TYPE.AUDIO_APPLICATION_PLAYOUT_DEVICE = 4
}
 
enum  RAW_AUDIO_FRAME_OP_MODE_TYPE { RAW_AUDIO_FRAME_OP_MODE_TYPE.RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0, RAW_AUDIO_FRAME_OP_MODE_TYPE.RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1, RAW_AUDIO_FRAME_OP_MODE_TYPE.RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2 }
 
enum  AUDIO_PROFILE_TYPE {
  AUDIO_PROFILE_TYPE.AUDIO_PROFILE_DEFAULT = 0, AUDIO_PROFILE_TYPE.AUDIO_PROFILE_SPEECH_STANDARD = 1, AUDIO_PROFILE_TYPE.AUDIO_PROFILE_MUSIC_STANDARD = 2, AUDIO_PROFILE_TYPE.AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3,
  AUDIO_PROFILE_TYPE.AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4, AUDIO_PROFILE_TYPE.AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5, AUDIO_PROFILE_TYPE.AUDIO_PROFILE_IOT = 6
}
 
enum  AUDIO_SCENARIO_TYPE {
  AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_DEFAULT = 0, AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1, AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_EDUCATION = 2, AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_GAME_STREAMING = 3,
  AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_SHOWROOM = 4, AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_CHATROOM_GAMING = 5, AUDIO_SCENARIO_TYPE.AUDIO_SCENARIO_IOT = 6
}
 
enum  VIDEO_CODEC_PROFILE_TYPE { VIDEO_CODEC_PROFILE_TYPE.VIDEO_CODEC_PROFILE_BASELINE = 66, VIDEO_CODEC_PROFILE_TYPE.VIDEO_CODEC_PROFILE_MAIN = 77, VIDEO_CODEC_PROFILE_TYPE.VIDEO_CODEC_PROFILE_HIGH = 100 }
 
enum  AUDIO_SAMPLE_RATE_TYPE { AUDIO_SAMPLE_RATE_TYPE.AUDIO_SAMPLE_RATE_32000 = 32000, AUDIO_SAMPLE_RATE_TYPE.AUDIO_SAMPLE_RATE_44100 = 44100, AUDIO_SAMPLE_RATE_TYPE.AUDIO_SAMPLE_RATE_48000 = 48000 }
 
enum  AUDIO_MIXING_STATE_TYPE { AUDIO_MIXING_STATE_TYPE.AUDIO_MIXING_STATE_PLAYING = 710, AUDIO_MIXING_STATE_TYPE.AUDIO_MIXING_STATE_PAUSED = 711, AUDIO_MIXING_STATE_TYPE.AUDIO_MIXING_STATE_STOPPED = 713, AUDIO_MIXING_STATE_TYPE.AUDIO_MIXING_STATE_FAILED = 714 }
 
enum  AUDIO_MIXING_ERROR_TYPE { AUDIO_MIXING_ERROR_TYPE.AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701, AUDIO_MIXING_ERROR_TYPE.AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702, AUDIO_MIXING_ERROR_TYPE.AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703, AUDIO_MIXING_ERROR_TYPE.AUDIO_MIXING_ERROR_OK = 0 }
 
enum  RTMP_STREAM_PUBLISH_STATE {
  RTMP_STREAM_PUBLISH_STATE.RTMP_STREAM_PUBLISH_STATE_IDLE = 0, RTMP_STREAM_PUBLISH_STATE.RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1, RTMP_STREAM_PUBLISH_STATE.RTMP_STREAM_PUBLISH_STATE_RUNNING = 2, RTMP_STREAM_PUBLISH_STATE.RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3,
  RTMP_STREAM_PUBLISH_STATE.RTMP_STREAM_PUBLISH_STATE_FAILURE = 4
}
 
enum  RTMP_STREAM_PUBLISH_ERROR {
  RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_OK = 0, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT = 1, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED = 2, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT = 3,
  RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR = 4, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR = 5, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN = 6, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT = 7,
  RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED = 8, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND = 9, RTMP_STREAM_PUBLISH_ERROR.RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED = 10
}
 
enum  NETWORK_TYPE {
  NETWORK_TYPE.NETWORK_TYPE_UNKNOWN = -1, NETWORK_TYPE.NETWORK_TYPE_DISCONNECTED = 0, NETWORK_TYPE.NETWORK_TYPE_LAN = 1, NETWORK_TYPE.NETWORK_TYPE_WIFI = 2,
  NETWORK_TYPE.NETWORK_TYPE_MOBILE_2G = 3, NETWORK_TYPE.NETWORK_TYPE_MOBILE_3G = 4, NETWORK_TYPE.NETWORK_TYPE_MOBILE_4G = 5
}
 
enum  VOICE_CHANGER_PRESET {
  VOICE_CHANGER_PRESET.VOICE_CHANGER_OFF = 0x00000000, VOICE_CHANGER_PRESET.VOICE_CHANGER_OLDMAN = 0x00000001, VOICE_CHANGER_PRESET.VOICE_CHANGER_BABYBOY = 0x00000002, VOICE_CHANGER_PRESET.VOICE_CHANGER_BABYGIRL = 0x00000003,
  VOICE_CHANGER_PRESET.VOICE_CHANGER_ZHUBAJIE = 0x00000004, VOICE_CHANGER_PRESET.VOICE_CHANGER_ETHEREAL = 0x00000005, VOICE_CHANGER_PRESET.VOICE_CHANGER_HULK = 0x00000006, VOICE_CHANGER_PRESET.VOICE_BEAUTY_VIGOROUS = 0x00100001,
  VOICE_CHANGER_PRESET.VOICE_BEAUTY_DEEP = 0x00100002, VOICE_CHANGER_PRESET.VOICE_BEAUTY_MELLOW = 0x00100003, VOICE_CHANGER_PRESET.VOICE_BEAUTY_FALSETTO = 0x00100004, VOICE_CHANGER_PRESET.VOICE_BEAUTY_FULL = 0x00100005,
  VOICE_CHANGER_PRESET.VOICE_BEAUTY_CLEAR = 0x00100006, VOICE_CHANGER_PRESET.VOICE_BEAUTY_RESOUNDING = 0x00100007, VOICE_CHANGER_PRESET.VOICE_BEAUTY_RINGING = 0x00100008, VOICE_CHANGER_PRESET.VOICE_BEAUTY_SPACIAL = 0x00100009,
  VOICE_CHANGER_PRESET.GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x00200001, VOICE_CHANGER_PRESET.GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x00200002, VOICE_CHANGER_PRESET.GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x00200003
}
 
enum  AUDIO_REVERB_PRESET {
  AUDIO_REVERB_PRESET.AUDIO_REVERB_OFF = 0x00000000, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_KTV = 0x00100001, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_VOCAL_CONCERT = 0x00100002, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_UNCLE = 0x00100003,
  AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_SISTER = 0x00100004, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_STUDIO = 0x00100005, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_POPULAR = 0x00100006, AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_RNB = 0x00100007,
  AUDIO_REVERB_PRESET.AUDIO_REVERB_FX_PHONOGRAPH = 0x00100008, AUDIO_REVERB_PRESET.AUDIO_REVERB_POPULAR = 0x00000001, AUDIO_REVERB_PRESET.AUDIO_REVERB_RNB = 0x00000002, AUDIO_REVERB_PRESET.AUDIO_REVERB_ROCK = 0x00000003,
  AUDIO_REVERB_PRESET.AUDIO_REVERB_HIPHOP = 0x00000004, AUDIO_REVERB_PRESET.AUDIO_REVERB_VOCAL_CONCERT = 0x00000005, AUDIO_REVERB_PRESET.AUDIO_REVERB_KTV = 0x00000006, AUDIO_REVERB_PRESET.AUDIO_REVERB_STUDIO = 0x00000007,
  AUDIO_REVERB_PRESET.AUDIO_VIRTUAL_STEREO = 0x00200001
}
 
enum  AUDIO_EQUALIZATION_BAND_FREQUENCY {
  AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_31 = 0, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_62 = 1, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_125 = 2, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_250 = 3,
  AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_500 = 4, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_1K = 5, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_2K = 6, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_4K = 7,
  AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_8K = 8, AUDIO_EQUALIZATION_BAND_FREQUENCY.AUDIO_EQUALIZATION_BAND_16K = 9
}
 
enum  QUALITY_ADAPT_INDICATION { QUALITY_ADAPT_INDICATION.ADAPT_NONE = 0, QUALITY_ADAPT_INDICATION.ADAPT_UP_BANDWIDTH = 1, QUALITY_ADAPT_INDICATION.ADAPT_DOWN_BANDWIDTH = 2 }
 
enum  AUDIO_REVERB_TYPE {
  AUDIO_REVERB_TYPE.AUDIO_REVERB_DRY_LEVEL = 0, AUDIO_REVERB_TYPE.AUDIO_REVERB_WET_LEVEL = 1, AUDIO_REVERB_TYPE.AUDIO_REVERB_ROOM_SIZE = 2, AUDIO_REVERB_TYPE.AUDIO_REVERB_WET_DELAY = 3,
  AUDIO_REVERB_TYPE.AUDIO_REVERB_STRENGTH = 4
}
 
enum  AUDIO_CODEC_PROFILE_TYPE { AUDIO_CODEC_PROFILE_TYPE.AUDIO_CODEC_PROFILE_LC_AAC = 0, AUDIO_CODEC_PROFILE_TYPE.AUDIO_CODEC_PROFILE_HE_AAC = 1 }
 
enum  VIDEO_CODEC_TYPE { VIDEO_CODEC_TYPE.VIDEO_CODEC_VP8 = 1, VIDEO_CODEC_TYPE.VIDEO_CODEC_H264 = 2, VIDEO_CODEC_TYPE.VIDEO_CODEC_EVP = 3, VIDEO_CODEC_TYPE.VIDEO_CODEC_E264 = 4 }
 
enum  AREA_CODE : uint {
  AREA_CODE.AREA_CODE_CN = (1 << 0), AREA_CODE.AREA_CODE_NA = (1 << 1), AREA_CODE.AREA_CODE_EUR = (1 << 2), AREA_CODE.AREA_CODE_AS = (1 << 3),
  AREA_CODE.AREA_CODE_GLOBAL = 0xFFFFFFFF
}
 
enum  FRAME_RATE {
  FRAME_RATE.FRAME_RATE_FPS_1 = 1, FRAME_RATE.FRAME_RATE_FPS_7 = 7, FRAME_RATE.FRAME_RATE_FPS_10 = 10, FRAME_RATE.FRAME_RATE_FPS_15 = 15,
  FRAME_RATE.FRAME_RATE_FPS_24 = 24, FRAME_RATE.FRAME_RATE_FPS_30 = 30, FRAME_RATE.FRAME_RATE_FPS_60 = 60
}
 
enum  ORIENTATION_MODE { ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE = 0, ORIENTATION_MODE.ORIENTATION_MODE_FIXED_LANDSCAPE = 1, ORIENTATION_MODE.ORIENTATION_MODE_FIXED_PORTRAIT = 2 }
 
enum  DEGRADATION_PREFERENCE { DEGRADATION_PREFERENCE.MAINTAIN_QUALITY = 0, DEGRADATION_PREFERENCE.MAINTAIN_FRAMERATE = 1, DEGRADATION_PREFERENCE.MAINTAIN_BALANCED = 2 }
 
enum  VIDEO_FRAME_TYPE { VIDEO_FRAME_TYPE.FRAME_TYPE_YUV420 = 0, VIDEO_FRAME_TYPE.FRAME_TYPE_RGBA = 1 }
 
enum  AUDIO_FRAME_TYPE { AUDIO_FRAME_TYPE.FRAME_TYPE_PCM16 = 0 }
 
enum  MEDIA_SOURCE_TYPE { MEDIA_SOURCE_TYPE.AUDIO_PLAYOUT_SOURCE = 0, MEDIA_SOURCE_TYPE.AUDIO_RECORDING_SOURCE = 1 }
 
enum  LASTMILE_PROBE_RESULT_STATE { LASTMILE_PROBE_RESULT_STATE.LASTMILE_PROBE_RESULT_COMPLETE = 1, LASTMILE_PROBE_RESULT_STATE.LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2, LASTMILE_PROBE_RESULT_STATE.LASTMILE_PROBE_RESULT_UNAVAILABLE = 3 }
 
enum  CAMERA_DIRECTION { CAMERA_DIRECTION.CAMERA_REAR = 0, CAMERA_DIRECTION.CAMERA_FRONT = 1 }
 
enum  CAPTURER_OUTPUT_PREFERENCE { CAPTURER_OUTPUT_PREFERENCE.CAPTURER_OUTPUT_PREFERENCE_AUTO = 0, CAPTURER_OUTPUT_PREFERENCE.CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1, CAPTURER_OUTPUT_PREFERENCE.CAPTURER_OUTPUT_PREFERENCE_PREVIEW = 2 }
 
enum  QUALITY_TYPE {
  QUALITY_TYPE.QUALITY_UNKNOWN = 0, QUALITY_TYPE.QUALITY_EXCELLENT = 1, QUALITY_TYPE.QUALITY_GOOD = 2, QUALITY_TYPE.QUALITY_POOR = 3,
  QUALITY_TYPE.QUALITY_BAD = 4, QUALITY_TYPE.QUALITY_VBAD = 5, QUALITY_TYPE.QUALITY_DOWN = 6, QUALITY_TYPE.QUALITY_UNSUPPORTED = 7,
  QUALITY_TYPE.QUALITY_DETECTING = 8
}
 
enum  MEDIA_DEVICE_STATE_TYPE { MEDIA_DEVICE_STATE_TYPE.MEDIA_DEVICE_STATE_ACTIVE = 1, MEDIA_DEVICE_STATE_TYPE.MEDIA_DEVICE_STATE_DISABLED = 2, MEDIA_DEVICE_STATE_TYPE.MEDIA_DEVICE_STATE_NOT_PRESENT = 4, MEDIA_DEVICE_STATE_TYPE.MEDIA_DEVICE_STATE_UNPLUGGED = 8 }
 
enum  INJECT_STREAM_STATUS {
  INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_START_SUCCESS = 0, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_START_TIMEDOUT = 3,
  INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_START_FAILED = 4, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_STOP_SUCCESS = 5, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7,
  INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_STOP_FAILED = 9, INJECT_STREAM_STATUS.INJECT_STREAM_STATUS_BROKEN = 10
}
 
enum  PRIORITY_TYPE { PRIORITY_TYPE.PRIORITY_HIGH = 50, PRIORITY_TYPE.PRIORITY_NORMAL = 100 }
 
enum  LOCAL_AUDIO_STREAM_STATE { LOCAL_AUDIO_STREAM_STATE.LOCAL_AUDIO_STREAM_STATE_STOPPED = 0, LOCAL_AUDIO_STREAM_STATE.LOCAL_AUDIO_STREAM_STATE_RECORDING = 1, LOCAL_AUDIO_STREAM_STATE.LOCAL_AUDIO_STREAM_STATE_ENCODING = 2, LOCAL_AUDIO_STREAM_STATE.LOCAL_AUDIO_STREAM_STATE_FAILED = 3 }
 
enum  LOCAL_AUDIO_STREAM_ERROR {
  LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_OK = 0, LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_FAILURE = 1, LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY = 3,
  LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE = 4, LOCAL_AUDIO_STREAM_ERROR.LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5
}
 
enum  REMOTE_AUDIO_STATE {
  REMOTE_AUDIO_STATE.REMOTE_AUDIO_STATE_STOPPED = 0, REMOTE_AUDIO_STATE.REMOTE_AUDIO_STATE_STARTING = 1, REMOTE_AUDIO_STATE.REMOTE_AUDIO_STATE_DECODING = 2, REMOTE_AUDIO_STATE.REMOTE_AUDIO_STATE_FROZEN = 3,
  REMOTE_AUDIO_STATE.REMOTE_AUDIO_STATE_FAILED = 4
}
 
enum  REMOTE_AUDIO_STATE_REASON {
  REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_INTERNAL = 0, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_LOCAL_MUTED = 3,
  REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_REMOTE_MUTED = 5, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6, REMOTE_AUDIO_STATE_REASON.REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7
}
 
enum  AUDIO_SESSION_OPERATION_RESTRICTION {
  AUDIO_SESSION_OPERATION_RESTRICTION.AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0, AUDIO_SESSION_OPERATION_RESTRICTION.AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1, AUDIO_SESSION_OPERATION_RESTRICTION.AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1, AUDIO_SESSION_OPERATION_RESTRICTION.AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2,
  AUDIO_SESSION_OPERATION_RESTRICTION.AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7
}
 
enum  CHANNEL_MEDIA_RELAY_EVENT {
  CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_NETWORK_DISCONNECTED = 0, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_NETWORK_CONNECTED = 1, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3,
  CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7,
  CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10, CHANNEL_MEDIA_RELAY_EVENT.RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11
}
 
enum  CHANNEL_MEDIA_RELAY_STATE { CHANNEL_MEDIA_RELAY_STATE.RELAY_STATE_IDLE = 0, CHANNEL_MEDIA_RELAY_STATE.RELAY_STATE_CONNECTING = 1, CHANNEL_MEDIA_RELAY_STATE.RELAY_STATE_RUNNING = 2, CHANNEL_MEDIA_RELAY_STATE.RELAY_STATE_FAILURE = 3 }
 
enum  VIDEO_PROFILE_TYPE {
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_120P = 0, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_120P_3 = 2, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_180P = 10, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_180P_3 = 12,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_180P_4 = 13, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_240P = 20, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_240P_3 = 22, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_240P_4 = 23,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P = 30, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_3 = 32, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_4 = 33, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_6 = 35,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_7 = 36, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_8 = 37, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_9 = 38, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_10 = 39,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_360P_11 = 100, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P = 40, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_3 = 42, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_4 = 43,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_6 = 45, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_8 = 47, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_9 = 48, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_480P_10 = 49,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_720P = 50, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_720P_3 = 52, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_720P_5 = 54, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_720P_6 = 55,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_1080P = 60, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_1440P = 66,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_4K = 70, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_120P = 1000,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_180P = 1010, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_180P_4 = 1013,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_240P = 1020, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P = 1030,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_7 = 1036,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_10 = 1039, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_360P_11 = 1100,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P = 1040, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_6 = 1045,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_480P_10 = 1049, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_720P = 1050,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_1080P = 1060,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_1440P = 1066, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067,
  VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_4K = 1070, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, VIDEO_PROFILE_TYPE.VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P
}
 
enum  CHANNEL_MEDIA_RELAY_ERROR {
  CHANNEL_MEDIA_RELAY_ERROR.RELAY_OK = 0, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_SERVER_ERROR_RESPONSE = 1, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_SERVER_NO_RESPONSE = 2, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3,
  CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_FAILED_JOIN_SRC = 4, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_FAILED_JOIN_DEST = 5, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7,
  CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_SERVER_CONNECTION_LOST = 8, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_INTERNAL_ERROR = 9, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_SRC_TOKEN_EXPIRED = 10, CHANNEL_MEDIA_RELAY_ERROR.RELAY_ERROR_DEST_TOKEN_EXPIRED = 11
}
 
enum  METADATA_TYPE { METADATA_TYPE.UNKNOWN_METADATA = -1, METADATA_TYPE.VIDEO_METADATA = 0 }
 
enum  RENDER_MODE_TYPE { RENDER_MODE_TYPE.RENDER_MODE_HIDDEN = 1, RENDER_MODE_TYPE.RENDER_MODE_FIT = 2, RENDER_MODE_TYPE.RENDER_MODE_ADAPTIVE = 3 }
 
enum  VIDEO_MIRROR_MODE_TYPE { VIDEO_MIRROR_MODE_TYPE.VIDEO_MIRROR_MODE_AUTO = 0, VIDEO_MIRROR_MODE_TYPE.VIDEO_MIRROR_MODE_ENABLED = 1, VIDEO_MIRROR_MODE_TYPE.VIDEO_MIRROR_MODE_DISABLED = 2 }
 

函数

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 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 OnStreamInjectedStatusHandler (string url, uint userId, int status)
 
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 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_ERROR_TYPE errorCode)
 
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 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 ChannelOnStreamInjectedStatusHandler (string channelId, string url, uint uid, int status)
 
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)
 

枚举类型说明

◆ VIDEO_RENDER_MODE

视频渲染模式。

枚举值
RENDER_RAWDATA 

100: (默认)RAWDATA。

REDNER_OPENGL_ES2 

101: OpenGLES 2。

RENDER_UNITY_LOW_LEVEL_INTERFACE 

102: Unity 底层接口。

◆ ERROR_CODE

错误码。更多错误码描述见 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

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

枚举值
REMOTE_VIDEO_STREAM_HIGH 

0: 视频大流。

REMOTE_VIDEO_STREAM_LOW 

1: 视频小流。

◆ 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) 的情况下,会报告该状态。

◆ USER_OFFLINE_REASON

用户离线原因。

枚举值
QUIT 

0: 用户主动离开。

DROPPED 

1: 因过长时间收不到对方数据包,超时掉线。注意:由于 SDK 使用的是不可靠通道,也有可能对方主动离开本方没收到对方离开消息而误判为超时掉线。

BECOME_AUDIENCE 

2: (直播场景中)用户身份从主播切换为观众时触发。

◆ LOG_FILTER

日志过滤分级

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

频道场景。

枚举值
CHANNEL_PROFILE_COMMUNICATION 

0: 通信场景 (默认)。用于常见的一对一或群聊,频道中的任何用户可以自由说话。

CHANNEL_PROFILE_LIVE_BROADCASTING 

1: 直播场景。直播场景有主播和观众两种用户角色,可以通过调用 SetClientRole 设置。主播可收发语音和视频,但观众只能收,不能发。

CHANNEL_PROFILE_GAME 

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

◆ AUDIO_RECORDING_QUALITY_TYPE

录音音质。

枚举值
AUDIO_RECORDING_QUALITY_LOW 

0: 低音质。采样率为 32 kHz,录制 10 分钟的文件大小为 1.2 M 左右。

AUDIO_RECORDING_QUALITY_MEDIUM 

1: 中音质。采样率为 32 kHz,录制 10 分钟的文件大小为 2 M 左右。

AUDIO_RECORDING_QUALITY_HIGH 

2: 高音质。采样率为 32 kHz,录制 10 分钟的文件大小为 3.75 M 左右。

◆ 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 

5: 使用蓝牙耳机为语音路由。

◆ CONNECTION_STATE_TYPE

网络连接状态。

枚举值
CONNECTION_STATE_DISCONNECTED 

1: 网络连接断开。

CONNECTION_STATE_CONNECTING 

2: 建立网络连接中。

CONNECTION_STATE_CONNECTED 

3: 网络已连接。 该状态表示用户已经加入频道,可以在频道内发布或订阅媒体流。如果因网络断开或切换而导致 SDK 与频道的连接中断,SDK 会自动重连,此时应用程序会收到:

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

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

枚举值
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: 此用户被服务器禁止。

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)

◆ STREAM_FALLBACK_OPTIONS

音视频流回退处理选项。

枚举值
STREAM_FALLBACK_OPTION_DISABLED 

0: 上行/下行网络较弱时,不对音视频流作回退处理,但不能保证音视频流的质量。

STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW 

1: 在下行网络条件较差时只接收视频小流(低分辨率、低码率视频流)。该选项只对 SetRemoteSubscribeFallbackOption 有效,对 SetLocalPublishFallbackOption 方法无效。

STREAM_FALLBACK_OPTION_AUDIO_ONLY 

2: 上行/下行网络较弱时,先尝试只接收视频小流(低分辨率、低码率视频流);如果网络环境无法显示视频,则再回退到只接收远端订阅的音频流。

◆ VideoContentHint

屏幕共享的内容类型。

枚举值
CONTENT_HINT_NONE 

(默认)无指定的内容类型。

CONTENT_HINT_MOTION 

内容类型为动画。当共享的内容是视频、电影或视频游戏时,推荐选择该内容类型。

CONTENT_HINT_DETAILS 

内容类型为细节。当共享的内容是图片或文字时,推荐选择该内容类型。

◆ 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: 回退的远端音频流恢复为视频流。

◆ 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: 本地视频启动失败。

◆ 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: 本地视频编码失败。

◆ CLIENT_ROLE_TYPE

直播场景里的用户角色。

枚举值
CLIENT_ROLE_BROADCASTER 

1: 主播,可以发布和接收音视频流。

CLIENT_ROLE_AUDIENCE 

2: 观众,默认角色,只能接收音视频流,无法发布。

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

◆ RAW_AUDIO_FRAME_OP_MODE_TYPE

指定 OnRecordAudioFrameHandlerOnPlaybackAudioFrameHandler 回调的使用模式。

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

音频属性。

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

枚举值
AUDIO_PROFILE_DEFAULT 

0: 默认设置。

  • 通信场景下:
    • Windows: 16 KHz 采样率,语音编码,单声道,编码码率最大值为 16 Kbps。
    • Android/iOS/macOS: 32 KHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。
  • 直播场景下:全平台为 48 KHz 采样率,音乐编码,单声道,编码码率最大值为 52 Kbps。
AUDIO_PROFILE_SPEECH_STANDARD 

1: 指定 32 kHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。

AUDIO_PROFILE_MUSIC_STANDARD 

2: 指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 48 Kbps。

AUDIO_PROFILE_MUSIC_STANDARD_STEREO 

3: 指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 56 Kbps。

AUDIO_PROFILE_MUSIC_HIGH_QUALITY 

4: 指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 128 Kbps。

AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO 

5: 指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 192 Kbps。

AUDIO_PROFILE_IOT 

6: 指定 16 kHz 采样率,语音编码,单声道,应用回声消除算法 AES。

◆ 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: 物联网应用。

◆ 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 级别的视频编码规格,一般用于广播及视频碟片存储,高清电视。

◆ 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

◆ AUDIO_MIXING_STATE_TYPE

音乐文件播放状态。

枚举值
AUDIO_MIXING_STATE_PLAYING 

710: 音乐文件正常播放。

   该状态表示 SDK 处于以下阶段:
   - 成功调用 {@link agora_gaming_rtc.IRtcEngine.StartAudioMixing StartAudioMixing} 播放音乐文件。
   - 成功调用 {@link agora_gaming_rtc.IRtcEngine.ResumeAudioMixing ResumeAudioMixing} 恢复播放音乐文件。
AUDIO_MIXING_STATE_PAUSED 

711: 音乐文件暂停播放。

   该状态表示 SDK 成功调用 {@link agora_gaming_rtc.IRtcEngine.PauseAudioMixing PauseAudioMixing} 暂停播放音乐文件。
AUDIO_MIXING_STATE_STOPPED 

713: 音乐文件停止播放。

   该状态表示 SDK 成功调用 {@link agora_gaming_rtc.IRtcEngine.StopAudioMixing StopAudioMixing} 停止播放音乐文件。
AUDIO_MIXING_STATE_FAILED 

714: 音乐文件报错。

   错误类型详见: #AUDIO_MIXING_ERROR_TYPE 。

◆ 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: 音乐文件状态正常。

◆ RTMP_STREAM_PUBLISH_STATE

推流状态。

枚举值
RTMP_STREAM_PUBLISH_STATE_IDLE 

0: 推流未开始或已结束。成功调用 RemovePublishStreamUrl 方法删除推流地址后,也会返回该状态。

RTMP_STREAM_PUBLISH_STATE_CONNECTING 

1: 正在连接 Agora 推流服务器和 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 秒太长,也可以主动调用 RemovePublishStreamUrlAddPublishStreamUrl 方法尝试重连。
RTMP_STREAM_PUBLISH_STATE_FAILURE 

4: 推流失败。失败后,你可以通过返回的错误码排查错误原因,也可以再次调用 AddPublishStreamUrl 重新尝试推流。

◆ RTMP_STREAM_PUBLISH_ERROR

推流错误信息。

枚举值
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: 推流地址格式有错误。请检查推流地址格式是否正确。

◆ 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 移动网络。

◆ VOICE_CHANGER_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

预设的音效。

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

虚拟立体声。虚拟立体声是指将单声道的音轨渲染出立体声的效果,使频道内所有用户听到有空间感的声音 效果。为达到更好的虚拟立体声效果,Agora 推荐在调用该方法前将 SetAudioProfileprofile 参 数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)

◆ 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

◆ QUALITY_ADAPT_INDICATION

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

枚举值
ADAPT_NONE 

本地视频质量不变。

ADAPT_UP_BANDWIDTH 

因网络带宽增加,本地视频质量改善。

ADAPT_DOWN_BANDWIDTH 

因网络带宽减少,本地视频质量变差。

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

◆ AUDIO_CODEC_PROFILE_TYPE

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

枚举值
AUDIO_CODEC_PROFILE_LC_AAC 

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

AUDIO_CODEC_PROFILE_HE_AAC 

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

◆ VIDEO_CODEC_TYPE

视频编码格式。

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

(默认)全球。

◆ 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

视频编码的方向模式。

枚举值
ORIENTATION_MODE_ADAPTIVE 

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

  • 如果采集的视频是横屏模式,则输出的视频也是横屏模式;
  • 如果采集的视频是竖屏模式,则输出的视频也是竖屏模式。
ORIENTATION_MODE_FIXED_LANDSCAPE 

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

ORIENTATION_MODE_FIXED_PORTRAIT 

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

◆ DEGRADATION_PREFERENCE

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

枚举值
MAINTAIN_QUALITY 

0: (默认)降低编码帧率以保证视频质量。

MAINTAIN_FRAMERATE 

1: 降低视频质量以保证编码帧率。

MAINTAIN_BALANCED 

2: 预留参数,暂不支持。

◆ VIDEO_FRAME_TYPE

视频帧类型。仅支持 FRAME_TYPE_RGBA

枚举值
FRAME_TYPE_YUV420 

0: YUV420

FRAME_TYPE_RGBA 

1: RGBA

◆ AUDIO_FRAME_TYPE

音频帧类型。

枚举值
FRAME_TYPE_PCM16 

0: PCM16

◆ MEDIA_SOURCE_TYPE

弃用:
音频采集设备类型。
枚举值
AUDIO_PLAYOUT_SOURCE 

0: 音频播放设备。

AUDIO_RECORDING_SOURCE 

1: 音频录制设备。

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

◆ CAMERA_DIRECTION

摄像头方向。

枚举值
CAMERA_REAR 

0: 后置摄像头。

CAMERA_FRONT 

1: 前置摄像头。

◆ CAPTURER_OUTPUT_PREFERENCE

摄像头采集偏好。

枚举值
CAPTURER_OUTPUT_PREFERENCE_AUTO 

0: (默认)自动调整采集参数。SDK 根据实际的采集设备性能及网络情况,选择合适的摄像头输出参数,在设备性能及视频预览质量之间,维持平衡。

CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE 

1: 优先保证设备性能。SDK 根据用户在 SetVideoEncoderConfiguration 中设置编码器的分辨率和帧率,选择最接近的摄像头输出参数,从而保证设备性能。在这种情况下,预览质量接近于编码器的输出质量。

CAPTURER_OUTPUT_PREFERENCE_PREVIEW 

2: 中设置编码器的分辨率和帧率,选择最接近的摄像头输出参数,从而保证设备性能。在这种情况下,预览质量接近于编码器的输出质量。

◆ QUALITY_TYPE

网络质量。

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

设备状态。

枚举值
MEDIA_DEVICE_STATE_ACTIVE 

1: 设备正在使用。

MEDIA_DEVICE_STATE_DISABLED 

2: 设备被禁用。

MEDIA_DEVICE_STATE_NOT_PRESENT 

4: 没有此设备。

MEDIA_DEVICE_STATE_UNPLUGGED 

8: 设备被拔出。

◆ INJECT_STREAM_STATUS

输入的外部视频源状态。

枚举值
INJECT_STREAM_STATUS_START_SUCCESS 

0: 外部视频流输入成功。

INJECT_STREAM_STATUS_START_ALREADY_EXISTS 

1: 外部视频流已存在。

INJECT_STREAM_STATUS_START_UNAUTHORIZED 

2: 外部视频流输入未经授权。

INJECT_STREAM_STATUS_START_TIMEDOUT 

3: 输入外部视频流超时。

INJECT_STREAM_STATUS_START_FAILED 

4: 外部视频流输入失败。

INJECT_STREAM_STATUS_STOP_SUCCESS 

5: 外部视频流停止输入成功。

INJECT_STREAM_STATUS_STOP_NOT_FOUND 

6: 未找到要停止输入的外部视频流。

INJECT_STREAM_STATUS_STOP_UNAUTHORIZED 

7: 要停止输入的外部视频流未经授权。

INJECT_STREAM_STATUS_STOP_TIMEDOUT 

8: 停止输入外部视频流超时。

INJECT_STREAM_STATUS_STOP_FAILED 

9: 停止输入外部视频流失败。

INJECT_STREAM_STATUS_BROKEN 

10: 输入的外部视频流被中断。

◆ PRIORITY_TYPE

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

枚举值
PRIORITY_HIGH 

50: 用户需求优先级为高。

PRIORITY_NORMAL 

100: (默认)用户需求优先级为正常。

◆ 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

本地音频出错原因。

枚举值
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: 本地音频编码失败。

◆ 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

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

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

音频会话控制权限。

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

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

枚举值
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: 视频属性已发送至服务器。

◆ CHANNEL_MEDIA_RELAY_STATE

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

枚举值
RELAY_STATE_IDLE 

0: SDK 正在初始化。

RELAY_STATE_CONNECTING 

1: SDK 尝试跨频道。

RELAY_STATE_RUNNING 

2: 源频道主播成功加入目标频道。

RELAY_STATE_FAILURE 

3: 发生异常,详见 code 中提示的错误信息。

◆ 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。

注解
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。

注解
Live broadcast profile only.
VIDEO_PROFILE_PORTRAIT_360P_10 

1039: 360 × 640,帧率 24 fps,码率 800 Kbps。

注解
Live broadcast profile only.
VIDEO_PROFILE_PORTRAIT_360P_11 

1100: 360 × 640,帧率 24 fps,码率 1000 Kbps。

注解
Live broadcast profile only.
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

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

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

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

枚举值
UNKNOWN_METADATA 

-1: Metadata 类型未知。

VIDEO_METADATA 

0: Metadata 类型为视频。

◆ RENDER_MODE_TYPE

设置视频显示模式。

枚举值
RENDER_MODE_HIDDEN 

1: 视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉。

RENDER_MODE_FIT 

2: 视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充黑色。

RENDER_MODE_ADAPTIVE 
弃用:
3: 该模式已废弃。

◆ VIDEO_MIRROR_MODE_TYPE

镜像模式类型。

枚举值
VIDEO_MIRROR_MODE_AUTO 

0:(默认)SDK 启用镜像模式。

VIDEO_MIRROR_MODE_ENABLED 

1: 启用镜像模式。

VIDEO_MIRROR_MODE_DISABLED 

2: 关闭镜像模式。

函数说明

◆ OnJoinChannelSuccessHandler()

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

加入频道回调。

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

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

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

参数
channelName频道名。
uid用户 ID。如果 JoinChannelByKey 中指定了 uid,则此处返回该 ID;否则使用 Agora 服务器自动分配的 ID。
elapsedJoinChannelByKey 开始到发生此事件过去的时间(毫秒)。

◆ 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,然后调用 JoinChannelByKey,使用新的 Token 重新加入频道。

◆ OnUserJoinedHandler()

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

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

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

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

  • 远端用户/主播调用 JoinChannelByKey 方法加入频道。
  • 远端用户加入频道后调用 SetClientRole 将用户角色改变为主播。
  • 远端用户/主播网络中断后重新加入频道。
  • 主播通过调用 AddInjectStreamUrl 方法成功输入在线媒体流。
注解
直播场景下:
  • 主播间能相互收到新主播加入频道的回调,并能获得该主播的 uid
  • 观众也能收到新主播加入频道的回调,并能获得该主播的 uid
  • 当 Web 端加入直播频道时,只要 Web 端有推流,SDK 会默认该 Web 端为主播,并触发该回调。
参数
uid新加入频道的远端用户/主播 ID。
elapsed从本地用户调用 JoinChannelByKey 到该回调触发的延迟(毫秒)。

◆ OnUserOfflineHandler()

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

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

提示有远端用户/主播离开了频道(或掉线)。用户离开频道有两个原因,即正常离开和超时掉线:

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

◆ OnVolumeIndicationHandler()

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

提示频道内谁正在说话、说话者音量及本地用户是否在说话的回调。

该回调报告频道内瞬时音量最高的几个用户(最多三人)的用户 ID、他们的音量及本地用户是否在说话。

该回调默认禁用。可以通过 EnableAudioVolumeIndication 方法开启;开启后,无论频道内是否有人说话,SDK 都会按 enableAudioVolumeIndication 方法中设置的时间间隔触发 OnVolumeIndicationHandler 回调。每次触发,用户会收到两个独立的 OnVolumeIndicationHandler 回调,其中一个包含本地用户的音量信息,另一个包含远端所有用户的音量信息,详见下方参数描述。

注解
  • 若需使用该回调 speakers 数组中的 vad 参数(即本地人声检测功能),请在 EnableAudioVolumeIndication 方法中设置 report_vadtrue
  • 如果有用户将自己静音(调用了 MuteLocalAudioStream),会对该回调的行为产生影响。
    • 本地用户静音后 SDK 即不再报告本地用户的音量提示回调。
    • 远端说话者静音后 20 秒,远端的音量提示回调中将不再包含该用户;如果远端所有用户都将自己静音,20 秒后 SDK 不再报告远端用户的音量提示回调。
参数
speakersAudioVolumeInfo 数组。
  • 在本地用户的回调中,此数组中包含以下成员:
    • uid = 0;
    • volume 等于 totalVolume,报告本地用户混音后的音量;
    • vad,报告本地用户人声状态。
  • 在远端用户的回调中,此数组中包含以下成员:
    • uid 为每位说话者各自的用户 ID;
    • volume 为说话者各自混音后的音量;
    • vad = 0,对远端用户无效。 如果报告的 speakers 数组为空,则表示此时远端没有人说话。
speakerNumber说话者的人数,取值范围为 [0,3]。
  • 在本地用户的回调中,无论本地用户是否说话,speakerNumber 始终为 1。
  • 在远端用户的回调中,若远端用户大于 3,则此回调会报告瞬时音量最高的三位用户的音量信息,此时 speakerNumber 值为 3。
totalVolume(混音后的)总音量,取值范围为 [0,255]。
  • 在本地用户的回调中,totalVolume 为本地用户混音后的音量。
  • 在远端用户的回调中,totalVolume 为所有说话者混音后的总音量。

◆ 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 报告当前通话的统计信息,每两秒触发一次。

参数
statsRTC 引擎统计数据: 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 平台。
参数
route语音路由。详见: AUDIO_ROUTE

◆ OnFirstRemoteVideoDecodedHandler()

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

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

弃用:
该回调已被废弃,请改用 OnRemoteVideoStateChangedHandler 回调的:

引擎收到第一帧远端视频流并解码成功时,触发此调用。 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 改变用户角色触发的。

参数
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。
apiSDK 执行的 API。
resultSDK 调用 API 的调用结果。

◆ OnLastmileQualityHandler()

delegate void agora_gaming_rtc.OnLastmileQualityHandler ( int  quality)

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

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

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

◆ OnFirstLocalAudioFrameHandler()

delegate void agora_gaming_rtc.OnFirstLocalAudioFrameHandler ( int  elapsed)

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

参数
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音频包从发送端到接收端的丢包率 (%)。

◆ OnStreamInjectedStatusHandler()

delegate void agora_gaming_rtc.OnStreamInjectedStatusHandler ( string  url,
uint  userId,
int  status 
)

输入在线媒体流状态回调。

参数
url输入进直播的在线媒体流的地址。
userId用户 ID。
status输入的在线媒体流状态: INJECT_STREAM_STATUS

◆ OnStreamUnpublishedHandler()

delegate void agora_gaming_rtc.OnStreamUnpublishedHandler ( string  url)

旁路推流已停止回调。

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

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

参数
url被删除的 RTMP 推流地址。

◆ OnStreamPublishedHandler()

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

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

弃用:
该回调自 v3.0.1 起废弃,请改用 OnRtmpStreamingStateChangedHandler
参数
url主播推流的 URL 地址 。
errorError 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。
streamIdStream 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 功能,则当音量检测模块监测到频道内有新的活跃用户说话时,会通过本回调返回该用户的用户 ID。

注解
  • 你需要开启 EnableAudioVolumeIndication 方法才能收到该回调。
  • uid 返回的是当前时间段内声音最大的用户的用户 ID,而不是瞬时声音最大的用户的用户 ID。
参数
uid当前时间段声音最大的用户的用户 ID。如果返回的 uid 为 0,则默认为本地用户。

◆ 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 回调的:

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

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

参数
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 是指设备到 Agora 边缘服务器的网络状态。该回调每 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设备状态定义: MEDIA_DEVICE_STATE_TYPE

◆ OnCameraReadyHandler()

delegate void agora_gaming_rtc.OnCameraReadyHandler ( )

摄像头就绪回调。

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

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

◆ 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设备状态: 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 的音量发生改变。

参数
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_ERROR_TYPE  errorCode 
)

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

该回调在音乐文件播放状态发生改变时触发,并报告当前的播放状态和错误码。

如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL,SDK 会返回警告码 WARN_AUDIO_MIXING_OPEN_ERROR(701)

参数
state音乐文件播放状态,详见 AUDIO_MIXING_STATE_TYPE
errorCode错误码,详见 AUDIO_MIXING_ERROR_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 推流状态发生改变回调。

该回调返回本地用户调用 AddPublishStreamUrlRemovePublishStreamUrl 方法的结果。

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

参数
url推流状态发生改变的 URL 地址。
state当前的推流状态,详见 RTMP_STREAM_PUBLISH_STATE 。当推流状态为 RTMP_STREAM_PUBLISH_STATE_FAILURE(4) 时,你可以在 errCode 参数中查看返回的错误信息。
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,则表示没有检测到人脸。

◆ ChannelOnWarningHandler()

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

发生警告回调。

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

参数
channelId频道 ID。
warn警告代码:Warning Code
message警告描述。

◆ ChannelOnErrorHandler()

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

发生错误回调。

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

参数
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;否则使用 Agora 服务器自动分配的 ID。
elapsedJoinChannel 开始到发生此事件过去的时间(毫秒)。

◆ 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 
)

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

直播场景下,当用户切换角色时会触发此回调,即主播切换为观众时,或观众切换为主播时。该回调由本地用户在加入频道后调用 SetClientRole 改变用户角色触发的。

参数
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 将用户角色改变为主播。
  • 远端用户/主播网络中断后重新加入频道。
  • 主播通过调用 AddInjectStreamUrl 方法成功输入在线媒体流。
注解
直播场景下:
  • 主播间能相互收到新主播加入频道的回调,并能获得该主播的 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 秒,直播场景稍有延时),用户没有收到对方的任何数据包,则判定为对方掉线。在网络较差的情况下,有可能会误报。声网建议使用 Agora 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。
rtcStatsAgoraChannel 引擎统计数据: RtcStats

◆ ChannelOnNetworkQualityHandler()

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

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

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

参数
channelId频道 ID。
uid用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。当 uid0 时,返回的是本地用户的网络质量。
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 
)

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

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

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

◆ ChannelOnRemoteAudioStatsHandler()

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

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

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

参数
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 
)

监测到活跃用户回调。

如果用户开启了 EnableAudioVolumeIndication 功能,则当音量检测模块监测到频道内有新的活跃用户说话时,会通过本回调返回该用户的用户 ID。

注解
  • 你需要开启 EnableAudioVolumeIndication 方法才能收到该回调。
  • uid 返回的是当前时间段内声音最大的用户的用户 ID,而不是瞬时声音最大的用户的用户 ID。
参数
channelId频道 ID。
uid当前时间段声音最大的用户的用户 ID。如果返回的 uid0,则默认为本地用户。

◆ ChannelOnVideoSizeChangedHandler()

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

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

参数
channelId频道 ID。
uid图像尺寸和旋转信息发生变化的用户的用户 ID(本地用户的 uid0)。
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。
streamIdStream 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 推流状态发生改变回调。

该回调返回本地用户调用 AddPublishStreamUrlRemovePublishStreamUrl 方法的结果。

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

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

◆ ChannelOnTranscodingUpdatedHandler()

delegate void agora_gaming_rtc.ChannelOnTranscodingUpdatedHandler ( string  channelId)

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

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

注解
首次调用SetLiveTranscoding 方法设置转码参数 LiveTranscoding 时,不会触发此回调。
参数
channelId频道 ID。

◆ ChannelOnStreamInjectedStatusHandler()

delegate void agora_gaming_rtc.ChannelOnStreamInjectedStatusHandler ( string  channelId,
string  url,
uint  uid,
int  status 
)

输入在线媒体流状态回调。

参数
channelId频道 ID。
url输入进直播的在线媒体流的地址。
uid用户 ID。
status输入的在线媒体流状态: INJECT_STREAM_STATUS

◆ ChannelOnRemoteSubscribeFallbackToAudioOnlyHandler()

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

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

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

注解
远端订阅流因弱网环境不能同时满足音视频而回退为小流时,你可以使用 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 
)

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

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

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