iOS SDK

2.1 集成环境要求

最低支持iOS版本：10.0

由于iOS系统相关接口的开放，外设鼠标和键盘功能，要求iOS最低版本：13.4

2.2 主要文件

2.3 集成与使用SDK

Privacy - Microphone Usage Description

Privacy - Camera Usage Description

echo "8AEF20DC6E0CBFF4FA852118BCDD6D507F5764ED" > KEY

security find-identity -v -p codesigning

target --> Build Phases --> + --> New Run Script Phase --> 填写sh内容，参考签名示例 --> 添加KEY文件，在Input Files处，点击+，填写$(SRCROOT)/KEY
注意：此Run Script必现在Embed Frameworks下面。

set -e
SHELL_PATH="${PROJECT_DIR}/ASPDemo/Lib/ASPEngineSDK/3.1.2022063002-SNAPSHOT/ASPEngineSDK.framework/link_and_sign.sh"
while read -r line; do
exit 0
done < ${SCRIPT_INPUT_FILE_0}
echo "===> Signing using $line"
/bin/bash -c "${SHELL_PATH}"\ "${TARGET_BUILD_DIR}"\ "${FRAMEWORKS_FOLDER_PATH}"\ "${line}"

target --> Build Settings --> Build Options --> Enable Bitcode -->设置No

- (void)viewDidLoad {
    [super viewDidLoad];

    #设置log回调，SDK日志通过此回调输出
    [ASPStreamView setASPEngineLogDelegate:[ASPDemoLog sharedInstance]];
    #创建对象并开始连接云手机
    ASPStreamView* streamView = [ASPStreamView buildStreamView];
    [streamView setASPEngineDelegate:self];
    if (self.connParam.connTicket) {
        ASPConnTicket* ticketParam = [[ASPConnTicket alloc] init];
        ticketParam.connTicket = self.connParam.connTicket;
        ticketParam.useVpc = false;
        ticketParam.enableStatistics = true;
        ticketParam.desktopId = self.connParam.desktopId;
        [streamView startWithTicket:ticketParam];
    } else {
        ASPConnParam* connParam = [[ASPConnParam alloc] init];
        connParam.connIp = self.connParam.connIp;
        connParam.connPort = self.connParam.connPort;
        connParam.connUdpPort = self.connParam.connUdpPort;
        connParam.connToken = self.connParam.connToken;
        connParam.enableTls = self.connParam.enableTls;
        connParam.desktopId = self.connParam.desktopId; 
        connParam.enableStatistics = true;
        [streamView start:connParam];
    }
    self.streamView = streamView;
    [self.view addSubview:streamView];
    //埋点回调
    [self.streamView setASPEngineStatisticsDelegate:self];
}

- (void)onConnectionSuccess {
    NSLog(@"云手机连接成功回调");
}

- (void)onDisconnected:(int)reason {
    //reason 2000-断开成功 2001~2009-云上主动断开的状态码 2001~2005-含义请查看下面错误说明 2006~2009-预留定义，暂时没有含义
    NSLog(@"云手机已断开连接回调");
}

- (void)onReconnect {
    NSLog(@"云手机在自动重连回调");
}

- (void)onConnectionFailureWithErrCode:(int)errCode errMsg:(NSString *)errMsg {
    NSLog(@"云手机报错回调");
}

- (void)onEngineErrorWithErrCode:(int)errCode errMsg:(NSString *)errMsg {
    NSLog(@"ASPEngineSDK内部逻辑出现错误");
}

- (void)onStatisticsInfoUpdate:(StatisticsInfo)info {
    NSLog(@"埋点回调");
}

3.1.1 ASPStreamView.h

3.1.1.1 init

初始化接口。

+ (instancetype)buildStreamView;

3.1.1.2 start

通过指定的server连接参数，连接云手机。

1）通过从PaaS获取的server session启动串流服务。

- (void)startWithTicket:(ASPConnTicket*) ticketParam;

ASPConnTicket参数说明：

3.1.1.3 stop

断开云手机接口。

- (int)stop;

3.1.1.4 dispose

销毁云手机对象。

- (void)dispose;

3.1.1.5 delegate

//云手机连接相关回调
@property (nonatomic, weak) id<ASPEngineDelegate> engineDelegate;
//分辨率发生变化回调
@property (nonatomic, weak) id<ASPEngineResolutionUpdateDelegate> resolutionUpdateDelegate;
//鼠标光标相关回调
@property (nonatomic, weak) id<ASPEngineCursorDelegate> cursorDelegate;
//云手机方向发生变化回调
@property (nonatomic, weak) id<ASPEngineOrientationUpdateDelegate> orientationUpdateDelegate;
//埋点相关回调
@property (nonatomic, weak) id<ASPEngineStatisticsDelegate> statisticsDelegate;
//输入法相关回调
@property (nonatomic, weak) id<ASPEngineIMEDelegate> imeDelegate;
//LOG相关回调，delegate建议使用单例
+ (void)setASPEngineLogDelegate:(id<ASPEngineLogDelegate>)delegate;
+ (void)unsetASPEngineLogDelegate;

3.1.1.6 enableStatistics

是否开启埋点。

- (BOOL)enableStatistics:(BOOL) enabled;

3.1.1.7 enableMouseMode

是否开启鼠标模式。

- (BOOL)enableMouseMode:(BOOL)enabled;

3.1.1.8 enableDump

是否开启dump，此功能会消耗性能，只用于开发调试，禁止上线。

@property (nonatomic, assign) BOOL enableDump;

3.1.1.9 sendKeyboardEvent

发送键盘按键事件。

- (BOOL)sendKeyboardEvent: (ASPKeyEvent) event;

3.1.1.10 simulateMouseClick

模拟鼠标点击。

// leftButton是鼠标左键还是右键 鼠标点击位置 x:0 y:0
- (BOOL)simulateMouseClick:(BOOL)leftButton;
- (BOOL)simulateMouseClick:(BOOL)leftButton x:(float)x y:(float)y;

3.1.1.11 setVideoProfileWithWidth

设置分辨率。

- (void)setVideoProfileWithWidth:(int)width height:(int)height fps:(int)fps;

3.1.1.12 setMute

设置是否静音。

@property (nonatomic, assign) BOOL mute;

3.1.2 ASPEngineSDK.h

3.1.2.1 start

通过指定的server连接参数，连接云手机

1）通过从PaaS获取的server session启动串流服务

- (void)startWithTicket:(ASPConnTicket*) ticketParam;

ASPConnTicket参数说明：

2）通过指定的server连接参数启动云端的串流服务

该方法通常用于日常调试，适用于不经过网关（或已知网关地址并得到可访问的token），能够直联ASP Server的情形

- (void)start:(AspConnParam*) connParam;

AspConnParam参数说明：

3.1.2.2 stop

断开云手机接口

- (int)stop;

3.1.2.3 pause

暂停云手机接口

- (void)pause;

3.1.2.4 resume

恢复云手机接口

- (void)resume;

3.1.2.5 setRenderView

设置云手机视图容器接口

- (void)setRenderView:(UIView*) view;

3.1.2.6 dispose

销毁云手机对象

- (void)dispose;

3.1.2.7 enableRTC

是否使用RTC传输

- (void)enableRTC:(bool) enabled;

3.1.2.8 enableVDAagentCheck

是否check VDAagent

- (void)enableVDAagentCheck:(bool) enabled;

3.1.2.9 enableStatistics

是否开启埋点

- (BOOL)enableStatistics:(BOOL) enabled;

3.1.2.10 dump

dump相关接口，dump只用于开发联调，比较耗性能，禁止上线

- (void)setDumpPath:(NSString *)path;

@property (nonatomic, assign) BOOLenableDump;

3.1.2.11 delegate

各类相关回调

//云手机连接相关回调
@property (nonatomic, weak) id<ASPEngineDelegate> engineDelegate;
//分辨率发生变化回调
@property (nonatomic, weak) id<ASPEngineResolutionUpdateDelegate> resolutionUpdateDelegate;
//鼠标光标相关回调
@property (nonatomic, weak) id<ASPEngineCursorDelegate> cursorDelegate;
//云手机方向发生变化回调
@property (nonatomic, weak) id<ASPEngineOrientationUpdateDelegate> orientationUpdateDelegate;
//埋点相关回调
@property (nonatomic, weak) id<ASPEngineStatisticsDelegate> statisticsDelegate;
//输入法相关回调
@property (nonatomic, weak) id<ASPEngineIMEDelegate> imeDelegate;
//剪贴板相关回调
@property (nonatomic, weak) id<ASPEngineClipboardDelegate> clipboardDelegate;
//手势缩放相关回调
@property (nonatomic, weak) id<ASPEngineGestureDelegate> gestureDelegate;
//日志相关回调
@property (class, nonatomic, weak) id<ASPEngineLogDelegate> logDelegate;

3.1.2.12 setVideoProfileWithWidth

设置云手机分辨率

- (void)setVideoProfileWithWidth:(int)width height:(int)height fps:(int)fps; //视频流目标fps，目前不生效

3.1.2.13 touch

发送Touch事件

- (void)sendTouchEvent:(ASPTouchEvent*)event touchAction:(ASPTouchAction)action;

- (void)sendTouchEvents:(NSArray<ASPTouchEvent*>*) eventArray touchAction:(ASPTouchAction)action index:(int)index;

3.1.2.14 keyboard

发送Keyboard事件

- (BOOL)sendKeyboardEvent: (ASPKeyEvent) event;

// Caps/Num/Scroll Lock
- (void)sendKeyboardLockModifiers: (int) modifers;

3.1.2.15 mouse

是否开启鼠标模式

- (BOOL)enableMouseMode:(BOOL) enabled;

发送Mouse相关事件

- (void)sendMouseButtonEvent: (ASPMouseButtonEvent)event;

- (void)sendMouseMoveEvent: (ASPMouseMoveEvent)event;

- (void)sendMouseWheelEvent:(int)delta buttonState:(ASPMouseButtonMask)buttonState;

3.1.2.16 ime

发送Ime相关事件

- (void)setImePreedit: (NSString*)preeditStr;

- (void)setImeCommit: (NSString*)commitStr;

3.1.2.17 clipboard

发送剪贴板事件

- (void)sendClipboardType:(int)type;

type 参数：

enum ASPEngineClipboardType {
    ASPENGINE_CLIPBOARD_NONE = 0,
    ASPENGINE_CLIPBOARD_UTF8_TEXT,
    ASPENGINE_CLIPBOARD_IMAGE_PNG,  /* All clients with image support should support this one */
    ASPENGINE_CLIPBOARD_IMAGE_BMP,  /* optional */
    ASPENGINE_CLIPBOARD_IMAGE_TIFF, /* optional */
    ASPENGINE_CLIPBOARD_IMAGE_JPG,  /* optional */
};

3.1.2.18 ASPEngineDelegate

云手机连接相关回调

@protocol ASPEngineDelegate <NSObject>
// engine内部错误
- (void)onEngineErrorWithErrCode:(int)errCode errMsg:(NSString*)errMsg;
// 云手机连接成功
- (void)onConnectionSuccess;
// 云手机连接失败
- (void)onConnectionFailureWithErrCode:(int)errCode errMsg:(NSString*)errMsg;
// 云手机已断开连接
- (void)onDisconnected:(int)reason;
// 云手机第一帧回调
- (void)onFirstFrameRendered:(long)timeCostMS;
// 云手机正在重连
- (void)onReconnect;

@end

3.1.2.19 ASPEngineResolutionUpdateDelegate

云手机分辨率发生变化回调

@protocol ASPEngineResolutionUpdateDelegate <NSObject>

- (void)onResolutionUpdateWithOldWidth:(int)oldWidth oldHeight:(int)oldHeight
width:(int)width height:(int)height;

@end

3.1.2.20 ASPEngineCursorDelegate

云手机光标形态发生变化回调

@protocol ASPEngineCursorDelegate <NSObject>
//当云上光标形态变化时
- (void)onCursorBitmapUpdateWithHotX:(int)hotX hotY:(int)hotY width:(int)width
height:(int)height rgba:(char*)rgba;
//当云上光标状态被重置时
- (void)onCursorReset;
//当云上光标被隐藏时
- (void)onCursorHide;
//当云上光标位置发生变化时
- (void)onCursorMoveWithX:(int)x y:(int)y;
@end

3.1.2.21 ASPEngineOrientationUpdateDelegate

监听云上屏幕旋转事件

@protocol ASPEngineOrientationUpdateDelegate <NSObject>

- (void)onOrientationUpdateWithOldOrientation:(int)oldOrientation newOrientation:(int)newOrientation;

@end

3.1.2.22 ASPEngineStatisticsDelegate

用于监听性能及关键运行状态数据报告

@protocol ASPEngineStatisticsDelegate <NSObject>

- (void)onStatisticsInfoUpdate:(ASPStatisticsInfo *)info;

@end

ASPStatisticsInfo 参数说明：

@interface ASPStatisticsInfo : NSObject

@property (nonatomic, assign) int mReceiveFps; // 端侧每秒接收到的视频祯数量
@property (nonatomic, assign) int mRenderFps; // 端侧渲染FPS
@property (nonatomic, assign) double mDownstreamBandwithMBPerSecond; // 下行带宽，MB/s
@property (nonatomic, assign) double mUpstreamBandwithMBPerSecond; // 上行带宽，MB/s
@property (nonatomic, assign) long mP2pFullLinkageLatencyMS; // 端到端全链路时延，毫秒
                                           // 目前该值需要在guest os中使用特定应用才可准确表示
@property (nonatomic, assign) long mNetworkLatencyMS; // 网络rtt时延，毫秒
@property (nonatomic, assign) long mPingGatewayRtt;   // Ping rtt时延，毫秒
@property (nonatomic, assign) double mLostRate; // 丢包率
@property (nonatomic, assign) long mServerRenderLatencyMS; // 服务端渲染时延，毫秒
@property (nonatomic, assign) long mServerEncoderLatencyMS; // 服务端编码时延，毫秒
@property (nonatomic, assign) long mServerTotalLatencyMS; // 服务端总时延，毫秒
@property (nonatomic, assign) long accumulateBandwidth; //总带宽
@property (nonatomic, copy  ) NSString *protocolType; //流协议类型

@property (nonatomic, copy  ) NSDictionary *infoDic;

@end

3.1.2.23 ASPEngineIMEDelegate

用于监听云上输入框焦点变化及输入法UI位置状态

@protocol ASPEngineIMEDelegate <NSObject>

//当云上输入框获取/失去焦点时
- (void)onIMEFocusUpdate:(bool)hasFocus;
//当云上输入法UI的位置发生变化时时
- (void)onIMELocationUpdateWithX:(int)x y:(int)y;

@end

3.1.2.24 ASPEngineClipboardDelegate

用于监听云上剪贴板读取端侧数据或写入数据到端侧

@protocol ASPEngineClipboardDelegate <NSObject>

//云手机粘贴时，从端侧读取数据
- (void)onClipBoardRead:(int)engineId type:(int *)type data:(uint8_t**)data size:(int *) size selection:(uint8_t)selection;
//云手机复制时，写入数据到端侧
- (void)onClipBoardWrite:(int)engineId type:(int)type data:(uint8_t*)data size:(int)size;

@end

3.1.2.25 ASPEngineGestureDelegate

用于监听手势缩放和移动（双指操作）

@protocol ASPEngineGestureDelegate <NSObject>

- (void)onScale:(float)sx sy:(float)sy;
- (void)onTranslate:(float)tx ty:(float)ty;

@end

3.1.2.26 ASPEngineLogDelegate

日志输出回调

@protocol ASPEngineLogDelegate <NSObject>

- (void)onLogMessage:(NSString*)msg tag:(NSString*)tag level:(AspLogLevel)level;

@end

3.1.2.27 mute

设置是否静音

@property (nonatomic, assign) BOOL mute;