• 
• 开发者中心
• >
• 云游戏
• >
• SDK开发指南
• >
• 云游戏基础SDK
• >
• iOS
• >
• v6.14

文档版本号：20240108-114

变更说明：

1 产品简介

欢迎使用海马云游戏服务，本文档主要介绍海马云游戏iOS端SDK的接入流程及提供支持的API详情，开发者通过接入海马云游戏SDK，可以实现云游戏的播放、停止、状态回调等各类控制操作和数据交互，在海马云游戏端到端全栈云服务能力基础上，为用户带来顺畅的云游戏体验。

在开始接入SDK前，请确认已经拥有海马云游戏平台接入方ID、创建了渠道号，并已经完成了在海马云游戏平台上传游戏包等相关准备工作。

2 集成 SDK

云游戏SDK为HMCloudPlayerCore.framework，集成的依赖库为HMWebRTC.framework，HaiMaSDK_Bundle_iOS.bundle为x86游戏资源文件。

集成条件：

• 系统支持条件为iOS 9.0及以上。
• SDK接入后需使用真机运行，不支持模拟器。
• 请使用自己的开发者账号和bundleid到真机演示SDK demo。
• 在APP的info.plist添加App Transport Security Settings→Allow Arbitrary Loads→YES 。
• SDK支持webrtc流，请在自己的应用中增加麦克风、照相机权限，info.plist 添加Privacy→Camera Usage Description、Privacy→Microphone Usage Description。
• 建议客户端申请云游戏SDK的参数从自己的服务器端动态获取。

2.1 创建 iOS 项目

1. 打开Xcode并点击Create a new Xcode project。
2. 选择项目类型为Single View App，并点击Next。
3. 输入项目信息，如项目名称、开发团队信息、组织名称和语言，并点击Next。
4. 选择项目存储路径，并点击Create 。
5. 将iOS设备连接至电脑。
6. 进入TARGETS→Project Name→General→Signing菜单，选择Automatically manage signing，并在弹出菜单中点击Enable Automatic。

2.2 下载集成 SDK

1. 前往SDK下载页面，获取最新版的海马云SDK，然后解压出HMCloudPlayerCore.framework，HMWebRTC.framework。
2. 将HMCloudPlayerCore.framework（不要修改SDK名字）复制到项目文件夹下。
3. HMWebRTC为webrtc流依赖库，将HMWebRTC.framework复制项目文件夹下。
4. 打开Xcode（以Xcode 11.0为例），进入TARGETS→Project Name→General→Frameworks, Libraries,and Embedded Content菜单，点击+，再点击Add Other添加HMCloudPlayerCore.framework HMWebRTC.framework。添加完成后，项目会自动链接其他系统库。 为保证动态库的签名和APP的签名一致，你需要将动态库的Embed属性设置为Embed & Sign。

3 快速开始

3.1 导入头文件

#import <HMCloudPlayerCore/HMCloudPlayer.h>

3.2 创建单例

函数原型：

/**
 生成一个单例
 */
+ (instancetype) sharedCloudPlayer;

3.3 配置SDK连接地址接口

在调用注册SDK接口前，调用该接口可以指定 SDK 连接地址信息；在调用注册SDK接口后，调用该接口，会返回失败。

⚠注意：

无特殊说明，接入方无需调用该接口。

函数原型：

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

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

表3-1 参数说明

表3-2 Info 字典中有效 Key 含义

3.4 注册 SDK

函数原型：

/**
 向海马云端注册

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

表3-3 参数说明

3.5 准备游戏

接口会返回一个UIViewController，APP需通过present或push方法将其展示在界面上。

如使用addSubView接入，需根据云游戏方向设置rootViewController的取向。可参考接入Demo。

函数原型：

/**
 准备游戏

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

表3-4 参数说明

表3-5 options字典中有效Key含义

特殊类型定义如下：

表3-6 CloudCoreStreamingType说明

表3-7 HMIntentExtraData说明

函数原型：

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

HMCloudCorePlayerAudioSessionCategory说明

3.6 开始游戏

函数原型：

/**
 开始游戏
 */
- (void) play;

4 国际化

云游戏内部默认使用中文，若希望使用其他语言，则需要进行多语言设置。

4.1 导入多语言包

将HaiMaSDK_Bundle_iOS.bundle资源包导入工程。

4.2 使用多语言

注册SDK时传入多语言参数。

函数原型：

typedef NS_ENUM(NSInteger,HMLanguageType){
    HMLanguageTypeZh_CN = 0,         //中文
    HMLanguageTypeEn_US,             //英语
};

/**
 向海马云端注册

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

准备云游戏时传入多语言参数。调用prepare方法时传入CloudGameOptionKeyLanguage参数支持多语言切换。

示例代码：

NSMutableDictionary *options = [NSMutableDictionary dictionaryWithCapacity:10];
[options setObject:@(1) forKey:CloudGameOptionKeyLanguage];
[[HMCloudPlayer sharedCloudPlayer] prepare:options];

5 API 接口

5.1 暂停游戏接口

函数原型：

/**
 暂停游戏
 */
- (void) pause;

5.2 继续游戏接口

暂停游戏后，通过该接口继续游戏。

函数原型：

/**
 继续云游戏

 @param playingTime 恢复后的时长，单位：ms
 */
- (void) resume:(NSInteger)playingTime;

表5-1 参数说明

5.3 停止游戏接口

函数原型：

/**
 停止游戏
 */
- (void) stop;

/**
 停止游戏，退出游戏界面

 @param animated 和presentViewController 的 animated 值一致
 */
- (void) stopAndDismiss:(BOOL)animated;

5.4 设置背景图接口

函数原型：

/**
 设置背景图
 */
- (void)setBackgroundImage:(UIImage *)bgImage;

表5-2 参数说明

5.5 发送按键指令接口

函数原型：

typedef NS_ENUM(NSInteger, HMCloudPlayerKeyCommand){
    CloudPlayerKeyCommandBackGame = 0x01,
    CloudPlayerKeyCommandEmptyTouch
};

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

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

/**
发送特定键值指令

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

表5-3 参数说明

表5-4 HMCloudPlayerKeyCommand说明

5.6 清晰度查询接口

函数原型：

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

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

- (BOOL) gameParamsQuery:(NSString *)pkgName appChannel:(NSString *)appChannel streamingType:(CloudCoreStreamingType)streamingType success:(void (^)(NSArray<HMCloudPlayerResolution *> *))success fail:(void (^)(NSString *errorCode))fail;

表5-5 参数说明

5.7 路由节点查询接口

函数原型：

/**
IDC路由查询

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

- (BOOL) idcQuery:(BOOL)ipv6Supported success:(void (^)(NSString *url, NSString *ipAddress))success fail:(void (^)(NSString *errorCode))fail;

- (BOOL) idcQuery:(void (^)(NSString *url, NSString *ipAddress))success fail:(void (^)(NSString *errorCode))fail;

表5-6 参数说明

5.8 获取用户最后操作时间戳接口

函数原型：

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

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

5.9 获取云游戏延迟信息接口

通过该接口会返回当前云游戏的网络延迟信息，该算法的准确性基于APP和实例的时钟校准。

函数原型：

/**
 获取云游戏延迟信息

 @return 云游戏延迟，单位ms
 */
- (NSInteger) getVideoLatency;

5.10 测速接口

检测实例到云端的速度。

函数原型：

/**
IDC节点测速

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

- (BOOL) speedTest:(NSInteger)seconds ipv6Supported:(BOOL)ipv6Supported success:(void (^)(int rst))success fail:(void (^)(NSString *errorCode))fail;

- (BOOL) speedTest:(NSInteger)seconds success:(void (^)(int rst))success fail:(void (^)(NSString *errorCode))fail;

表5-7 参数说明

5.11 更新UID和游戏时长接口

函数原型：

/**
 游戏过程中，更新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;

表5-8 参数说明

5.12 SDK发送消息接口

向云端发送消息。

函数原型：

/**
 发送消息

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

表5-9 参数说明

5.13 手动切换清晰度接口

函数原型：

/**
 手动切换清晰度

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

表5-10 参数说明

5.14 进入队列接口

函数原型：

/**
 确认进入排队队列
 */
- (void) confirmQueue;

5.15 开启网络监控接口

函数原型：

/**
 开始网络状态监控

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

表5-11 参数说明

⚠注意：

网络监听过程中，如遇断网，建议调用暂停游戏接口，网络恢复后调用继续游戏接口。

5.16 停止网络监控接口

函数原型：

/**
 停止网络状态监控
 */
- (void) stopNetMonitor;

5.17 静音功能接口

函数原型：

/**
 视频静音开关

 @param mute; true为静音，false恢复声音
 */
- (void) setAudioMute:(BOOL)mute;

5.18 关闭游戏内本地键盘功能接口

函数原型：

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

5.19 设置x86虚拟键盘是否隐藏接口

函数原型：

/**
@param isOpen YES 展示 NO 隐藏
*/
- (void)cloudSwitchKeyboard:(BOOL)isOpen;

5.20 获取实例类型接口

函数原型：

typedef NS_ENUM(NSInteger, CloudInstanceType) {
   CloudInstanceTypeUnknown         = -1,
   CloudInstanceTypeArm                    =    0,
   CloudInstanceTypeX86                    = 1,
}
/**
@return 实例类型 
*/
- (CloudInstanceType)getCloudInstanceType;

5.21 设置显示虚拟按键原始值接口

函数原型：

/**
@param isShow = YES 显示，isShow = NO隐藏
*/
-(void)cloudSetShowVirtualRawKey:(BOOL)isShow;

5.22 设置触屏数据模式接口

函数原型：

typedef NS_ENUM(NSInteger, HMCloudCoreTouchMode) {
   HMCloudCoreTouchModeNone = 0,                 // 关 不传递数据
   HMCloudCoreTouchModeMouse = 1,             // 滑鼠模式
   HMCloudCoreTouchModeScreen = 2,             // 多点触控模式
   HMCloudCoreTouchModeFingerTouch = 3, // 手指触控模式
}
/**
@param HMCloudCoreTouchMode
*/
-(void)cloudSetTouchModel:(HMCloudCoreTouchModel)model;

5.23 获取触屏数据模式接口

函数原型：

typedef NS_ENUM(NSInteger, HMCloudCoreTouchMode) {
   HMCloudCoreTouchModeNone = 0,                 // 关 不传递数据
   HMCloudCoreTouchModeMouse = 1,             // 滑鼠模式
   HMCloudCoreTouchModeScreen = 2,             // 多点触控模式
      HMCloudCoreTouchModeFingerTouch = 3, // 手指触控模式
}
/**
@return HMCloudCoreTouchMode
*/
- (HMCloudCoreTouchMode) getMouseType;

5.24 切换手柄模式接口

函数原型：

typedef NS_ENUM(NSInteger, HMCloudPlayerOperationType) {
   HMCloudPlayerOperationTypeNone,
   HMCloudPlayerOperationTypeXbox,
   HMCloudPlayerOperationTypeKeyboard,
}
/**
@@param HMCloudPlayerOperationType
*/
- (void) switchOperationType:(HMCloudPlayerOperationType) type;

5.25 获取手柄模式接口

函数原型：

typedef NS_ENUM(NSInteger, HMCloudPlayerOperationType) {
   HMCloudPlayerOperationTypeNone,
   HMCloudPlayerOperationTypeXbox,
   HMCloudPlayerOperationTypeKeyboard,
}
/**
@return HMCloudPlayerOperationType
*/
- (HMCloudPlayerOperationType) getOperationType;

5.26 开启按键反馈接口

函数原型：

/**
@param BOOL YES 开启 NO 关闭
*/
- (void) setFeedback:(BOOL) isOpen;

5.27 获取按键反馈接口

函数原型：

/**
@return BOOL YES 开启 NO 关闭
*/
- (BOOL) getFeedback;

5.28 调节x86手柄透明度接口

函数原型：

/**
@param alpha 0-1 0为完全透明 1为完全不透明
*/
- (void) setCustomStickAlpha:(float)alpha;

5.29 获取x86手柄透明度接口

函数原型：

/**
@return alpha 0-1 0为完全透明 1为完全不透明
*/
- (float) getCustomStickAlpha;

5.30 设置x86鼠标灵敏度接口

函数原型：

/**
sensitivity 0-1 0 鼠标无法移动 1 鼠标正常移动
*/
- (void) setMouseSensitivity:(float)sensitivity;

5.31 获取x86鼠标灵敏度接口

函数原型：

/**
@return 0-1 0 鼠标无法移动 1 鼠标正常移动
*/
- (float) getMouseSensitivity;

5.32 x86查询控制权接口

函数原型：

typedef void (^HMAssignControlCallback)(NSArray<HMCloudPlayerControlInfo *>*);
/**
@param cid cid
@param success 查询控制权成功 
@pramm fail 查询控制权失败 
*/
此接口只适用x86类型，只有主播(主控)调用此接口才能成功;
- (void)queryGameControlWithCid:(NSString *)cid Success: (HMAssignControlCallback)success Fail:(void (^)(NSString *errorCode, NSString *errorMsg))fail

5.33 x86分配控制权接口

函数原型：

typedef void (^HMAssignControlCallback)(NSArray<HMCloudPlayerControlInfo *>*);
/**
@param controlInfos 控制权model
@param success 分配控制权成功 
@param fail 分配控制权失败 
*/
此接口只适用x86类型，只有主播(主控)调用此接口才能成功;
当主播分享授权码后，观众(从控)调用获取控制权后，仅仅获得视频流;主播(主控)调用此接口给观众(从控)分 配控制权成功后，从控才能获取控制权。
- (void)assignGameControlWithControlInfos:(NSArray<HMCloudPlayerControlInfo *>*)controlInfos Success:(HMAssignControlCallback)success Fail:(void (^)(NSString *errorCode, NSString *errorMsg))fail;

5.34 x86支持按键指令通道接口

此接口只适用x86类型，app接入方可以自定义UI按键，通过此方法实现按键数据传输。

函数原型：

/**
 发送keycode值
 仅x86游戏使用
 */
- (BOOL)sendCustomKeycode:(HMInputOpData *)inputOPData;

表5-12 参数说明
| 参数 | 类型 | 说明 |
| ———– | ————- | ——– |
| inputOPData | HMInputOpData | 输入数据 |

表5-13 参数说明
HMInputOpData参数说明

表5-14 参数说明
HMOneInputOPData参数说明

X86鼠标键值

X86键盘键值

X86 xbox手柄键值

/**
 将鼠标模式切换成pc模式
 仅x86游戏使用
 @param model true pc模式  false 移动端模式
 */
- (BOOL)convertToPcMouseModel:(BOOL)model;

/**
 游戏存档进度查询

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

- (BOOL) gameArchiveQuery:(NSString *)userId userToken:(NSString *)userToken pkgName:(NSString *)pkgName appChannel:(NSString *)appChannel success:(void (^)(BOOL finished))success fail:(void (^)(NSString *errorCode))fail;

6.2 查询游戏是否存在存档接口

函数原型：

/**
 游戏是否有存档查询

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

- (BOOL) gameArchived:(NSString *)userId userToken:(NSString *)userToken pkgName:(NSString *)pkgName appChannel:(NSString *)appChannel success:(void (^)(BOOL archived))success fail:(void (^)(NSString *errorCode))fail;

表6-2 参数说明

6.3 检测未释放游戏实例接口

函数原型：

/**
 查询是否有上次未释放的游戏实例

 @param (NSArray <HMCloudPlayerReservedSingleIncetance*>*) 未释放游戏实例数组  
  */
typedef void (^HMReservedIncetanceCallback)(NSArray <HMCloudPlayerReservedSingleIncetance*>*);

/**
 查询是否有上次未完成的游戏实例
 @param options 游戏参数  {CloudGameOptionKeyUserId:@"...", CloudGameOptionKeyUserToken:"...",CloudGameOptionKeyAccessKeyId:"..."}
 @param reservedIncetance 查询驻留机回调方法，包含驻留机数组
 */
- (void) getReservedInstance:(NSDictionary *)options ReservedIncetance:(HMReservedIncetanceCallback)reservedIncetance;

表6-3 HMCloudPlayerReservedSingleIncetance说明

6.4 获取延迟信息接口

获取某一秒的延迟信息。

函数原型：

/**
 获取某一秒延迟信息
 @return 包含延迟信息的HMDelayInfoModel
 */
- (HMDelayInfoModel *) getDelayInfo;

表6-4 参数说明

6.5 根据cid释放实例接口

函数原型：

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

- (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;

表6-5 参数说明

6.6 开启直播接口

函数原型：

/**
 游戏过程中，开启直播

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

返回值YES/NO仅表示请求调用的结果，由于开启直播是个异步过程，最终开启直播成功与否请参见直播场景回调。

表6-6 参数说明

6.7 停止直播接口

函数原型：

/**
 游戏过程中，关闭直播

 @param livingId 直播间ID，必填，不能为NULL
 @return 请求调用“停止直播”是否成功
 */
- (BOOL) stopLivingWithLivingId:(NSString *)livingId;

返回值YES/NO仅表示请求调用的结果，由于停止直播是个异步过程，最终停止成功与否请参见直播场景。

6.8 获取授权码接口

函数原型：

/**
 获取授权码，控制端同意转让控制权后调用
 @return 是否开始获取授权码
 */
- (BOOL) getAuthCode;

返回值YES/NO仅表示请求调用的结果，由于获取授权码是个异步过程，最终获取授权码成功与否请参见控制权转移场景回调。

6.9 获取控制权接口

函数原型：

/**
获取控制权，申请端调用

@param cid 控制端cid，必填，不能为NULL
@param authCode 授权码，必填，不能为NULL
@param enabled 是否获取帧渲染回调数据
@return 是否开始获取控制权
**/
- (BOOL) gainControlWithMasterCid:(NSString *)cid authCode:(NSString *)authCode frameRenderCallback:(BOOL)enabled;

- (BOOL) gainControlWithMasterCid:(NSString *)cid authCode:(NSString *)authCode;

返回值YES/NO仅表示请求调用的结果，由于获取控制权是个异步过程，最终获取控制权成功与否请参见控制权转移场景回调。

表6-7 参数说明

6.10 查询是否支持直播接口

函数原型：

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

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

表6-8 返回值定义

6.11 停止云游戏接口

此接口支持配置最小云玩存档时间。

• 无动画停止云游戏，函数原型：

  /**
   无动画停止云游戏
  
   @param seconds 存档时长，必填 单位为s
   */
  
  - (void) stop:(int)seconds;

• 带动画停止云游戏，函数原型：

  /**
   带动画停止云游戏
  
   @param archiveMinSeconds 存档时长，必填 单位为s
   */
  
  - (void) stopAndDismiss:(BOOL)animated archiveMinSeconds:(int)seconds；

6.12 本地键盘状态通知接口

方法名cloudPlayerKeyboardStatusChanged，函数原型：

/**
 本地键盘状态通知

 @param status 本地键盘状态  
 */
- (void) cloudPlayerKeyboardStatusChanged:(CloudPlayerKeyboardStatus)status;

表6-9 参数说明

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

获取远端实例指定目录图片列表，目录由远端实例指定。此功能默认关闭，如需开启请联系项目对接人员。

函数原型：

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

 @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;

表6-10 参数说明

6.14 图片下载接口

此功能默认关闭，如需开启请联系项目对接人员。

通过获取远端实例图片列表接口或者游戏内截图通知回调获取图片名称，调用图片下载方法将图片下载至指定的沙盒目录内，用户可以将沙盒目录内图片移动到系统相册或者自定义相册。

函数原型：

/**
 开始下载图片

 @param downloadList 下载列表
 @param cloudFileDownloadResponseBlock 下载某一个文件回调
 @param cloudFileDownloadComplete 下载完成回调
 @return 仅表示是否成功调用下载方法 ，下载结果以cloudFileDownloadResponseBlock为准
 */

- (BOOL)startDownload:(NSArray<HMFile *> *)downloadList cloudFileDownloadResponseBlock:(HMCloudFileDownloadResponseBlock)cloudFileDownloadResponseBlock cloudFileDownloadComplete:(HMCloudFileDownloadComplete)cloudFileDownloadComplete;

表6-11 参数说明

表6-12 参数说明

HMFile为下载文件。

6.15 图片取消下载接口

当调用图片下载接口后，用户想取消下载可调用此接口。

函数原型：

/**
 取消下载图片

 @param cancelList 取消列表
 @param cloudFileCancelDownloadResponseBlock 取消某一个文件回调
 @param cloudFileCancelDownloadComplete 取消完成回调
 @return 是否成功调用取消下载方法
 */

- (BOOL)startCancelDownload:(NSArray <HMFile *>*)cancelList cloudFileCancelDownloadResponseBlock:(HMCloudFileCancelDownloadResponseBlock)cloudFileCancelDownloadResponseBlock
cloudFileCancelDownloadComplete:(HMCloudFileCancelDownloadComplete)cloudFileCancelDownloadComplete;

表6-13 参数说明

6.16 获取可下载文件列表

当用户需要使用大文件下载功能时，需先获取可下载的文件列表。

函数原型：

/**
 获取可下载列表
 @param type 下载类型
 @param limit 获取图片列表的数量（适用于type为CloudPlayerDownloadTypeImage）
 @param offset offset表示分页（如20一页的话，0表示第一页，20表示第二页 适用于type为  CloudPlayerDownloadTypeImage）
 @param cloudFileListBlock result 查询结果，fileList 可下载列表 errorMsg result为NO时返回错误原因
 */
- (void)getCloudFileList:(CloudPlayerDownloadType)type limit:(NSInteger)limit offset:(NSInteger)offset cloudFileListBlock:(HMCloudFileListBlock)cloudFileListBlock;

表6-14 参数说明

6.17 文件下载

当用户需要使用大文件下载功能时，调用此方法。

函数原型：

/** 
文件下载
 @param type 下载类型
 @param fileList 下载列表
 @param downloadProgressBlock 下载进度
 @param downloadResponseBlock 下载某一个文件回调
 @param downloadComplete 下载完成回调
 @return 是否成功调用下载方法
 */
- (BOOL)downloadFile:(CloudPlayerDownloadType)type fileList:(NSArray<HMFile *> *)fileList downloadProgress:(HMCloudFileDownloadProgressBlock)downloadProgressBlock cloudFileDownloadResponseBlock:(HMCloudFileDownloadResponseBlock)downloadResponseBlock cloudFileDownloadComplete:(HMCloudFileDownloadComplete)downloadComplete;

表6-15 参数说明

6.18 取消文件下载

当用户需要取消下载任务时，调用此方法。

函数原型：

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

表6-16 参数说明

6.19 更新下载列表

当大文件下载任务还未完成，可以调用此方法更新下载任务列表。

函数原型：

- (BOOL)upDateDownloadFileList:(NSArray <HMFile *> *)fileList;

表6-17 参数说明

6.20 获取正在下载任务列表

调用此方法可获取正在下载的任务列表。

函数原型：

/**
 获取待下载任务列表,仅支持文件下载过程中使用
 @return 待下载任务列表
 */
- (NSArray <HMFile *>*)getDownloadTaskList;

6.21 图片上传

当需要使用图片上传功能时，可调用此方法。

函数原型：

/**
 开始上传图片
 @param uploadList 上传列表
 @param cloudFileUploadResponseBlock 上传某一个文件回调
 @param cloudFileUploadComplete 上传完成回调
 @return 是否成功调用下载方法
 */

- (BOOL)startUpload:(NSArray<HMFile *> *)uploadList cloudFileUploadResponseBlock:(HMCloudFileUploadResponseBlock)cloudFileUploadResponseBlock cloudFileUploadComplete:(HMCloudFileUploadComplete)cloudFileUploadComplete;

表6-18 参数说明

6.22 取消图片上传任务

调用此方法可取消所有上传任务。

函数原型：

/**
 取消上传图片
 */
- (void)cancelUploadFileAllTask;

6.23 获取游戏内截图

调用此方法可以获取当前游戏截图。

函数原型：

typedef NS_ENUM(NSInteger,CloudPlayerScreenshotStatus){
    CloudPlayerScreenshotStatusSuccess,          // 获取截图成功
    CloudPlayerScreenshotStatusTimeout,                  // 获取截图超时
    CloudPlayerScreenshotStatusInternalError,         // 获取截图失败
};

/**
 获取游戏截图

 @param scale 图片压缩比例
 @param screenshotBlock 截图获取结果回调
 */
- (void)captureScreenshot:(float)scale screenshotBlock:(HMCloudScreenshotBlock)screenshotBlock;

表6-19 参数说明

7 SDK 消息回调

可选择实现HMCloudPlayerDelegate代理。

函数原型：

- (void) cloudPlayerSceneChangedCallback:(NSDictionary *)dict;
- (void) cloudPlayerTouchBegan;
- (void) cloudPlayerUsageAuthorization:(HMCloudPlayerUsageAuthorization)type success:(void (^)(BOOL authorization))success;
- (void) cloudPlayerScreenCap:(NSDictionary *)dict;
- (void) cloudPlayerShared:(CloudPlayerShareType)shareType dataDict:(NSDictionary *)dataDict;

7.1 游戏视频界面点击回调

方法名为cloudPlayerTouchBegan，游戏视频界面被点击，可用于收起已经展开的非全屏设置界面。

函数原型：

(void) cloudPlayerTouchBegan;

7.2 场景切换回调

方法名为cloudPlayerSceneChangedCallback，回调参数字典说明：

{
  "sceneId": "init",
  "extraInfo": {}
}

表7-1 字典Key说明

7.2.1 初始化场景

字典Key示例：

/**
 state = success
 */
{
    "sceneId": "init",
    "extraInfo":
    {
        "state": "success"
    }
}

/**
 state = failed
 */
{
    "sceneId": "init",
    "extraInfo":
    {
        "state": "failed",
        "errorCode": "100104001",
        "errorCodeWithoutCid": "100104001"
    }
}

表7-2 字典Key说明

7.2.2 配置数据场景

字典Key示例：

/**
 type = titleVideo
 */
{
    "sceneId": "data",
    "extraInfo":
    {
        "type": "titleVideo",
        "data":
        {
            "name": "...",
            "url": "...",
            "version": "..."
        }
    }
}

/**
 type = resolutions
 */
{
    "sceneId": "data",
    "extraInfo":
    {
        "type": "resolutions",
        "data":
        [
            ##清晰度列表##
        ]
    }
}

/**
 type = loadingTips
 */
{
    "sceneId": "data",
    "extraInfo":
    {
        "type": "loadingTips",
        "data":
        {
            "revolveTime": 4000,
            "tips":
            [
                ##Tips列表##
            ]
        }
    }
}

/**
 type = message
 */
{
    "sceneId": "data",
    "extraInfo":
    {
    "type": "message",
    "data": "##消息内容##"
    }
}

/**
 type = speed
 */
{
    "sceneId": "data",
    "extraInfo":
    {
        "type": "speed",
        "data":
        {
            "url": "...",
            "time": 5,
            "rateCoef": 1.0,
            "standCoef": 0.8,
            "skip": 0
        }
    }
}

表7-3 字典Key说明

7.2.3 准备云游戏场景

字典Key示例：

/**
 state = success
 */
{
    "sceneId": "prepare",
    "extraInfo":
    {
        "state": "success"
    }
}

/**
 state = failed
 */
{
    "sceneId": "prepare",
    "extraInfo":
    {
        "state": "failed",
        "errorCode": "100000001",
        "errorCodeWithoutCid": "100104001"
    }
}

表7-4 字典Key说明

7.2.4 云游戏状态变化场景

字典Key示例：

/**
 state = prepared
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "prepared"
    }
}

/**
 state = videoVisible
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "videoVisible"
    }
}

/**
 state = stopped
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "stopped",
        "stop_reason": "",
        "open_api_release_instance" : "",
        "errorCode": "200211005-716971087",
        "errorCodeWithoutCid"   :"200211005",
        "errorMsg": "##错误描述",
        "queues":
        [
            #参考排队场景说明#
        ],
    }
}

/**
 state = timeout
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "timeout",
        "tip": "##提示内容##"
    }
}

/**
 state = refreshSToken
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "refreshSToken"
    }
}

/**
 state = playFailed
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "playFailed",
        "errorCode": "100000001-716971087",
        "errorCodeWithoutCid"   :"100000001"
    }
}

/**
 state = idcInfo
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "idcInfo",
        "idcId": "",
        "idcName": "",
        "instanceTag":"",
        "instanceTagName":""
    }
}

/**
 state = storage
 */
{
    "sceneId": "playerState",
    "extraInfo":
    {
        "state": "storage",
        "action": "",
        "usablePercentage": "",
    }
}

表7-5 字典Key说明

表7-6 stop_reason取值说明

7.2.5 游戏时长场景

字典Key示例：

/**
 state = prompt
 */
{
    "sceneId": "playingtime",
    "extraInfo":
    {
        "state": "prompt",
        "second": 12000,
        "title": "##时长提示##",
        "countdown": 1
    }
}

/**
 state = totaltime
 */
{
    "sceneId": "playingtime",
    "extraInfo":
    {
        "state": "totaltime",
        "second": 12000,
        "title": "##总时长提示##"
    }
}

/**
 state = update
 */
{
    "sceneId": "playingtime",
    "extraInfo":
    {
        "state": "update",
        "title": "##时长更新提示##"
    }
}

表7-7 字典Key说明

7.2.6 播流清晰度场景

字典Key示例：

/**
 type = crst
 */
{
    "sceneId": "resolution",
    "extraInfo":
    {
        "type": "crst",
        "source": 1,
        "des": 3,
        "method": 1,
        "title": "##提示##"
    }
}

/**
 type = cred
 */
{
    "sceneId": "resolution",
    "extraInfo":
    {
        "type": "cred",
        "cur_rate": 1,
        "result": 1,
        "title": "##提示##"
    }
}

/**
 type = crtp
 */
{
    "sceneId": "resolution",
    "extraInfo":
    {
        "type": "crtp",
        "minimum": 1,
        "delay_less_minimum": 1,
        "title": "##提示##"
    }
}

/**
 type = notify
 */
{
    "sceneId": "resolution",
    "extraInfo":
    {
        "type": "notify",
        "cur_rate": 1
    }
}

表7-8 字典Key说明

7.2.7 数据统计场景

字典Key示例：

/**
 type = bandwidth
 */
{
    "sceneId": "stastic",
    "extraInfo":
    {
        "type": "bandwidth",
        "value": 314704,
        "frames":[]
    }
}

/**
 type = frames
 */
{
    "sceneId": "stastic",
    "extraInfo":
    {
        "type": "frames",
        "value": 332
    }
}

/**
 type = decode
 */
{
    "sceneId": "stastic",
    "extraInfo":
    {
        "type": "decode",
        "value": 9
    }
}

表7-9 字典Key说明

7.2.8 排队场景

字典Key示例：

/**
 state = confrim
 */
{
    "sceneId": "queue",
    "extraInfo":
    {
        "state": "confrim",
        "title": "##排队提示##",
        "index": 3,
        "totalNum": 10,
        "queues": []
    }
}

/**
 state = update
 */
{
    "sceneId": "queue",
    "extraInfo":
    {
        "state": "update",
        "title": "##排队提示##",
        "index": 3,
        "totalNum": 10,
        "second": 300,
        "timeStr": “五分钟”,
        "queues": []
    }
}

/**
 state = entering
 */
{
    "sceneId": "queue",
    "extraInfo":
    {
        "state": "entering",
        "title": "##排队提示##"
    }
}

表7-10 字典Key说明

表7-11 多队列排队数据项说明

7.2.9 维护场景

字典Key示例：

/**
 progress = soon
 */
{
    "sceneId": "maintance",
    "extraInfo":
    {
        "progress": "soon",
        "title": "##维护提示##",
        "timeStr": "五分钟"
    }
}

/**
 progress = start
 */
{
    "sceneId": "maintance",
    "extraInfo":
    {
        "progress": "start",
        "title": "##维护提示##"
    }
}

/**
 progress = inprogress
 */
{
    "sceneId": "maintance",
    "extraInfo":
    {
        "progress": "inprogress",
        "title": "##维护提示##",
        "timeStr": "五分钟"
    }
}

/**
 progress = done
 */
{
    "sceneId": "maintance",
    "extraInfo":
    {
        "progress": "done",
        "title": "##维护提示##"
    }
}

表7-12 字典Key说明

7.2.10 无输入提示场景

字典Key示例：

/**
 state = remindtime
 */
{
    "sceneId": "noinput",
    "extraInfo":
    {
        "state": "remindtime",
        "second": 12000,
        "title": "##剩余时长提示##",
    }
}

表7-13 字典Key说明

7.2.11 直播场景

字典Key示例：

/**
 state = startSuccess
 */
{
    "sceneId": "living",
    "extraInfo":
    {
        "state": "startSuccess",
    }
}

/**
 state = startFailed
 */
{
    "sceneId": "living",
    "extraInfo":
    {
        "state": "startFailed",
        "errorCode": "100000001",
        "errorCodeWithoutCid":"100000001"
    }
}

/**
 state = stopSuccess
 */
{
    "sceneId": "living",
    "extraInfo":
    {
        "state": "startFailed",
    }
}

/**
 state = stopFailed
 */
{
    "sceneId": "living",
    "extraInfo":
    {
        "state": "startFailed",
        "errorCode": "100000001",
        "errorCodeWithoutCid":"100000001"
    }
}

表7-14 字典Key说明

7.2.12 控制权转移场景

字典Key示例：

/**
 state = authcodeSuccess
 */
{
    "sceneId": "control",
    "extraInfo":
    {
        "state": "authcodeSuccess",
        "authcode":"skjdksd"
        "masterCid:"ijsdhkk"
    }
}

/**
 state = authcodeFailed
 */
{
    "sceneId": "control",
    "extraInfo":
    {
        "state": "authcodeFailed",
        "errorCode": "200217001" ,
        "errorCodeWithoutCid":"200217001",
        "errorMsg":"服务异常，未生成授权码"
    }
}

/**
 state = loseControl
 */
{
    "sceneId": "control",
    "extraInfo":
    {
        "state": "loseControl",
        "followCid":"d2434e",
        "uid":"h33333"
    }
}

/**
 state = gainControlSuccess
 */
{
    "sceneId": "control",
    "extraInfo":
    {
        "state": "gainControlSuccess"
    }
}

/**
 state = gainControlFailed
 */
{
    "sceneId": "control",
    "extraInfo":
    {
        "state": "gainControlFailed",
        "errorCode":"200217001",
        "errorCodeWithoutCid":"200217001",
        "errorMsg":"服务异常，未生成授权码"
    }
}

表7-15 字典Key说明

7.3 系统隐私权限判断

方法名cloudPlayerUsageAuthorization，函数原型：

/**
 系统隐私权限判断

 @param type 隐私权限类型；
 @param success 授权情况回调；
 */

- typedef NS_ENUM(NSInteger, HMCloudPlayerUsageAuthorization){
    HMCloudPlayerUsageAuthorizationMicrophone = 0, //麦克风权限回调
    HMCloudPlayerUsageAuthorizationCamera          //相机权限回调
};
- (void) cloudPlayerUsageAuthorization:(HMCloudPlayerUsageAuthorization)type success:(void (^)(BOOL authorization))success;

表7-16 参数说明

7.4 游戏内截图通知回调

函数原型：

/**
 游戏内截图通知

 @param dict 通知内容；
 */
- (void) cloudPlayerScreenCap:(NSDictionary *)dict

表7-17 字典Key说明

7.5 分享功能回调

函数原型：

typedef NS_ENUM(NSInteger,CloudPlayerShareType) {
    CloudPlayerShareTypeQQ,
    CloudPlayerShareTypeWeiBo,
    CloudPlayerShareTypeWeiXin,
    CloudPlayerShareTypeAndroid,
    CloudPlayerShareTypeShareLink,
};

/**
 分享功能回调

 @param CloudPlayerShareType 分享类型；
 @param dataDict 分享内容；
 */
- (void) cloudPlayerShared:(CloudPlayerShareType)shareType dataDict:(NSDictionary *)dataDict;

表7-18 字典Key说明

表7-19 dataDict说明

7.6 照相机通知回调

函数原型：

typedef NS_ENUM(NSInteger,CloudPlayerPrivacyType) {
    CloudPlayerPrivacyTypeCamera,
    CloudPlayerPrivacyTypePhotosAlbum,
};

- (void)cloudPlayerPrivacy:(CloudPlayerPrivacyType)privacyType;

表7-20 字典Key说明

7.7 文件状态变化回调

函数原型：

typedef NS_ENUM(NSInteger, CloudPlayerDownlodFileEventStatus) {
    CloudPlayerDownlodFileEventStatusUndefined,      //未定义状态
    CloudPlayerDownlodFileEventStatusCreateFile,     //创建录屏文件
    CloudPlayerDownlodFileEventStatusFinishFile,     //录屏完成
    CloudPlayerDownlodFileEventStatusListFile,       //可下载文件列表
};

- (void)cloudPlayerDownloadFile:(CloudPlayerDownlodFileEventStatus)status dataDict:(NSDictionary *)dataDict;

表7-20 字典Key说明