开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. iOS SDK
  • DEMO示例
  • JS SDK
    • 产品介绍
    • 快速接入
    • SDK 对接示例
    • 观看直播
    • 暖场视频
    • 房间消息说明
    • 互动连麦
    • 文档白板
    • 全局事件
    • 全局错误码
    • 版本更新记录
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-聊天
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展功能
      • 资料下载
      • 观看限制验证
      • 观看协议
      • 回放章节
  • 点播SDK
    • 点播上传SDK
    • 更新记录
  • iOS SDK
    • 整体介绍
    • 快速接入
    • SDK 登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • v2.3.0 到 v2.4.0 升级说明
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v6.3.0
      • v6.2.1
      • v3.2.0 到 v4.0.1
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • 6.5.0
      • v5.0.x 到 v6.0.0
      • v6.4.0
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 信息采集说明
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 观看回放
      • 观看回放/点播
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 更新记录
      • 更新记录
    • 版本更新说明
      • v6.4.0
      • v6.3.0
      • v6.2.3
      • v6.2.1
      • v6.2.0
      • v6.1.0
      • v6.0.0
      • v5.0.0
      • v4.1.0
      • v4.0.0
      • v3.3.0
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. iOS SDK

SDK 登录

申请帐号

注意事项#

1.
sdk 6.0 之后 新增三方 id 登录,不再支持游客登录,必需登录成功之后才可以进入活动。
2.
不支持在直播间切换登录用户,如果更改用户需要重新调用登录和加入直播间,否则用户切换会失败。
3.
退出登录之后可以直接返回登录页,退出登录接口调用就会清理 sdk 登录信息

关键方法#

方法方法描述
loginWithAccount账号密码登录
loginWithThirdUserId三方 ID 登录
logout退出登录
isLoggedIn获取当前登录状态
vHallApiTokenDidErrortoken 错误回调

账号密码登录#

方法 API
+ (void)loginWithAccount:(NSString *)aAccount
                password:(NSString *)aPassword
                 success:(void (^)(void))aSuccessBlock
                 failure:(void (^)(NSError *error))aFailureBlock;
方法入参
参数名称是否必须示例备注
aAccount是v123123123123账号 需服务器调用微吼注册 API 注册该用户账号密码
aPassword是123456密码
aSuccessBlock请求成功回调
aFailureBlock请求失败回调
方法示例
[VHallApi loginWithAccount:@"v123123123123" password:@"123456" success:^{

} failure:^(NSError * error) {

}];

三方 ID 登录#

方法 API
+ (void)loginWithThirdUserId:(NSString *)thirdUserId
                    nickName:(NSString *)nickName
                      avatar:(NSString *)avatar
                     success:(void (^)(void))successBlock
                     failure:(void (^)(NSError *error))failureBlock;
方法入参
参数名称是否必须示例备注
thirdUserId是123456789三方 id
nickName否张三昵称
avatar否https://www.img.com/img/123.png头像地址
aSuccessBlock请求成功回调
aFailureBlock请求失败回调
方法示例
[VHallApi loginWithThirdUserId:@"123456789"
                       nickName:@"张三"
                         avatar:@"https://www.img.com/img/123.png"
                        success:^{

} failure:^(NSError *error) {

}];

退出登录#

方法 API
+ (void)logout:(void (^)(void))aSuccessBlock
       failure:(void (^)(NSError *error))aFailureBlock;
方法入参
参数名称是否必须示例备注
aSuccessBlock请求成功回调
aFailureBlock请求失败回调
方法示例
[VHallApi logout:^{

} failure:^(NSError *error) {

}]

获取当前登录状态#

方法 API
+ (BOOL)isLoggedIn;
方法入参
参数名称返回值
isLoggedInYES:已登录 NO:未登录
方法示例
NSLog(@"%@",[VHallApi isLoggedIn] ? @"已登录" : @"未登录");

token 错误回调#

token 错误回调,监听到此回调后需重新登录
- (void)vHallApiTokenDidError:(NSError *)error;

错误码说明#

方法示例
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    // 监听delegate
    [VHallApi registerDelegate:self];
}
#pragma mark - VHallApiDelegate
- (void)vHallApiTokenDidError:(NSError *)error {
    NSLog(@"%@",[VHallApi errorMsgWithCode:error.code]);
}
修改于 2025-08-05 10:49:29
上一页
快速接入
下一页
暖场视频
Built with