快速开始

pod 'JuphoonCloudSDK_iOS', '2.0'

platform :ios, '9.0'
#use_frameworks!
target 'Your App' do
pod 'JuphoonCloudSDK_iOS', '2.0'
end

/// sdk信息存储目录
@property (nonatomic, copy) NSString* __nonnull sdkInfoDir;

/// sdk日志目录
@property (nonatomic, copy) NSString* __nonnull sdkLogDir;

/// sdk日志等级 JCLogLevel
@property (nonatomic) JCLogLevel sdkLogLevel;

/**
 * @brief 创建 JCClient 实例
 * @param appKey 用户从 Juphoon Cloud 平台上申请的 AppKey 字符串
 * @param callback 回调接口，用于接收 JCClient 相关通知
 * @param createParam 创建参数，nil 则按默认值创建
 * @return JCClient 对象
 */
+(JCClient* __nullable)create:(NSString* __nonnull)appKey callback:(id<JCClientCallback> __nonnull)callback creatParam:(JCClientCreateParam* __nullable)createParam;

// 初始化，因为这些模块实例将被频繁使用，建议声明在单例中
JCClientCreateParam *param = [[JCClientCreateParam alloc] init];
param.sdkLogLevel = JCLogLevelInfo;
param.sdkInfoDir = @"SDK 信息存放路径";
param.sdkLogDir = @"日志存放路径";
JCClient *client = [JCClient create:@"your appkey" callback:self creatParam:param];

JCClientLoginParam* loginParam = [[JCClientLoginParam alloc] init];
//默认国内环境 http:cn.router.justalkcloud.com:8080
loginParam.serverAddress = @"服务器地址";
//如果使用代理服务器登录
loginParam.httpsProxy = @"代理服务器地址";

JCManager.shared.client.displayName = @"小张";

/**
 * @brief 登陆 Juphoon Cloud 平台，只有登陆成功后才能进行平台上的各种业务
 * 服务器分为鉴权模式和非鉴权模式
 *
 *     - 鉴权模式: 服务器会检查用户名和密码
 *
 *     - 免鉴权模式: 只要用户保证用户标识唯一即可, 服务器不校验
 *
 * 登陆结果通过 JCClientCallback 通知
 *
 * @param userId 用户名
 * @param password 密码，免鉴权模式密码可以随意输入，但不能为空
 * @param loginParam 登录参数，nil则按照默认值登录
 * @return 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知
 * @warning 目前只支持免鉴权模式，免鉴权模式下当账号不存在时会自动去创建该账号
 * @warning 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
 */
-(bool)login:(NSString* __nonnull)userId password:(NSString* __nonnull)password loginParam:(JCClientLoginParam* __nullable)loginParam;

JCClientLoginParam* loginParam = [[JCClientLoginParam alloc] init];
//默认国内环境 http:cn.router.justalkcloud.com:8080
loginParam.serverAddress = @"服务器地址";
[JCManager.shared.client login:@"账号" password:@"123" loginParam:loginParam];

/**
 *  @brief 登录状态变化通知
 *  @param state    当前状态值
 *  @param oldState 之前状态值
 */
-(void)onClientStateChange:(JCClientState)state oldState:(JCClientState)oldState;

// 未初始化
JCClientStateNotInit,
// 未登录
JCClientStateIdle,
// 登录中
JCClientStateLogining,
// 登录成功
JCClientStateLogined,
// 登出中
JCClientStateLogouting,

-(void)onClientStateChange:(JCClientState)state oldState:(JCClientState)oldState
{
    if (state == JCClientStateIdle) { // 未登录
       ...
    } else if (state == JCClientStateLogining) { // 登录中
       ...
    } else if (state == JCClientStateLogined) {  // 登录成功
       ...
    } else if (state == JCClientStateLogouting) {  // 登出中
       ...
    }
}

/**
 *  @brief 登陆结果回调
 *  @param result true 表示登陆成功，false 表示登陆失败
 *  @param reason 当 result 为 false 时该值有效
 *  @see JCClientReason
 */
-(void)onLogin:(bool)result reason:(JCClientReason)reason;

/// 正常
JCClientReasonNone,
/// sdk 未初始化
JCClientReasonSDKNotInit,
/// 无效的参数
JCClientReasonInvalidParam,
/// 函数调用失败
JCClientReasonCallFunctionError,
/// 当前状态无法再次登录
JCClientReasonStateCannotLogin,
/// 超时
JCClientReasonTimeOut,
/// 网络异常
JCClientReasonNetWork,
/// appkey 错误
JCClientReasonAppKey,
/// 账号密码错误
JCClientReasonAuth,
/// 无该用户
JCClientReasonNoUser,
/// 被强制登出
JCClientReasonServerLogout,
/// 其他错误
JCClientReasonOther,

/**
 *  登出 Juphoon Cloud 平台，登出后不能进行平台上的各种业务
 *  @return 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知
 */
-(bool)logout;

/**
 *  @brief 登出回调
 *  @param reason 登出原因
 *  @see JCClientReason
 */
-(void)onLogout:(JCClientReason)reason;

/**
 *  @brief 创建 JCMediaDevice 对象
 *  @param client JCClient 对象
 *  @param callback JCMediaDeviceCallback 回调接口，用于接收 JCMediaDevice 相关通知
 *  @return 返回 JCMediaDevice 对象
 */
+(JCMediaDevice* __nullable)create:(JCClient* __nonnull)client callback:(id<JCMediaDeviceCallback> __nonnull)callback;

/**
 *  @brief 创建 JCMediaChannel 对象
 *  @param client       JCClient 对象
 *  @param mediaDevice  JCMediaDevice 对象
 *  @param callback     JCMediaChannelCallback 回调接口，用于接收 JCMediaChannel 相关通知
 *  @return             返回 JCMediaChannel 对象
 */
+(JCMediaChannel* __nullable)create:(JCClient* __nonnull)client mediaDevice:(JCMediaDevice* __nonnull)mediaDevice callback:(id<JCMediaChannelCallback> __nonnull)callback;

// 初始化各模块，因为这些模块实例将被频繁使用，建议声明在单例中
JCMediaDevice *mediaDevice = [JCMediaDevice create:client callback:self];
JCMediaChannel *mediaChannel = [JCMediaChannel create:client mediaDevice:mediaDevice callback:self];

/// 自定义角色0
JCMediaChannelCustomRole0 = 1<<12,
/// 自定义角色1
JCMediaChannelCustomRole1 = 1<<13,
/// 自定义角色2
JCMediaChannelCustomRole2 = 1<<14,
/// 自定义角色3
JCMediaChannelCustomRole3 = 1<<15,

//自定义主播角色
JCMediaChannelCustomRole ROLE_BROASCASTER = JCMediaChannelCustomRole0;
//自定义观众角色
JCMediaChannelCustomRole ROLE_AUDIENCE = JCMediaChannelCustomRole1;

/**
 * @brief 设置自定义角色
 *
 * @param customRole 自定义角色, 参看 JCMediaChannelCustomRole
 * @param participant 成员，nil 则默认设置自己
 */
-(void)setCustomRole:(JCMediaChannelCustomRole)customRole participant:(JCMediaChannelParticipant * __nullable)participant;

/**
 * @brief 获得自定义角色
 *
 * @return
 */
-(JCMediaChannelCustomRole)getCustomRole;

/**
 *  @brief 开启关闭发送本地音频流
 *      1.在频道中将会与服务器进行交互，服务器会更新状态并同步给其他用户
 *      2.未在频道中则标记是否上传音频流，在join时生效
 *      3.建议每次join前设置
 *  @param enable 是否开启本地音频流
 *  @return 返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)enableUploadAudioStream:(bool)enable;

/**
 *  @brief 开启关闭发送本地视频流
 *      1.在频道中将会与服务器进行交互，服务器会更新状态并同步给其他用户
 *      2.未在频道中则标记是否上传音频流，在join时生效
 *      3.建议每次join前设置
 *  @param enable    是否开启本地视频流
 *  @return          返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)enableUploadVideoStream:(bool)enable;

/**
 * 加入频道
 *  @param channelIdOrUri    媒体频道标识或者频道Uri，当 param 中 uriMode 设置为 true 时表示频道 Uri，其他表示频道标识
 *  @param joinParam    参数，没有则填null
 *  @return             返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)join:(NSString* __nonnull)channelIdOrUri joinParam:(JCMediaChannelJoinParam* __nullable)joinParam;

/// 会议最大人数
@property (nonatomic) int capacity;
/// 推流参数
@property (nonatomic) NSString* __nullable cdn;
/// 录制参数
@property (nonatomic) JCMediaChannelRecordParam * __nullable record;
/// 密码
@property (nonatomic) NSString* __nonnull password;
/// 平滑模式
@property (nonatomic) bool smooth;
/// 会议最大分辨率 JCMediaChannelMaxResolution
@property (nonatomic) JCMediaChannelMaxResolution maxResolution;
/// uri 模式, join 函数的参数为会议 uri
@property (nonatomic) bool uriMode;
/// 心跳间隔
@property (nonatomic) int heartbeatTime;
/// 心跳超时
@property (nonatomic) int heartbeatTimeout;
/// 方形画面
@property (nonatomic) bool square;
/// 帧率 1-30, 默认 24
@property (nonatomic) int framerate;
/// 最大码率
//@property (nonatomic) int maxBitrate;
/// 自定义属性
@property (nonatomic) NSString* __nullable customProperty;

//自定义主播角色
JCMediaChannelCustomRole ROLE_BROASCASTER = JCMediaChannelCustomRole0;
//自定义观众角色
JCMediaChannelCustomRole ROLE_AUDIENCE = JCMediaChannelCustomRole1;
//设置自己的角色
[mediaChannel setCustomRole:ROLE_BROASCASTER participant:nil];
-(void)joinRoom:(JCMediaChannelCustomRole)customRole {
    //主播可以上传本地音频流，语音直播时，不需要上传本地视频流
    [mediaChannel enableUploadVideoStream:false];
    [mediaChannel enableUploadAudioStream:customRole == ROLE_BROASCASTER];
    [mediaChannel enableAudioOutput:true];
    // 设置频道参数
    JCMediaChannelJoinParam *joinParam = [[JCMediaChannelJoinParam alloc] init];
    if (needsPassword) {//需要密码
       joinParam.password = @"joinPassword";
    }
    //加入直播
    [mediaChannel join:"channelId" joinParam:joinParam];
}

/**
 *  @brief             加入频道结果回调
 *  @param result      true 表示成功，false 表示失败
 *  @param reason      加入失败原因，当 result 为 false 时该值有效
 *  @param channelId   媒体频道标识符
 *  @see JCMediaChannelReason
 */
-(void)onJoin:(bool)result reason:(JCMediaChannelReason)reason channelId:(NSString*)channelId;

// 加入频道结果回调
-(void)onJoin:(bool)result reason:(JCMediaChannelReason)reason channelId:(NSString*)channelId
{
    if (result) {
      // 加入成功
    } else {
      // 加入失败
    }
}

/**
 *  @brief 新成员加入回调
 *  @param participant 成员对象
 */
-(void)onParticipantJoin:(JCMediaChannelParticipant*)participant;

/**
 *  离开媒体频道，当前只支持同时加入一个媒体通道
 *  @return  返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)leave;

// 离开频道
[mediaChannel leave];

/**
 *  @brief             离开频道结果回调
 *  @param reason      离开原因
 *  @param channelId   频道标识符
 *  @see JCMediaChannelReason
 */
-(void)onLeave:(JCMediaChannelReason)reason channelId:(NSString*)channelId;

// 离开频道回调
-(void)onLeave:(JCMediaChannelReason)reason channelId:(NSString*)channelId {
    // 界面处理
}

/**
 *  @brief 关闭频道，所有成员都将被退出
 *  @return 返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)stop;

// 结束频道
[mediaChannel stop];

/**
 * brief 解散频道结果回调
 * @param result    true 表示成功，false 表示失败
 * @param reason    解散失败原因，当 result 为 false 时该值有效
 */
-(void)onStop:(bool)result reason:(JCMediaChannelReason)reason;

-(void)onStop:(bool)result reason:(JCMediaChannelReason)reason
{
    // 界面处理
}