描述: 初始化参数
名称 | 类型 | 是否必填 | 默认值 | 描述 | 备注 |
|
|
|
|
| 3.10+请使用enterpriseID |
enterpriseID | NSString * | 是 | 无 | 企业ID，在管理平台生成，不能为空 | 3.10+ |
clientID | NSString * | 否 | 无 | 客户端ID，在管理平台生成 | 3.10+请使用ci |
|
|
|
|
| 3.10+请使用cc |
ci | NSString * | 否 | 无 | 客户端ID，在管理平台生成 | 3.10+ |
cc | NSString * | 否 | 无 | 客户端Secret，在管理平台生成 | 3.10+ |
server | NSString * | 否 | 无 | server地址，默认小鱼云环境 | |
httpPort | NSString * | 否 | 无 | http端口号，默认80 | |
httpsPort | NSString * | 否 | 无 | https端口号，默认443 | |
SocksProxyIp | NSString * | 否 | 无 | socks代理 ip | |
SocksProxyPort | NSString * | 否 | 无 | socks代理 端口 | |
SocksProxyUserName | NSString * | 否 | 无 | socks代理 用户名 | |
SocksProxyPassword | NSString * | 否 | 无 | socks代理 密码 | |
level | 否 | XYUILogLevel_Debug | log等级 | ||
logFilePath | NSString * | 否 | Documents/ | log目录地址，默认： | |
logFileName | NSString * | 否 | vulture | log文件名称 | |
enableLog | BOOL | 否 | YES | 是否打印log | |
enableAiCaption | BOOL | 否 | NO | 同传字幕开关 | |
needAudioMeter | BOOL | 否 | NO | 音量探测 | |
needSpeakers | BOOL | 否 | NO | 当前讲话者 | |
trustCertificatesChain | BOOL | 否 | NO | 信任服务端证书 | |
safeMethodRequest | BOOL | 否 | NO | 安全的请求方法，默认值：NO | |
defaultCameraId | NSInteger | 否 | 0 | 摄像头方向，0:后置摄像头,1:前置摄像头，默认值：1 | |
videoDimension | 否 | XYVideoDimension_720P | 视频输出分辨率，默认720p | ||
isSupportManualVideoDimension | BOOL | 否 | NO | 是否支持手动设置分辨率，默认不支持 | |
logFilterDictionary | NSDictionary * | 否 | @{@"LOG_FILTER_BY_KEY_NUM":@{@"password":@(10),@"Password":@(10),@"passwd":@(10),@"pwd":@(10),@"PWD":@(10)}} | 过滤日志中的敏感内容 |
描述: 用户信息
版本支持: 3.10+
名称 | 类型 | 是否必填 | 默认值 | 描述 |
userId | NSInteger | 是 | 0 | 用户ID |
deviceId | NSInteger | 是 | 0 | 设备ID |
deviceType | NSInteger | 是 | 0 | 设备类型 |
displayName | NSString * | 是 | 无 | 用户名 |
callNumber | NSString * | 是 | 无 | 号码 |
accessToken | NSString * | 否 | 无 | 鉴权token，请不要对外泄漏 |
refreshToken | NSString * | 否 | 无 | 刷新token，请不要对外泄漏 |
validDuration | NSInteger | 否 | 0 | accessToken的有效时长 |
callUri | NSString * | 否 | 无 | callUri |
enterpriseId | NSString * | 否 | 无 | 企业id |
securityKey | NSString * | 否 | 无 | sk |
avatar | NSString * | 否 | 无 | 头像 |
NSString * | 否 | 无 | 邮箱地址 | |
error | NSString * | 否 | 无 | 错误信息 |
描述: 会议配置
版本支持: 3.10+
名称 | 类型 | 是否必填 | 默认值 | 描述 |
audioMute | BOOL | 否 | NO | 关闭音频入会 |
videoMute | BOOL | 否 | NO | 关闭视频入会 |
openSpeaker | BOOL | 否 | YES | 是否关闭扬声器 |
isMonitor | BOOL | 否 | NO | 监会者 |
callMode | 否 | 无 | 呼叫模式 | |
scheduledEventId | NSString * | 否 | 无 | 预约会议ID |
描述: 会议配置
版本支持: 3.10+
名称 | 类型 | 是否必填 | 默认值 | 描述 |
password | NSString * | 否 | 无 | 会议密码 |
displayName | NSString * | 否 | 无 | 会中使用名称 |
描述: 会议状态信息
版本支持: 3.10+
名称 | 类型 | 是否必填 | 默认值 | 描述 |
callIndex | NSInteger | 否 | 0 | 呼叫标记 |
state | 否 | 无 | 会议状态 | |
meetingConfig | 否 | 无 | 回调入会参数 | |
meetingId | NSString * | 否 | 无 | 会议id |
meetingNumber | NSString * | 否 | 无 | 会议号或终端号 |
meetingName | NSString * | 否 | 无 | 会议名称 |
reason | NSString * | 否 | 无 | 原因，成功时返回STATE:200，失败时返回对应错误码 |
commonDic | NSDictionary * | 否 | 无 | 通用字段 |
append | NSString * | 否 | 无 | 额外字段 |
hasNormalMeetingNumber | BOOL | 否 | NO | 标记会议号是否为信令上报的正常会议号 |
leaveTimestamp | NSTimeInterval | 否 | 0 | 离会时间戳，单位秒 |
meetingDuration | NSTimeInterval | 否 | 0 | 参会时长，单位秒 |
callType | XYCallType | 否 | 无 | 呼叫类型 |
enableWaitingRoom | BOOL | 否 | NO | 等候室开关 |
waitingRoomState (v3.11+) | 否 | 无 | 等候室状态 |
描述: 会议&直播连接状态
版本支持: 3.10+
名称 | 数值 | 描述 |
XYMeetingState_WillConnecting | 0 | 将要连接 |
XYMeetingState_Connecting | 1 | 正在连接 |
XYMeetingState_Connected | 2 | 已连接 |
XYMeetingState_DisConnected | 3 | 断开连接 |
XYMeetingState_LiveConnecting | 4 | 正在连接 |
XYMeetingState_LiveConnected | 5 | 已连接 |
XYMeetingState_LiveDisConnected | 6 | 断开连接 |
描述: 呼叫的终端类型
版本支持: 3.10+
名称 | 数值 | 描述 |
XYCallType_PIP | 0 | 点对点 |
XYCallType_Conference | 1 | 会议室 |
XYCallType_Device | 2 | 硬件 |
XYCallType_CCC | 3 | 云呼叫中心 |
XYCallType_LiveRoom | 4 | 直播 |
描述: 呼叫模式
版本支持: 3.10+
名称 | 数值 | 描述 |
XYCallMode_AudioVideo | 0 | 音视频 |
XYCallMode_AudioOnly | 1 | 音频 |
XYCallMode_Observer | 2 | 监听 |
XYCallMode_Observed | 3 | |
XYCallMode_TEL | 4 | 电话 |
XYCallMode_Emergency | 5 | |
XYCallMode_ContentOnly | 6 | 仅共享 |
XYCallMode_AV_Inactive | 7 | 无音视频（等候室） |
XYCallMode_DeviceDetection | 8 | 巡检 |
描述: 等候室状态
版本支持: 3.11+
名称 | 数值 | 描述 |
XYWaitingRoomState_Unknown | 0 | 未知 |
XYWaitingRoomState_WaitApprove | 1 | 等待主持人批准 |
XYWaitingRoomState_WaitHostJoin | 2 | 等待主持人入会 |
描述: log等级
版本支持: 3.10+
名称 | 数值 | 描述 |
XYUILogLevel_Error | 0 | 错误信息 |
XYUILogLevel_Warn | 1 | 警告信息 |
XYUILogLevel_Info | 2 | 媒体信息 |
XYUILogLevel_Debug | 3 | 调试信息 |
描述: 设置视频输出分辨率
版本支持: 3.10+
名称 | 数值 | 描述 |
XYVideoDimension_180P | 0 | 320 x 180 |
XYVideoDimension_360P | 1 | 640 x 360 |
XYVideoDimension_720P | 2 | 1280 x 720 |