iOS SDK

获取方式

集成环境要求

SDK集成

SDK权限

Privacy - Microphone Usage Description

Privacy - Camera Usage Description

SDK签名

echo "8AEF20DC6E0CBFF4FA852118BCDD6D507F5764ED" > KEY

security find-identity -v -p codesigning

set -e
SHELL_PATH="${PROJECT_DIR}/ASPDemo/Lib/ASPEngineSDK/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}"

工程配置注意事项

方案详见无影云手机快速集成最佳实践。 云手机集成的总体方案如下图所示

有多种登录方式，获取集成SDK所需要的连接云手机Ticket凭证，流程图为：

具体集成代码可以参考生命周期接口的参考代码。

2.1 初始化实例

+ (instancetype)buildStreamView;

2.2 建立连接

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

ASPConnTicket参数说明：

2.3 断开连接

- (int)stop;

2.4 暂停

暂停云端下发流和端侧流渲染

- (void)pause;

2.5 恢复

恢复云端下发流和端侧流渲染

- (void)dispose;

2.6 销毁实例

- (void)dispose;

2.7 回调说明

//云手机连接相关回调
@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;

云手机连接相关回调ASPEngineDelegate

LyncChannel使用示例：

//默认命令通道LyncChannel name为static NSString *LYNC_CHANNEL_NAME = @"lync_adb_shell";
//添加LyncChannelself.lync = [[DemoLyncChannel alloc] initWithParameter:LYNC_CHANNEL_NAME];
[self.streamView addLyncChannel:self.lync];
//移除LyncChannel
[self.streamView removeLyncChannel:self.lync];
//LyncChannel实现@interface DemoLyncChannel : BaseLyncChannel@property (nonatomic, strong) NSString *lslaID;

@end@implementation DemoLyncChannel

- (void)onConnectStateChanged:(BOOL)connected {
    NSLog(@"[DemoLyncChannel] onConnectStateChanged %d", connected);
    if (connected) {
        //TEST send cmdself.lslaID = [DemoToolBox getID];
        NSString *cmdData = [DemoToolBox getJsonDataWithId:self.lslaID cmd:@"ls -la"];
        NSLog(@"[DemoLyncChannel] cmdData : %@", cmdData);
        LyncErrorCode code = [self sendString:cmdData];
        NSLog(@"[DemoLyncChannel] cmdData code: %ld", code);
    }
}
- (void)onReceiveStringData:(NSString * _Nonnull)buf {
    NSLog(@"[DemoLyncChannel] onReceiveStringData %@", buf);
    NSDictionary *dic = [DemoToolBox convertStringToJSON:buf];
    NSString *ID = [dic objectForKey:@"id"];
    if (ID != NULL && ID.length && [self.lslaID isEqualToString:ID]) {
        NSLog(@"[DemoLyncChannel] onReceiveStringData get ls -la result");
    }
}
- (void)onReceiveRawData:(NSData * _Nonnull)buf {
    NSString *string = [[NSString alloc] initWithData:buf encoding:NSUTF8StringEncoding];
    NSLog(@"[DemoLyncChannel] onReceiveRawData %@", string);
}
@end

DataChannel使用示例：

//默认DataChannel name为static NSString *DATA_CHANNEL_NAME = @"wy_vdagent_default_dc";
//添加DataChannelself.esdAgent = [[DemoEDSAgentChannel alloc] initWithParameter:DATA_CHANNEL_NAME];
[self.streamView addDataChannel:self.esdAgent];
//移除DataChannel
[self.streamView removeDataChannel:self.esdAgent];
//DataChannel实现@interface DemoEDSAgentChannel : BaseEDSAgentChannel@end@implementation DemoEDSAgentChannel

- (void)onConnectStateChanged:(ASPDCConnectState)state {
    NSLog(@"[DemoEDSAgentChannel] onConnectStateChanged %ld", state);
    if (state == OPEN) {
        // to send data
    }
}
- (void)onReceiveData:(NSData * _Nonnull)buf {
    NSString *string = [[NSString alloc] initWithData:buf encoding:NSUTF8StringEncoding];
    NSLog(@"[DemoEDSAgentChannel] onConnectStateChanged %@", string);
}
@end

消息通道使用datachannel，datachannel名称为wy_vdagent_default_dc。

消息大小限制500KB。

基体消息格式如下：

DataChannel 端侧发送消息给镜像 client --> guest

action:insertcontact/insertsms/sendcontactcvf

• insertcontact是插入联系人

参数name是联系人名称，必填。

参数phonenumber是电话号码，必填。

• insertsms是插入短信

参数phonenumber是电话号码, 必填。

参数textbody是短信内容，必填。

参数canInsertdb是否可以插入云手机短信数据库，选填，默认0, 不插入， 1为插入。

示例：let jsonarray = [{'action': 'insertcontact','importdata':[{ 'name': '**', 'phonenumber': '**' }, { 'name': '**', 'phonenumber': '**' }]},{'action': 'insertsms','importdata':[{'phonenumber':'**','textbody':'**,"canInsertdb":0/1}]}]

• sendcontactvcf是通过vcf插入联系人

参数data是vcf文件数据流，必填，若文件过大，需拆包，一个包最大1MB。

参数allsize是vcf文件数据总大小，必填。

示例：{'action': 'sendcontactvcf',importdata:{data:"", "allsize":文件数据总大小, "timestamp":时间戳}}。

public void processByteArrayInChunks(byte[] data) {
    int chunkSize = 512 * 1024; // 500KB in bytesint length = data.length;
    long timestamp = System.currentTimeMillis();
    for (int i = 0; i < length; i += chunkSize) {
        int end = Math.min(i + chunkSize, length);
        byte[] chunk = Arrays.copyOfRange(data, i, end);
        String str = new String(chunk, StandardCharsets.UTF_8);
        /**
          {'action': 'sendcontactvcf','importdata':{"data":str, "allsize":length, "timestamp":timestamp}}
        */
    }
}

String recvData = "";
int recvSize = 0;
long recvTimestamp = 0;
public void onMessageReceive(byte[] message) {
  String action = getActioin(meesage);
  String data = getData(message);
  int length = data.length;
  int allSize = getAllSize(message);
  long timestamp = getTimestamp(message);
  if (timestamp != recvTimestamp) {
    clearRecv();
  }
  if (action.equals("sendcontactvcf")) {
    recvSize += length;
    recvData = recvData + data;
    if (recvSize >= allSize) {
      // recvData 写vcf文件 插入联系人
      insertContact(vcfFilePath);
      sendack()
      clearRecv();
    }
  }
}

public void clearRecv() {
  recvData = ""
  recvSize = 0;
  recvTimestamp = 0;
}

DataChannel 镜像发送消息给端侧 guest --> client

action:openeditsms/openphone/rotation

• openeditsms打开编辑短信页面

参数importdata.phonenumber是电话号码，选填。

参数textbody是短信内容，选填。

示例：{'action': 'openeditsms',importdata:{"phonenumber":"***", "textbody":"***"}} 

• openphone打开电话拨号页面

参数importdata.phonenumber是电话号码，选填，有电话号，则打开拨打指定联系人页面，没有电话号码，则打开电话拨号页面。

示例：{'action': 'openphone','importdata':{"phonenumber":"***"}} 或 {'action': 'openphone'}

DataChannel 回执消息

action:ack

• ack是指不管是端侧发送消息给镜像，还是镜像发送消息给端侧，收到消息侧，根据业务需要，可回执ack消息，表明消息处理的情况

参数source是接收到消息的action，必填。

参数code是状态码，必填值为0表示未知，1 执行source，2 执行成功，3 执行失败， 4 不支持执行。

示例：{'action': 'ack','importdata':{"source":"***", "code": *,"id":*}}

4.1 ASPConnTicket

建立连接的配置参数。

4.2 ASPStatisticsInfo

性能数据

5.1 ASPScaleType

流化图像内容缩放处理类型。