文档导航 iOS
本页目录

Talk SDK for iOS 状态码

数值与本平台公开定义核对。通用事件的错误码字段并非总是错误:音量、角色等事件会携带业务数值,应按事件说明处理。

YouMeEvent类型定义

枚举常量值含义
YOUME_EVENT_INIT_OK0SDK初始化成功
YOUME_EVENT_INIT_FAILED1SDK初始化失败
YOUME_EVENT_JOIN_OK2进入语音频道成功
YOUME_EVENT_JOIN_FAILED3进入语音频道失败
YOUME_EVENT_LEAVED_ONE4退出单个语音频道完成
YOUME_EVENT_LEAVED_ALL5退出所有语音频道完成
YOUME_EVENT_PAUSED6暂停语音频道完成
YOUME_EVENT_RESUMED7恢复语音频道完成
YOUME_EVENT_SPEAK_SUCCESS8切换对指定频道讲话成功(适用于多频道模式)
YOUME_EVENT_SPEAK_FAILED9切换对指定频道讲话失败(适用于多频道模式)
YOUME_EVENT_RECONNECTING10断网了,正在重连
YOUME_EVENT_RECONNECTED11断网重连成功
YOUME_EVENT_REC_PERMISSION_STATUS12通知录音权限状态,成功获取权限时错误码为YOUME_SUCCESS,获取失败为YOUME_ERROR_REC_NO_PERMISSION(此时不管麦克风mute状态如何,都没有声音输出)
YOUME_EVENT_BGM_STOPPED13通知战歌播放结束
YOUME_EVENT_BGM_FAILED14通知战歌播放失败
YOUME_EVENT_OTHERS_MIC_ON16其他用户麦克风打开
YOUME_EVENT_OTHERS_MIC_OFF17其他用户麦克风关闭
YOUME_EVENT_OTHERS_SPEAKER_ON18其他用户扬声器打开
YOUME_EVENT_OTHERS_SPEAKER_OFF19其他用户扬声器关闭
YOUME_EVENT_OTHERS_VOICE_ON20其他用户进入讲话状态
YOUME_EVENT_OTHERS_VOICE_OFF21其他用户进入静默状态
YOUME_EVENT_MY_MIC_LEVEL22麦克风的语音级别
YOUME_EVENT_MIC_CTR_ON23麦克风被其他用户打开
YOUME_EVENT_MIC_CTR_OFF24麦克风被其他用户关闭
YOUME_EVENT_SPEAKER_CTR_ON25扬声器被其他用户打开
YOUME_EVENT_SPEAKER_CTR_OFF26扬声器被其他用户关闭
YOUME_EVENT_LISTEN_OTHER_ON27取消屏蔽某人语音
YOUME_EVENT_LISTEN_OTHER_OFF28屏蔽某人语音
YOUME_EVENT_LOCAL_MIC_ON29自己的麦克风打开
YOUME_EVENT_LOCAL_MIC_OFF30自己的麦克风关闭
YOUME_EVENT_LOCAL_SPEAKER_ON31自己的扬声器打开
YOUME_EVENT_LOCAL_SPEAKER_OFF32自己的扬声器关闭
YOUME_EVENT_GRABMIC_START_OK33发起抢麦活动成功
YOUME_EVENT_GRABMIC_START_FAILED34发起抢麦活动失败
YOUME_EVENT_GRABMIC_STOP_OK35停止抢麦活动成功
YOUME_EVENT_GRABMIC_STOP_FAILED36停止抢麦活动失败
YOUME_EVENT_GRABMIC_REQUEST_OK37抢麦成功(可以说话)
YOUME_EVENT_GRABMIC_REQUEST_FAILED38抢麦失败
YOUME_EVENT_GRABMIC_REQUEST_WAIT39进入抢麦等待队列(仅权重模式下会回调此事件)
YOUME_EVENT_GRABMIC_RELEASE_OK40释放麦成功
YOUME_EVENT_GRABMIC_RELEASE_FAILED41释放麦失败
YOUME_EVENT_GRABMIC_ENDMIC42不再占用麦(到麦使用时间或者其他原因)
YOUME_EVENT_GRABMIC_NOTIFY_START43[通知]抢麦活动开始
YOUME_EVENT_GRABMIC_NOTIFY_STOP44[通知]抢麦活动结束
YOUME_EVENT_GRABMIC_NOTIFY_HASMIC45[通知]有麦可以抢
YOUME_EVENT_GRABMIC_NOTIFY_NOMIC46[通知]没有麦可以抢
YOUME_EVENT_INVITEMIC_SETOPT_OK47连麦设置成功
YOUME_EVENT_INVITEMIC_SETOPT_FAILED48连麦设置失败
YOUME_EVENT_INVITEMIC_REQUEST_OK49请求连麦成功(连上了,需等待对方回应)
YOUME_EVENT_INVITEMIC_REQUEST_FAILED50请求连麦失败
YOUME_EVENT_INVITEMIC_RESPONSE_OK51响应连麦成功(被叫方无论同意/拒绝都会收到此事件,错误码是YOUME_ERROR_INVITEMIC_REJECT表示拒绝)
YOUME_EVENT_INVITEMIC_RESPONSE_FAILED52响应连麦失败
YOUME_EVENT_INVITEMIC_STOP_OK53停止连麦成功
YOUME_EVENT_INVITEMIC_STOP_FAILED54停止连麦失败
YOUME_EVENT_INVITEMIC_CAN_TALK55双方可以通话了(响应方已经同意)
YOUME_EVENT_INVITEMIC_CANNOT_TALK56双方不可以再通话了(有一方结束了连麦或者连麦时间到)
YOUME_EVENT_INVITEMIC_NOTIFY_CALL57[通知]有人请求与你连麦
YOUME_EVENT_INVITEMIC_NOTIFY_ANSWER58[通知]对方对你的连麦请求作出了响应(同意/拒绝/超时,同意的话双方就可以通话了)
YOUME_EVENT_INVITEMIC_NOTIFY_CANCEL59[通知]连麦过程中,对方结束了连麦或者连麦时间到
YOUME_EVENT_SEND_MESSAGE_RESULT60sendMessage成功与否的通知,param为回传的requestID
YOUME_EVENT_MESSAGE_NOTIFY61收到Message, param为message内容
YOUME_EVENT_SET_WHITE_USER_LIST_OK62对指定频道设置白名单成功,但可能有异常用户
YOUME_EVENT_SET_WHITE_USER_LIST_FAILED63对指定频道设置白名单失败
YOUME_EVENT_KICK_RESULT64踢人的应答
YOUME_EVENT_KICK_NOTIFY65被踢通知 ,param: (踢人者ID,被踢原因,被禁时间)
YOUME_EVENT_FAREND_VOICE_LEVEL66远端说话人音量大小
YOUME_EVENT_OTHERS_BE_KICKED67房间里其他人被踢出房间
YOUME_EVENT_EFFECT_PLAY_COMPLETE71音效播放完成
YOUME_EVENT_AUDIO_START_FAIL72音频启动失败,可能是设备被其他应用占用
YOUME_EVENT_AUDIO_INPUT_DEVICE_CONNECT73音频采集设备插入,移动端无效
YOUME_EVENT_AUDIO_INPUT_DEVICE_DISCONNECT74音频采集设备拔出,移动端无效
YOUME_EVENT_SWITCH_OUTPUT75切换扬声器/听筒
YOUME_EVENT_CHECK_DEVICE_MUTE_RESULT76获取设备是否禁音的回调,errcode为1表示静音了,为0表示没禁音
YOUME_EVENT_IDENTITY_MODIFY77角色改变, errcode为身份标识,YouMeUserRole
YOUME_EVENT_REPORT_AUDIO78保存本地音频缓存到文件,用于语音上报
YOUME_EVENT_SHOW_RECORD_ALERT79提示录音权限
YOUME_EVENT_BLOCK_CHANNELS80不听指定频道(设置频道收听黑名单)(适用于多频道模式)
YOUME_EVENT_SEND_REPORT_REQ_ACK81举报者发送举报请求响应事件
YOUME_EVENT_REPORT_AUDIO_SERVER_NOTIFY82本地音频上报到server返回举报结果
YOUME_EVENT_REPORT_AUDIO_MASK_NOTIFY83被禁言事件通知
YOUME_EVENT_MEDIA_DATA_ROAD_PASS211音视频数据通路连通,定时检测,一开始收到数据会收到PASS事件,之后变化的时候会发送
YOUME_EVENT_MEDIA_DATA_ROAD_BLOCK212音视频数据通路不通
YOUME_EVENT_OTHER_PLAY_BACKGRAOUND_MUSIC226其他人播放战歌
YOUME_EVENT_OTHER_STOP_BACKGRAOUND_MUSIC227其他人停止战歌
YOUME_EVENT_DATA_DISCONNECT502数据服务断开连接
YOUME_EVENT_EOF1000枚举结束标记,不作为普通业务事件处理

YouMeErrorCode类型定义

枚举常量值含义
YOUME_SUCCESS0成功
YOUME_ERROR_API_NOT_SUPPORTED-1正在使用的SDK不支持特定的API
YOUME_ERROR_INVALID_PARAM-2传入参数错误
YOUME_ERROR_ALREADY_INIT-3已经初始化
YOUME_ERROR_NOT_INIT-4还没有初始化,在调用某函数之前要先调用初始化并且要根据返回值确保初始化成功
YOUME_ERROR_CHANNEL_EXIST-5要加入的频道已经存在
YOUME_ERROR_CHANNEL_NOT_EXIST-6对频道进入(检查参数为true时)、退出、讲话、设置白名单、抢麦等接口时频道不存在
YOUME_ERROR_WRONG_STATE-7状态错误
YOUME_ERROR_NOT_ALLOWED_MOBILE_NETWROK-8不允许使用移动网络
YOUME_ERROR_WRONG_CHANNEL_MODE-9在单频道模式下调用了多频道接口,或者反之
YOUME_ERROR_TOO_MANY_CHANNELS-10同时加入了太多频道
YOUME_ERROR_TOKEN_ERROR-11传入的token认证错误
YOUME_ERROR_NOT_IN_CHANNEL-12用户不在该频道
YOUME_ERROR_BE_KICK-13被踢了,还在禁止时间内,不允许进入房间
YOUME_ERROR_DEVICE_NOT_VALID-14设置的设备不可用
YOUME_ERROR_API_NOT_ALLOWED-15没有特定功能的权限
YOUME_ERROR_NO_LANG_CODE-16翻译功能指定了不存在的语言
YOUME_ERROR_RECONNECT_TIMEOUT-17重连时间超时
YOUME_ERROR_USER_OFFLINE-18用户不在线
YOUME_ERROR_MEMORY_OUT-100内存错误
YOUME_ERROR_START_FAILED-101启动引擎失败
YOUME_ERROR_STOP_FAILED-102停止引擎失败
YOUME_ERROR_ILLEGAL_SDK-103非法使用SDK
YOUME_ERROR_SERVER_INVALID-104语音服务不可用
YOUME_ERROR_NETWORK_ERROR-105网络错误
YOUME_ERROR_SERVER_INTER_ERROR-106服务器内部错误
YOUME_ERROR_QUERY_RESTAPI_FAIL-107请求RestApi信息失败了
YOUME_ERROR_USER_ABORT-108用户请求中断当前操作
YOUME_ERROR_SEND_MESSAGE_FAIL-109发送消息失败
YOUME_ERROR_CREATE_FILE_FAIL-114创建文件失败
YOUME_ERROR_FUNCTION_NOT_OPEN-115功能未打开,可能某些必要的开放功能接口未调用
YOUME_ERROR_UPLOAD_REPORT_AUDIO_FAIL-116上传音频文件失败
YOUME_ERROR_UPLOAD_LOG_TIMEOUT-117日志上传超时
YOUME_ERROR_UPLOAD_LOG_FILE_ERROR-118日志上传内部错误
YOUME_ERROR_UPLOAD_LOG_NETWORK_ERROR-119日志上传发生网络错误
YOUME_ERROR_UPLOAD_LOG_SERVER_ERROR-120日志上传发生服务器错误
YOUME_ERROR_REC_INIT_FAILED-201录音模块初始化失败
YOUME_ERROR_REC_NO_PERMISSION-202没有录音权限
YOUME_ERROR_REC_NO_DATA-203虽然初始化成功,但没有音频数据输出,比如oppo系列手机在录音权限被禁止的时候
YOUME_ERROR_REC_OTHERS-204其他录音模块的错误
YOUME_ERROR_REC_PERMISSION_UNDEFINED-205录音权限未确定,iOS显示是否允许录音权限对话框时,返回的是这个错误码
YOUME_ERROR_RECORD_ALERT_REFUSED-206录音权限提示,被拒绝了
YOUME_ERROR_GRABMIC_FULL-301抢麦失败,人数满
YOUME_ERROR_GRABMIC_HASEND-302抢麦失败,活动已经结束
YOUME_ERROR_INVITEMIC_NOUSER-401连麦失败,用户不存在
YOUME_ERROR_INVITEMIC_OFFLINE-402连麦失败,用户已离线
YOUME_ERROR_INVITEMIC_REJECT-403连麦失败,用户拒绝
YOUME_ERROR_INVITEMIC_TIMEOUT-404连麦失败,两种情况:1.连麦时,对方超时无应答 2.通话中,双方通话时间到
YOUME_ERROR_WHITE_SOMEUSER_ABNORMAL-501设置白名单部分用户异常:已不在房间
YOUME_ERROR_MAGICVOICE_EXPIRED-601变声音效已过期
YOUME_ERROR_FREQUENCY_TOO_HIGH-701检测频率过快
YOUME_ERROR_NOT_IN_RANGE_AUDIO_ROOM-702不在范围语音房间
YOUME_ERROR_UNKNOWN-1000未知错误

YOUME_RTC_SERVER_REGION类型定义

枚举常量值含义
RTC_CN_SERVER0中国
RTC_HK_SERVER1香港
RTC_US_SERVER2美国东部
RTC_SG_SERVER3新加坡
RTC_KR_SERVER4韩国
RTC_AU_SERVER5澳洲
RTC_DE_SERVER6德国
RTC_BR_SERVER7巴西
RTC_IN_SERVER8印度
RTC_JP_SERVER9日本
RTC_IE_SERVER10爱尔兰
RTC_USW_SERVER11美国西部
RTC_USM_SERVER12美国中部
RTC_CA_SERVER13加拿大
RTC_LON_SERVER14伦敦
RTC_FRA_SERVER15法兰克福
RTC_DXB_SERVER16迪拜
RTC_EXT_SERVER10000使用扩展服务器
RTC_DEFAULT_SERVER10001缺省服务器

ChannelState类型定义

枚举常量值含义
CHANNEL_STATE_JOINIING0正在加入频道
CHANNEL_STATE_JOINED1已经加入频道
CHANNEL_STATE_LEAVING_ONE2正在离开单个频道
CHANNEL_STATE_LEAVING_ALL3正在离开所有频道
CHANNEL_STATE_LEAVED4已经离开频道

YouMeKickReason类型定义

枚举常量值含义
YOUME_KICK_ADMIN1管理员踢人
YOUME_KICK_RELOGIN2多端登录被踢

YouMeUserRole类型定义

枚举常量值含义
YOUME_USER_NONE0非法用户,调用API时不能传此参数
YOUME_USER_TALKER_FREE1自由讲话者,适用于小组通话(建议小组成员数最多10个),每个人都可以随时讲话, 同一个时刻只能在一个语音频道里面
YOUME_USER_TALKER_ON_DEMAND2需要通过抢麦等请求麦克风权限之后才可以讲话,适用于较大的组或工会等(比如几十个人),同一个时刻只能有一个或几个人能讲话, 同一个时刻只能在一个语音频道里面
YOUME_USER_LISTENER3听众,主播/指挥/嘉宾的听众,同一个时刻只能在一个语音频道里面,只听不讲
YOUME_USER_COMMANDER4指挥,国家/帮派等的指挥官,同一个时刻只能在一个语音频道里面,可以随时讲话,可以播放战歌,戴耳机情况下可以监听自己语音
YOUME_USER_HOST5主播,广播型语音频道的主持人,同一个时刻只能在一个语音频道里面,可以随时讲话,可以播放战歌,戴耳机情况下可以监听自己语音
YOUME_USER_GUSET6嘉宾,主播或指挥邀请的连麦嘉宾,同一个时刻只能在一个语音频道里面, 可以随时讲话

YouMeAVStatisticType类型定义

枚举常量值含义
YOUME_AVS_NONE0按对应接口或事件定义处理
YOUME_AVS_AUDIO_CODERATE1音频传输码率,userid是自己:上行码率,userid其它人:下行码率,单位Bps
YOUME_AVS_VIDEO_CODERATE2camera视频传输码率,userid是自己:上行码率,userid其它人:下行码率,单位Bps
YOUME_AVS_VIDEO_FRAMERATE3视频帧率,userid是自己:上行帧率,userid其它人:下行帧率
YOUME_AVS_AUDIO_PACKET_UP_LOSS_RATE4音频上行丢包率(全程),千分比
YOUME_AVS_AUDIO_PACKET_DOWN_LOSS_RATE5音频下行丢包率(全程),千分比
YOUME_AVS_VIDEO_PACKET_UP_LOSS_RATE6视频上行丢包率(全程),千分比
YOUME_AVS_VIDEO_PACKET_DOWN_LOSS_RATE7视频下行丢包率(全程),千分比
YOUME_AVS_AUDIO_DELAY_MS8音频延迟(RTT),单位毫秒
YOUME_AVS_VIDEO_DELAY_MS9视频延迟(RTT),单位毫秒
YOUME_AVS_VIDEO_BLOCK10视频卡顿,是否发生过卡顿
YOUME_AVS_AUDIO_PACKET_UP_LOSS_HALF11音频上行的服务器丢包率(半程),千分比
YOUME_AVS_VIDEO_PACKET_UP_LOSS_HALF12视频上行的服务器丢包率(半程),千分比
YOUME_AVS_RECV_DATA_STAT13下行带宽,单位Bps
YOUME_AVS_VIDEO_SHARE_CODERATE14共享视频传输码率,userid是自己:上行码率,userid其它人:下行码率,单位Bps
YOUME_AVS_VIDEO_SHARE_FRAMERATE15共享视频传输帧率,userid是自己:上行帧率,userid其它人:下行帧率
YOUME_AVS_VIDEO_RESOLUTION16视频分辨率上报, userid是自己:上行分辨率,userid其它人:下行分辨率
YOUME_AVS_VIDEO_SHARE_RESOLUTION17共享流分辨率上报, userid是自己:上行分辨率,userid其它人:下行分辨率
YOUME_AVS_SEND_DATA_STAT18上行带宽,单位Bps
YOUME_AVS_VIDEO_SHARE_CAPTURE_FRAMERATE19共享视频采集帧率,userid是自己:采集帧率,userid其它人:解码输入帧率/回调帧率
YOUME_AVS_VIDEO_SHARE_MAX_CAPTURE_DELAY20共享视频采集最大延时, userid是自己:采集帧间隔,userid其它人:解码输入间隔/回调间隔
YOUME_AVS_VIDEO_SHARE_SDK_DELAY21共享视频SDK处理耗时,userid是自己:发送端,userid其它人:接收端

YouMeBroadcast类型定义

枚举常量值含义
YOUME_BROADCAST_NONE0按对应接口或事件定义处理
YOUME_BROADCAST_GRABMIC_BROADCAST_GETMIC1有人抢到了麦
YOUME_BROADCAST_GRABMIC_BROADCAST_FREEMIC2有人释放了麦
YOUME_BROADCAST_INVITEMIC_BROADCAST_CONNECT3A和B正在连麦
YOUME_BROADCAST_INVITEMIC_BROADCAST_DISCONNECT4A和B取消了连麦

PcmCallBackFlag类型定义

枚举常量值含义
PcmCallbackFlag_Remote1远端pcm回调
PcmCallbackFlag_Record2本地录音回调
PcmCallbackFlag_Mix4本地录音和远端pcm进行mix之后的回调

混响音效类型定义

setAudioEffectType / SetAudioEffectType 接收以下整数值。名称用于说明音效,调用时按本平台参数类型传数值。

类型值含义
NONE0无特殊混响
CLARITY1清晰模式
POP2流行模式
HALL3大厅模式
DANCE4舞曲模式
ROOM5房间模式
COMPRESS6压限均衡