API 概览

/*
 *  获取XYLinkSDK单例
 *
 *  @return XYLinkSDK SDK单例对象
 */
+ (XYLinkSDK *)sharedXYLinkSDK

/*
 *  初始化XYLinkSDK环境
 *
 *  @param settings 初始化参数
 *  @param aBlock  初始化完成block
 */
- (void)initWithSettings:(XYSettings *)settings block:(sdkCommonFunctionBlock)aBlock

/*
 *  使用第三方用户标识登录
 *
 *  @param extUserId 第三方用户ID，需保证唯一性，建议使用自己业务系统的userId
 *  @param userName 第三方用户名，用于在会议中显示的用户名
 *  @param result 登录结果block，其中第一个BOOL表示登录是否成功，第二个BOOL表示是否需要网络探测，XYUser是账号信息， 登录成功时XYUser.error为nil,登录失败时XYUser.error代表具体的错误信息
 */
- (void)loginExternalAccount:(NSString *)extUserId
                    userName:(NSString *)userName
                      result:(loginResultBlock)result

/*
 *  网络探测结束回调
 *
 *  @param user 登录的用户信息
 *  备注：登录后SDK会自动进行网络探测，App在收到这个回调后才可以发起呼叫
 */
- (void)xyLinkSDKOnNetworkDetectionFinished:(XYUser *)user

/*
 *  使用小鱼账号登录
 *
 *  @param userName 小鱼账号的用户名
 *  @param password 小鱼账号的密码
 *  @param result 登录结果block，其中第一个BOOL表示登录是否成功，第二个BOOL表示是否需要网络探测，XYUser是账号信息，  登录成功时XYUser.error为nil,登录失败时XYUser.error代表具体的错误信息
 */
- (void)loginXYLinkAccount:(NSString *)userName
                  password:(NSString *)password
                    result:(loginResultBlock)result

/*
 *  网络探测结束回调
 *
 *  @param user 登录的用户信息
 *  备注：登录后SDK会自动进行网络探测，App在收到这个回调后才可以发起呼叫
 */
- (void)xyLinkSDKOnNetworkDetectionFinished:(XYUser *)user

/*
 *  登录状态
 */
- (BOOL)isLogin

/*
 *  WS连接状态
 */
- (BOOL)isWSConnected

/*
 *  登录后与小鱼的连接状态
 *
 *  @param isConnect  是否连接
 */
- (void)xyLinkSDKOnConnectStateChanged:(BOOL)isConnect

/*
 *  退出登录
 *
 *  @param block 退出登录结果block，true为退出成功，false为退出失败
 */
- (void)logout:(loginOutBlock)block

/*
 *  同一个账号在其他设备登录时，该账号在之前的设备会被强制下线
 */
- (void)xyLinkSDKOnAccountKickedOut

/*
 *  呼叫
 *
 *  @param number      会议号或终端号，不可为空
 *  @param mode        呼叫类型
 *  @param config      呼叫配置，只在 XYLinkSDKCallMode_AudioVideo 模式下生效，可传nil
 *  备注：请在收到回调xyLinkSDKOnNetworkDetectionFinished后再做呼叫操作。
 */
- (void)makeCall:(NSString *)number callMode:(XYLinkSDKCallMode)mode callConfig:(XYCallConfig *)config

/*
 *  呼叫建立前发生异常的回调
 *
 *  @param number    号码
 *  @param reason    异常状态原因
 */
- (void)xyLinkSDKOnCallFailed:(NSString <em>)number withReason:(NSString </em>)reason;


/*
 *  呼叫状态的回调
 *
 *  @param remoteInfo   呼叫信息 （number:呼叫号码 remoteName：呼叫的名称 ）
 *  @param callState    呼叫状态
 *  @param reason       异常状态原因
 */
- (void)xyLinkSDKOnCallStateChangeWithInfo:(NSDictionary *)remoteInfo
                                     state:(XYLinkCallState)callState
                                    reason:(NSString *)reason

/*
 *  验证入会密码
 *
 *  @param passwordStr 密码
 *  备注：对于有入会密码的会议，需要验证密码
 */
- (void)validatePassword:(NSString *)passwordStr

/*
 *  是否在会议中
 */
- (BOOL)isInMeeting

/*
 * 接听
 *
 */
- (void)acceptCall

/*
 *  来电的回调
 *
 *  @param number         号码
 *  @param displayName    名称
 */
- (void)xyLinkSDKOnReceivedCall:(NSString *)number displayName:(NSString *)displayName

/*
 * 挂断
 *
 * @param type 挂断类型，没有与之对应的呼叫，不会进行任何操作
 */
- (void)hangup:(XYLinkSDKHangupType)type

/*
 *  呼叫状态的回调
 *
 *  @param remoteInfo   呼叫信息 （number:呼叫号码 remoteName：呼叫的名称 ）
 *  @param callState    呼叫状态
 *  @param reason       异常状态原因
 */
- (void)xyLinkSDKOnCallStateChangeWithInfo:(NSDictionary *)remoteInfo
                                     state:(XYLinkCallState)callState
                                    reason:(NSString *)reason

/*
 *  customLayout 自定义布局
 *
 *  @param info 布局信息 bForceRequest 是否强制刷新
 *  备注：使用customLayout设置自己需要的布局信息后，需要在回调方法xyLinkSDKOnVideoStreamChanged
    中获取最新的视频流信息，刷新布局。
 */
- (void)customLayout:(XYLinkSDKCustomLayoutInfo *)info forceRequest:(BOOL)bForceRequest

/*
 *  Roster发生改变的回调
 *
 *  @param rosters   与会者信息
 */
- (void)xyLinkSDKOnRosterChanged:(XYSDKRosterInfo *)rosters

/*
 *  通话视频信息流改变回调
 *
 *  @param videos 当前通话视频信息，与会人Stream信息数组(包含streamID和其他stream信息)
 */
- (void)xyLinkSDKOnVideoStreamChanged:(NSArray *)videos

/*
 *  subscribeRoster 订阅ROSTER【与会者】信息。
 *
 *  @param deviceList 设备id数组
 *  备注：订阅设备的与会者信息会在xyLinkSDKOnRosterChanged回调中优先返回
 */
- (void)subscribeRoster:(NSArray *)deviceList

/*
 *  Roster发生改变的回调
 *
 *  @param rosters   与会者信息
 */
- (void)xyLinkSDKOnRosterChanged:(XYSDKRosterInfo *)rosters

/*
 *  requestRoster 请求ROSTER【与会者】信息。
 *
 *  @param startIndex 设备id数组
 *  @param length 设备id数组
 *
 *  备注：start + length请勿超过最大参会人数（XYSDKRosterInfo的participantsNum字段值）；
 *  通过requestRoster请求的参会者信息字段isRequested为YES
*/
- (void)requestRoster:(NSUInteger)startIndex length:(NSUInteger)length

/*
 *  Roster发生改变的回调
 *
 *  @param rosters   与会者信息
 */
- (void)xyLinkSDKOnRosterChanged:(XYSDKRosterInfo *)rosters

/*
 *  麦克风是否静音
 *
 *  @return  麦克风是否静
 */
- (BOOL)micIsMuted

/*
 *  摄像头是否开启
 *
 *  @return BOOL 摄像头是否打开
 */
- (BOOL)videoIsMuted

/*
 *  扬声器状态
 *
 *  @return true表示扬声器已静音
 */
- (BOOL)speakerIsMuted

/*
 *  设置扬声器音量
 *
 *  @param volume 音量值，为0～1的浮点数
 */
- (void)setSpeakerVolume:(float)volume

/*
 * 关闭或者打开扬声器
 *
 *  @param mute true表示关闭
 */
- (void)enableSpeaker:(BOOL)mute

/*
 *  扬声器音量
 *
 *  @return 音量值，值为0～1的浮点数
 */
- (float)speakerVolume

/*
 *  开启或关闭摄像头
 *
 *  @param enable    false表示关闭摄像头，true表示打开摄像头
 */
- (void)enableVideo:(BOOL)enable

/*
 *  切换麦克风状态
 *
 *  @param notifyRemote 是否通知远端
 *  备注：切换麦克风状态，SDK内部会根据麦克风的当前状态自动关闭或者打开麦克风
 */
- (void)changeMicState:(BOOL)notifyRemote

/*
 *  获取频设备列表
 *
 *  @param mediaType 媒体类型
 *  @return array 设备列表数组，数组的元素是XYLinkSDKDevice类型
 */
- (NSArray *)getDeviceList:(XYLinkSDKMediaType)mediaType

/*
 *  设备插拔回调
 *
 *  @param mediaType 被插拔的媒体类型
 *  备注： app在收到这个回调时，可以调用XYLinkDemo.getDeviceList获取最新的设备列表，
    然后通过XYLinkDemo.chooseDevice设置自己选择的设备。
 */
- (void)xyLinkSDKOnDeviceListChange:(XYLinkSDKMediaType)mediaType

/*
 *  设置选择的音视频设备
 *
 *  @param deviceInfo 设备信息
 *  @param mediaType 媒体类型
 */
- (void)chooseDevice:(XYLinkSDKDevice *)deviceInfo
           mediaType:(XYLinkSDKMediaType)mediaType
               block:(sdkSelectDeviceBlock)completeBlock

/*
 *  获取当前使用的设备
 *
 *  @param mediaType 媒体类型
 *  @param input 视频传false，音频输入传true，音频输出传false
 *  @return 当前使用的设备
 */
- (XYLinkSDKDevice *)getCurrentUsedDevice:(XYLinkSDKMediaType)mediaType bInput:(BOOL)input

/*
 *  获取系统默认使用的设备
 *
 *  @param mediaType 媒体类型
 *  @param input 视频传false，音频输入传true，音频输出传false
 *  @return 系统默认使用的设备
 */
- (XYLinkSDKDevice *)getSystemDefaultUsedDevice:(XYLinkSDKMediaType)mediaType bInput:(BOOL)input

/*
 *  开始输入音频测试
 *
 */
- (void)startInputAudioTest

/*
 *  停止输入音频测试
 *
 */
- (void )stopInputAudioTest

/*
 *  获取输出音频音量
 *
 *  @return int 音量值，范围（-65～80）
 */
- (int)getOutputAudioVolume

/*
 *  获取输入音频音量
 *
 *  @return int 音量值，范围（-65～80）
 */
- (int)getInputAudioVolume

/*
 *  播放本地mp3
 *
 *  @param filepath mp3文件路径
 *  @param repeat 是否重复播放
 */
- (void)playLocalMp3:(NSString *)filepath repeat:(BOOL)repeat

/*
   播放本地mp3音频完成
 */
- (void)xyLinkSDKPlayLocalMp3Finished

/*
  停止播放本地mp3
 */
- (void)stopPlayLocalMp3

/*
 *  是否需要音视频权限
 *
 *  @param mediaType 媒体类型
 *  @BOOL  true需要权限，false不需要权限
 */
- (BOOL)needOpenAuthorization:(XYLinkSDKMediaType)mediaType

/*
 *  指定不自动切换的音频输出设备
 *
 *  @param devices 需要过滤的设备名称
 */
- (void)filterAudioOutputDevices:(NSArray *)devices

/*
 旁路音频开关（入会之前设置）

 @param enable 是否
 */
- (void)setMicDataByAEReadyEnabled:(BOOL)enable

/*
 旁路音频数据回调

 @param size 数据大小
 @param data 音频数据
 */
- (void)xyLinkSDKDidMicDataByAEReady:(int)size data:(void *)data

/*
 *   音频诊断
 *
 *   注意：请慎用；
 *        应提醒用户调大扬声器，以方便麦克风接收诊断音频；
 *        请勿在诊断过程中切换音频设备；
 *       会根据诊断结果，自动修改音频配置；
 *        只能在会外使用，会中调用无效；
 *        切换音频设备会使已有诊断配置无效。
 */
- (void)diagnoseAudio

/*
 音频诊断回调

 @param result 需要调整的参数（已经自动匹配，可忽略）
 */
- (void)xyLinkSDKDidDiagnoseAudio:(NSString *)result

/*
 *   音频诊断强制配置
 *
 *   @param config 配置JSON字符串，可以从音频诊断回调处获取，传nil使用默认配置
 *
 *   注意：请慎用；
 *        只能在会外使用，会中调用无效；
 *        切换音频设备会使已有诊断配置无效。
 */
- (void)setDiagnoseAudioConfig:(NSString *)config

/*
 *   音频配置
 *
 *   @param jsonString 配置JSON字符串
 *
 *   注意：可以配合 diagnoseAudio 使用，添加辅助参数，但是需要在诊断完成后（或者 setDiagnoseAudioConfig: 方法后）再调用
 */
- (void)setNConsoleAudioConfig:(NSString *)jsonString

/*
   举手发言
 */
- (void)handsUp

/*
   取消发言
 */
- (void)cancelHandsUp

/*
   会控取消举手发言
 */
- (void)xyLinkSDKOnCancelHandsUpByConfMgmt

/*
   发言完毕
 */
- (void)handsUpEnd

/*
 修改云会议室密码

 @param number 云会议室号
 @param password 新密码
 */
- (void)updateCloudMeetingRoom:(NSString *)number
                      password:(NSString *)password

/*
 *  更新会议室密码完成 
 *
 * @param success 更新是否成功成功
 * @param reason 失败原因，成功为nil
 */
- (void)xyLinkSDKDidUpdateMeetingRoomPassword:(BOOL)success failReason:(NSDictionary *)reason

/*
 *  获取个人云会议室号码
 *
 *  @return NSString 个人云会议室号
 */
- (NSString *)getMyCloudMeetingNum

/*
   开始共享白板
 */
- (void)startWhiteboard

/*
   停止共享白板
 */
- (void)stWhiteboard

/*
 白板功能回调
 */
- (void)whiteboardStateChanged:(WhiteboardState)remoteState reason:(NSString *)reason;
- (void)whiteboardDidReceieved:(id)remoteMessage type:(WhiteboardOperation)type

/*
 *  发送白板消息
 *  @param msg 具体的消息，某些操作不用携带消息
 *  @param type 消息对应的操作类型
 */
- (void)sendWhiteboardMsg:(id)msg type:(WhiteboardOperation)type

/*
   开始桌面共享
 */
- (void)startContentSharing

/*
 *  双流状态改变回调
 *
 *  @param state 双流状态
 */
- (void)xyLinkSDKOnDualStreamStateChanged:(XYLinkSDKDualStreamState)state

/*
   停止桌面共享
 */
- (void)stopContentSharing

/*
 *  双流状态改变回调
 *
 *  @param state 双流状态
 */
- (void)xyLinkSDKOnDualStreamStateChanged:(XYLinkSDKDualStreamState)state

/**
 *  获取 AI 模块是否可用
 *  @param module 模块类型
 *
 *  @return 是否可用
 *
 *  请在登录成功后使用该接口
 */
- (BOOL)canUseAI:(XYAIModule)module;

- (void)xyLinkSDKDidCheckAI:(XYAIModule)module code:(XYAIErrorCode)code;

/**
 *  设置虚拟背景
 *  @param mode 模式
 *  @param image 图片，只在 mode 为 VirtualBgMode_Image 时生效
 *
 *  mode 为 VirtualBgMode_BgImage 且 path 为 nil，自动使用 VirtualBgMode_None
 */
- (void)setVirtualBg:(XYVirtualBgMode)mode image:(NSImage *)image;

/**
 *  设置滤镜样式
 *  @param style 样式
 */
- (void)setVideoFilterStyle:(XYFilterStyle)style;

/**
 *  设置滤镜等级
 *  @param level 等级 0 - 100
 */
- (void)setVideoFilterLevel:(int)level;

/**
 *  设置美颜
 *  @param style 样式
 *  @param level 等级 0 - 100
 */
- (void)setVideoBeauty:(XYBeautyStyle)style level:(int)level;

/*
 *  当前服务器地址
 *
 *  @return 当前服务器地址
 *  备注：地址已分割为： 服务器域名，http请求端口号， https请求端口号
 */
- (NSArray *)currentServerAddress

/*
 *  默认服务器地址
 *
 *  @return 默认服务器地址
 *  备注：地址已分割为： 服务器域名，http请求端口号， https请求端口号
 */
- (NSArray *)defaultServerAddress

/*
 *  修改服务器地址
 *
 *  @param address 服务器域名
 *  @param httpPort http端口号
 *  @param httpsPort https端口号
 */
- (void)modifyServerAddress:(NSString *)address
                   httpPort:(NSString *)httpPort
                  httpsPort:(NSString *)httpsPort

/*
 *  服务器地址改变回调
 *
 *  @param restServer 服务器域名
 *  @param httpPort http端口号
 *  @param httpsPort https端口号
 */
- (void)xyLinkSDKOnServerAddressChanged:(NSString *)restServer
                               httpPort:(NSString *)httpPort
                              httpsPort:(NSString *)httpsPort

/*
 对URL进行签名

 @param url        待签名的URL
 @param methodType HTTP请求方法
 @param entity     HTTP请求正文的负载
 @param token      签名需要的密钥

 @return 签名字符串
 */
+ (NSString *)signUrl:(NSString *)url
           methodType:(NSString *)methodType
               entity:(void *)entity
                token:(NSString *)token

/*
 *  上传日志
 *  @param title 日志标题
 *
 */
- (void)feedback:(NSString *)title

/*
 *  上传反馈信息完成
 *
 * @param success 是否上传成功
 */
- (void)xyLinkSDKOnSendFeedback:(BOOL)success

/*
 *  获取版本号
 *
 *  @return  版本号字符串
 */
+ (NSString *)version

/*
 *  通话中的会议号
 */
- (NSString *)currentMeetingNumber

/*
 *  通话中的会议名称
 */
- (NSString *)currentMeetingName

/*
 *  修改ExtID
 *
 *  @param extID 新ExtID，传空则不变
 */
- (void)modifyExtID:(NSString *)extID

/*
 *  释放底层资源
 *  备注：请在应用退出前调用
 */
- (void)sdkReleaseInstance

 /*
  *  获取统计信息（用户版）
  *
  *  @return NSString 统计信息
  */
- (NSString *)getGeneralStatistics

//开发信息统计模型，用于调试用
@interface SDKGeneralStatistics : NSObject
@property (nonatomic, copy) NSString *dbaStatistics;
@property (nonatomic, copy) NSString *layoutStatistics;
@end

/*
 * 基本统计信息（开发版）
 *
 *  @return SDKGeneralStatistics 基本统计信息
 */
- (SDKGeneralStatistics *)getStatistics

/*
 *  视频发送信息（开发版）
 *
 *  @return NSString 统计信息
 */
- (NSString *)getVideoTxStatistics

/*
 *  视频接收信息(开发版)
 *
 *  @return NSString 统计信息
 */
- (NSString *)getVideoRxStatistics

/*
 *  音频发送信息（开发版）
 *
 *  @return NSString 统计信息
 */
- (NSString *)getAudioTxStatistics

/*
 *  音频接收信息（开发版）
 *
 *  @return NSString 统计信息
 */
- (NSString *)getAudioRxStatistics

/*
 *  其他信息（开发版）
 *
 *  @return NSString 统计信息
 */
- (NSString *)getOtherStatistics

/*
  *  获取音视频信息的过滤标记（开发版）
  *
  *  @param keyStr  过滤标记对应的key值
  *  @return  过滤标记
  */
- (uint32_t)getDumpFlagValue:(NSString *)keyStr

/*
 *  获取音视频信息的一些过滤条件字典（开发版）
 *
 *  @return  过滤条件字典
 */
- (NSDictionary *)getDumpStateDic

/*
 *  设音视频信息的一些过滤条件字典（开发版）
 *
 *  @param  stateDic 过滤条件字典
 */
- (void)setDumpStateDic:(NSDictionary *)stateDic

/*
 *  设音视频信息的一些过滤标记（开发版）
 *
 *  @param  dumpMask 过滤标记
 */
- (void)setMediaDumpMask:(uint32_t)dumpMask

/*
 *  保存dump信息
 *
 *
- (void)saveDump

/*  网络状态等级变化回调
 *
 *  @param level 网络状态等级（共分为4个等级-> 1 2 3 4，由低到高分别为差，中，良，优）
 */
- (void)xyLinkSDKOnNetworkIndicatorLevelChanged:(int)level

/*
 *  speakers发生改变的回调
 *
 *  @param speakers  发言人列表
 */
- (void)xyLinkSDKOnSpeakersChanged:(NSArray<XYSDKSpeakerInfo *> *)speakers

//会控消息模型
@interface SDKConfMsgInfo : NSObject
@property (nonatomic, assign) BOOL isChairmanMode;      // 主会场模式
@property (nonatomic, assign) BOOL muteIsDisabled;      // 会控是否强制静音
@property (nonatomic, assign) BOOL contentIsDisabled;   // 桌面共享是否禁用
@property (nonatomic, copy) NSString *operationStr;     // 操作
@property (nonatomic, copy) NSString *chairmanUri;      // 主会场的url
@end

/*
 *  会控消息的回调
 *
 *  @param confInfo 会控消息
 */
- (void)xyLinkSDKOnConfMgmtStateChanged:(SDKConfMsgInfo *)confInfo

/*
 *  会控录制状态回调
 *
 *  @param bStart 是否已经开始录制
 */
- (void)xyLinkSDKOnRecordStatusChanged:(BOOL)bStart

/*
 *  与会者被暂时隔离在会议之外
 *
 *  @param bHold ture表示被hold
 */
- (void)xyLinkSDKOnHoldMediaStatusChangedByConfMgmt:(BOOL)bHold

@interface XYCaptionInfo : NSObject
@property (nonatomic, assign) BOOL display;                         // 字幕是否展示
@property (nonatomic, assign) CGFloat bgAlpha;                      // 字幕背景透明度 0 - 1
@property (nonatomic, assign) XYCaptionLocation location;           // 字幕显示位置
@property (nonatomic, assign) XYCaptionFontSize fontSize;           // 字幕字体大小
@property (nonatomic, assign) XYCaptionScrollLevel scrollSpeedLevel;// 字幕滚动速度
@property (nonatomic, copy) NSString *content;                      // 字幕内容
@property (nonatomic, copy) NSString *bgColor;                      // 字幕背景颜色
@property (nonatomic, copy) NSString *fontColor;                    // 字幕字体颜色 16进制
@end

/*
 *  会控字幕
 *
 *  @param info 字幕显示信息
*/
- (void)xyLinkSDKOnRecieveCaptionDisplay:(XYCaptionInfo *)info

/*
  获取线路
 */
- (void)fetchSitePaths

- (void)xyLinkSDKDidFetchSitePaths:(XYSitePathResult *)result error:(NSError *)error

/*
 *  选择线路
 *  @param path 线路
 */
- (void)saveSitePath:(XYSitePath *)path

- (void)xyLinkSDKDidSaveSitePath:(NSString *)sitePathID error:(NSError *)error

/*
  删除当前选择的线路
 */
- (void)deleteSitePath

- (void)xyLinkSDKDidDeleteSitePath:(NSError *)error

/*
  开始网络测试
 */
- (void)startNetworkTest

/*
 线路测试回调
 */
- (void)xyLinkSDKDidTestNetwork:(XYNetTestResult *)result code:(XYNetworkTestCode)code

/*
  停止网络测试
 */
- (void)stopNetworkTest

/*
 啸叫检测回调
 
 @param detected 是否探测到啸叫
*/
- (void)xyLinkSDKOnHowlingDetected:(BOOL)detected

/*
 出入会通知回调
 
 @param notice 参会者信息
 */
- (void)xyLinkSDKDidInOutNotice:(NSArray<XYLinkSDKInOutNotice *> *)notice

/// 是否支持同传字幕
/// return YES 支持， NO 不支持
- (BOOL)isSupportAiCaption;

/// 设置同传字幕语言
/// @param language 语言，传@"Chinese" 或者 @"English"
- (void)setSubtitleLanguage:(NSString *)language;

/// 刷新access_token
/// @param refreshToken  从登录成功回调中返回
/// @param completion 刷新后的数据保存在user中
- (void)refreshToken:(NSString *)refreshToken
          completion:(void(^)(XYUser *user))completion;

/// token失效回调，包括token失效和refreshToken失效
/// - Parameter error: token失效的对应的error信息
- (void)xyLinkSDKOnAccountTokenInvalid:(NSString *)error;