• 
• 开发者中心
• >
• 云游戏
• >
• SDK参考手册
• >
• iOS
• >
• v5.38

1 iOS SDK 参考手册

1.1 HMCloudPlayer 类

1.2 config

配置云游戏连接信息；该方法在创建单例后第一时间调用

/**
 @param info 连接信息 AUTH / Countly/ Link
 @return 是否成功 //参数类型非法，或者已经请求过SAAS地址，均返回失败。
 */
- (BOOL) config:(NSDictionary *)info;

Info 字典中，有效 Key 含义说明如下：

1.3 registCloudPlayer

海马云进行注册

/**
 @param accessKeyID 接入商ID
 @param channelId 接入商渠道ID
 @param launchOptions AppLauchuOptions
 @return 是否正常进行注册，最终注册结果异步返回
 */
- (BOOL) registCloudPlayer:(NSString *)accessKeyID 
                 channelId:(NSString *)channelId 
                   options:(NSDictionary *)launchOptions;

1.4 prepare

申请游戏

/**
 @param options 游戏参数
 @return 云游戏ViewController
 */
- (UIViewController *) prepare:(NSDictionary *)options;

options 字典中，有效 Key 含义说明如下：

特殊类型定义如下：

/**
 HMIntentExtraData对象赋值
 */
HMIntentExtraData *intentExtraData = [[HMIntentExtraData alloc] init];
NSDictionary *dic = @{@"Viable":@(1), @"Enable":@(0)};
intentExtraData.booleanExtra = dic;
[options setObject:intentExtraData forKey:CloudGameOptionKeyIntentExtraData];

1.5 pause

暂停游戏

- (void) pause;

1.6 stop

停止游戏

- (void) stop;

1.7 getVideoLatency

获取视频帧网络延迟

/**
 @return 视频延迟，单位ms
 */
- (NSInteger) getVideoLatency;

1.8 setBackgroundImage

设置背景图

- (void) setBackgroundImage:(UIImage *)bgImage;

1.9 sendMessage

发送消息给云游戏的接口

/**
 @param message 消息内容
 */
- (BOOL) sendMessage:(NSString *)message;

1.10 startNetMonitor

开始网络状态监控

/**
 @param block 回调通知
 */
- (void) startNetMonitor:(void (^)(CloudCorePlayerNetStatus status))block;

1.11 stopNetMonitor

停止网络状态监控

- (void) stopNetMonitor;

1.12 getLastUserOperationTimestamp

获取用户最后一次操作时间

/**
@return 用户最后操作时间戳，单位ms
*/
- (long long) getLastUserOperationTimestamp;

1.13 speedTest

IDC节点测速，支持 IPV6

/**

 @param seconds 最大测速时长，单位：秒
 @param success 测速成功回调
 @param fail 测速失败回调
 @return 是否开始测速
 */
- (BOOL) speedTest:(NSInteger)seconds 
           success:(void (^)(int rst))success 
              fail:(void (^)(NSString *errorCode))fail;

/**

@param seconds 最大测速时长，单位：秒
@param ipv6Supported 是否支持IPV6，即：是否需要查询IPV4地址
@param success 测速成功回调
@param fail 测速失败回调
@return 是否开始测速
*/
- (BOOL) speedTest:(NSInteger)seconds 
     ipv6Supported:(BOOL)ipv6Supported 
           success:(void (^)(int rst))success 
              fail:(void (^)(NSString *errorCode))fail;

1.14 idcQuery

IDC路由查询，是否支持 IPV6

/**
 IDC路由查询

 @param success 查询成功回调
 @param fail 查询失败回调
 @return 是否开始查询
 */
- (BOOL) idcQuery:(void (^)(NSString *url, NSString *ipAddress))success
             fail:(void (^)(NSString *errorCode))fail;

/**
IDC路由查询

@param ipv6Supported 是否支持IPV6，即：是否需要查询IPV4地址
@param success 查询成功回调
@param fail 查询失败回调
@return 是否开始查询
*/
- (BOOL) idcQuery:(BOOL)ipv6Supported 
          success:(void (^)(NSString *url, NSString *ipAddress))success 
             fail:(void (^)(NSString *errorCode))fail;

1.15 play

开始云游戏

- (void) play;

1.16 resume

恢复云游戏

- (void) resume:(NSInteger)playingTime;

1.17 switchResolution

手动切换云游戏清晰度

/**
 @param resolutionId 目标清晰度ID
 */
- (void) switchResolution:(NSInteger)resolutionId;

1.18 confirmQueue

进入排队队列

- (void) confirmQueue;

1.19 sendKeyCommand

发送特定键值指令，更新用户操作时间

/**
 @param cmd 键值
 @return 是否发送
 */
- (BOOL) sendKeyCommand:(HMCloudPlayerKeyCommand)cmd;

/**
发送特定键值指令

@param cmd 键值
@param updateUserOperationTime  是否更新用户操作时间
@return 是否发送
*/
- (BOOL) sendKeyCommand:(HMCloudPlayerKeyCommand)cmd 
updateUserOperationTime:(BOOL)updateUserOperationTime;

1.20 gameArchiveQuery

查询游戏存档进度查询

/**
 @param userId 必填，不能为NULL
 @param userToken 必填，不能为NULL
 @param pkgName 必填，不能为NULL
 @param appChannel 选填，可为NULL
 @param success 查询成功的回调
 @param fail 查询失败的回调
 @return 是否开始查询
 */
- (BOOL) gameArchiveQuery:(NSString *)userId 
                userToken:(NSString *)userToken
                  pkgName:(NSString *)pkgName
               appChannel:(NSString *)appChannel
                  success:(void (^)(BOOL finished))success
                     fail:(void (^)(NSString *errorCode))fail;

1.21 gameArchived

游戏是否有存档查询

/**
 @param userId 必填，不能为NULL
 @param userToken 必填，不能为NULL
 @param pkgName 必填，不能为NULL
 @param appChannel 选填，可为NULL
 @param success 查询成功的回调
 @param fail 查询失败的回调
 @return 是否开始查询
 */
- (BOOL) gameArchived:(NSString *)userId
            userToken:(NSString *)userToken
              pkgName:(NSString *)pkgName
           appChannel:(NSString *)appChannel
              success:(void (^)(BOOL archived))success
                 fail:(void (^)(NSString *errorCode))fail;

1.22 updateGameUID

游戏过程中，更新UID和游戏时长

/**
 @param userId 必填，不能为NULL
 @param userToken 必填，不能为NULL
 @param ctoken 必填，不能为NULL
 @param playingTime 必填，不能小于0，单位: ms
 @param tip 选填
 @param protoData 选填
 @param success 更新成功回调
 @param fail 更新失败回调
 @return 是否开始更新
 */
- (BOOL) updateGameUID:(NSString *)userId
             userToken:(NSString *)userToken
                ctoken:(NSString *)ctoken
       playingTime:(NSInteger)playingTime
                   tip:(NSString *)tip
             protoData:(NSString *)protoData
               success:(void (^)(BOOL successed))success
                  fail:(void (^)(NSString *errorCode))fail;

1.23 gameParamsQuery

查询游戏配置信息（目前版本仅支持清晰度查询）

/**
 @param pkgName 必填，不能为NULL
 @param appChannel 选填，可为NULL
 @param streamingType 必填
 @param success 游戏配置的清晰度列表
 @param fail 查询失败回调
 @return 是否开始查询
 */
- (BOOL) gameParamsQuery:(NSString *)pkgName
              appChannel:(NSString *)appChannel
  streamingType:(CloudCoreStreamingType)streamingType
                 success:(void (^)(NSArray<HMCloudPlayerResolution *> *))success
                    fail:(void (^)(NSString *errorCode))fail;

1.24 setAudioMute

云游戏提供静音接口

/**
 @param mute 静音
 */
- (void) setAudioMute:(BOOL)mute;

1.25 getDelayInfo

获取某一秒延迟检测信息

/**
 @return 包含延迟信息的HMDelayInfoModel
 */
- (HMDelayInfoModel *) getDelayInfo;

1.26 getReservedInstance

查询是否有上次未完成的游戏实例

/**
 @param options 游戏参数  {@"CloudGameOptionKeyUserId":@"...", @"CloudGameOptionKeyUserToken":"...",}
 @param reservedIncetance 查询驻留机回调方法，包含驻留机数组
 */
- (void) getReservedInstance:(NSDictionary *)options 
           ReservedIncetance:(HMReservedIncetanceCallback)reservedIncetance;

1.27 gameReleaseInstanceWithCid

根据cid立即释放实例

/**
 @param cid 必填，不能为NULL
 @param cToken 必填，不能为NULL,并且必须与之前播放的实例传入的cToken一致
 @param userId 必填，不能为NULL
 @param userToken 必填，不能为NULL
 @param pkgName 必填，不能为NULL
 @param appChannel 选填，可为NULL
 @param success 释放成功回调
 @param fail 释放失败回调
 @return 是否开始释放实例
*/
- (BOOL)gameReleaseInstanceWithCid:(NSString *)cid 
                            Ctoken:(NSString *)cToken 
                            UserId:(NSString *)userId 
                         UserToken:(NSString *)userToken 
                           PkgName:(NSString *)pkgName 
                        AppChannel:(NSString *)appChannel 
                           Success:(void(^)(BOOL released))success 
                              Fail:(void (^)(NSString *errorCode))fail;

1.28 startLivingWithLivingId

游戏过程中，开启直播

/**
 @param livingId 直播唯一标识，必填，不能为NULL
 @param pushStreamUrl 第三方推流地址，必填，不能为NULL
 @return 是否开始开启直播
 */
- (BOOL) startLivingWithLivingId:(NSString *)livingId 
                   pushStreamUrl:(NSString *)pushStreamUrl;

1.29 stopLivingWithLivingId

游戏过程中，关闭直播

/**
 @param livingId 直播间ID，必填，不能为NULL
 @return 是否开始结束直播
 */
- (BOOL) stopLivingWithLivingId:(NSString *)livingId;

1.30 getAuthCode

获取授权码，控制端同意转让控制权后调用

/**
 @return 是否开始获取授权码
 */
- (BOOL) getAuthCode;

1.31 gainControlWithMasterCid

获取控制权，申请端调用

/**
 @param cid 控制端cid，必填，不能为NULL
 @param authCode 授权码，必填，不能为NULL
 @return 是否开始获取控制权
 */
- (BOOL) gainControlWithMasterCid:(NSString *)cid 
                         authCode:(NSString *)authCode 
                        extraInfo:(NSString *)extraInfo;

1.32 getLivingCapabilityStatus

查询是否支持直播的方法，建议APP调用时机为收到第一帧回调之后

/**
 @return 是否支持直播枚举结果
 */
- (ELivingCapabilityStatus) getLivingCapabilityStatus;

1.33 stop

停止云游戏，支持配置最小云玩存档时间

/**
 停止云游戏

 @param seconds 存档时长，必填 单位：秒
 */
- (void) stop:(int)seconds;

1.34 stopAndDismiss

停止云游戏带动画，支持配置最小云玩存档时间

/**
 停止云游戏带动画

 @param archiveMinSeconds 存档时长，必填 单位：秒
 */
- (void) stopAndDismiss:(BOOL)animated archiveMinSeconds:(int)seconds；

1.35 hiddenKeyboard

关闭游戏内本地键盘

/**
 关闭本地键盘
 */
- (void)hiddenKeyboard;

1.36 getCloudImageList

获取远端实例图片列表接口

/**
 获取云游戏图库列表

 @param limit 获取图片列表的数量
 @param offset offset表示分页（如20一页的话，0表示第一页，20表示第二页）
 @param cloudFileImageListBlock result 查询结果，imageList 图片列表 errorMsg result为NO时返回错误原因
 */
- (void)getCloudImageList:(NSInteger)limit offset:(NSInteger)offset cloudFileImageListBlock:(HMCloudFileImageListBlock)cloudFileImageListBlock;

1.37 startDownload

图片下载接口

/**
 开始下载图片

 @param downloadList 下载列表
 @param cloudFileDownloadResponseBlock 下载某一个文件回调
 @param cloudFileDownloadComplete 下载完成回调
 @return 是否成功调用下载方法
 */
- (BOOL)startDownload:(NSArray<HMFile *> *)downloadList cloudFileDownloadResponseBlock:(HMCloudFileDownloadResponseBlock)cloudFileDownloadResponseBlock cloudFileDownloadComplete:(HMCloudFileDownloadComplete)cloudFileDownloadComplete;

1.38 startCancelDownload

取消下载接口

/**
 取消下载图片

 @param cancelList 取消列表
 @param cloudFileCancelDownloadResponseBlock 取消某一个文件回调
 @param cloudFileCancelDownloadComplete 取消完成回调
 @return 是否成功调用取消下载方法
 */
- (BOOL)startCancelDownload:(NSArray <HMFile *>*)cancelList
cloudFileCancelDownloadResponseBlock:(HMCloudFileCancelDownloadResponseBlock)cloudFileCancelDownloadResponseBlock
cloudFileCancelDownloadComplete:(HMCloudFileCancelDownloadComplete)cloudFileCancelDownloadComplete;