目录

VirtualDeviceManager

Class Info

public class VirtualDeviceManager extends VirtualManager

该类提供设备虚拟化的主要功能性接口,包括虚拟设备发现查询、获取虚拟设备列表、打开相应虚拟设备等。

Public Method Summary

Qualifier and Type

Method Name and Description

int

startDiscovery(IDiscoveryCallback callback)

提供虚拟设备搜索接口。

int

cancelDiscovery(IDiscoveryCallback callback)

取消掉上一次discovery操作。

List

getVirtualDevicesList()

根据Discovery搜索信息找到的虚拟设备列表。

int

enableVirtualDevice (String deviceId, EnumSet capability, Map info)

使能指定的设备服务。

int

disableVirtualDevice(String deviceId, EnumSet capability)

去使能指定的设备服务。

int

subscribe(EnumSet typeFilter, IVirtualDeviceObserver callback)

订阅虚拟设备事件消息。

int

unsubscribe(EnumSet typeFilter, IVirtualDeviceObserver callback)

取消虚拟设备消息订阅。

Public Methods

[h2]startDiscovery

Method

public int startDiscovery(IDiscoveryCallback callback)

提供虚拟设备搜索接口,三方App可以传入IDiscoveryCallback接口实现异步查找回调。

Parameters

Name

Description

callback

设备发现的回调接口,获取发现到的虚拟设备

IDiscoveryCallback {
void onFound(VirtualDevice device, int state);
void onState(int state);
}

onFound发现的设备是逐个上报返回。

onState状态参见EventType中发现状态的状态定义。

Return

Type

Description

int

0表示调用成功,非0表示调用失败,详见ReturnCode说明。

[h2]cancelDiscovery

Method

public int cancelDiscovery(IDiscoveryCallback callback)

三方APP通过cancelDiscovery接口取消掉上一次discovery操作。

Parameters

Name

Description

callback

设备发现的回调接口,获取发现到的虚拟设备:

IDiscoveryCallback {
Void onFound(VirtualDevice device, int state);
Void onState(int state);
}

此处传入的回调对象应为发现时传入的回调对象,仅作参数校验使用。

Return

Type

Description

int

0表示调用成功,非0表示调用失败,请参见ReturnCode说明。

[h2]getVirtualDevicesList

Method

public List getVirtualDevicesList()

根据Discovery搜索信息找到的虚拟设备列表。如果APP未调用startDiscovery当前接口返回设备元素为0。

Return

Type

Description

List

返回上一次调用startDiscovery接口后发现的虚拟设备列表。

[h2]enableVirtualDevice

Method

public int enableVirtualDevice (String deviceId, EnumSet capability, Map info)

使能指定的设备服务。

1. DV Engine针对不同的能力有不同的权限管理,这里使能指定服务的时候,需要先申请特定的权限,然后才能使用,具体的权限申请参见《开发指南》中权限声明。

2. 如果去使能服务接口disableVirtualDevice没有返回,应用APP需要等待调用完成后,再调用使能服务接口enableVirtualDevice。

Parameters

Name

Description

deviceId

要打开的虚拟设备ID。

capability

指定使能的虚拟服务,服务定义如下指定获取的设备包含的虚拟化能力,包括:

Capability.CAMERA

Capability.MIC

Capability.SPEAKER

Capability.DISPLAY

Capability.VIBRATE

Capability.SENSOR

Capability.NOTIFICATION

参见Enum Capability。

info

扩展信息,当前仅用于打开虚拟camera时,传入参数摄像头是否开启旋转参数。

使用方式为,在扩展信息info中添加常量AUTO_ORIENTATION作为key。

常量AUTO_ORIENTATION_ENABLE作为value用于打开自动旋转功能。

AUTO_ORIENTATION_DISABLE作为value用于关闭自动旋转功能,若未设置,默认为关闭。

Return

Type

Description

int

0表示调用成功,非0表示调用失败,参见ReturnCode说明。

[h2]disableVirtualDevice

Method

public int disableVirtualDevice(String deviceId, EnumSet capability)

去使能指定的设备服务。

1. DV Engine针对不同的能力有不同的权限管理,这里使能指定服务的时候,需要先申请特定的权限,然后才能使用,具体的权限申请参见《开发指南》中权限声明。

2. 如果使能服务接口enableVirtualDevice没有返回,上层应用APP需要等待调用完成后,再调用去使能服务接口disableVirtualDevice。

3.当发生异常,需要断开DV Engine的时候,需要先调用disableVirtualDevice。

Parameters

Name

Description

deviceId

需要去使能的虚拟设备ID。

capability

指定使能的虚拟服务,服务定义如下指定获取的设备包含的虚拟化能力,包括:

Capability.CAMERA

Capability.MIC

Capability.SPEAKER

Capability.DISPLAY

Capability.VIBRATE

Capability.SENSOR

Capability.NOTIFICATION

详见Enum Capability。

Return

Type

Description

int

0表示调用成功,非0表示调用失败,参见ReturnCode说明。

[h2]subscribe

Method

public int subscribe(EnumSet typeFilter, IVirtualDeviceObserver callback)

订阅虚拟设备事件消息。当前支持的设备事件类型,参见EventType定义。

Parameters

Name

Description

typeFilter

订阅类型目前支持虚拟设备相关的信息:ObserverEventType.VIRTUALDEVICE。

callback

设备能力状态变化的观察接口,用于获取设备能力的使能去使能状态变化:

Interface IVirtualDeviceObserver{

void onDeviceStateChange(VirtualDevice device,int event);

void onDeviceCapabilityStateChange(VirtualDevice virtualDevice, Capability capability, int event);

}

Return

Type

Description

int

0表示调用成功,非0表示调用失败,详见ReturnCode说明。

[h2]unsubscribe

Method

public int unsubscribe(EnumSet typeFilter, IVirtualDeviceObserver callback)

取消虚拟设备消息订阅。

Parameters

Name

Description

typeFilter

订阅类型目前支持虚拟设备相关的信息:ObserverEventType.VIRTUALDEVICE。

callback

设备能力状态变化的观察接口,用于获取设备能力的使能去使能状态变化。

Interface IVirtualDeviceObserver {

void onDeviceStateChange(VirtualDevice device,int event);

void onDeviceCapabilityStateChange(VirtualDevice virtualDevice, Capability capability, int event);

}

此处传入的回调对象应为订阅时传入的回调对象,仅作参数校验使用。

Return

Type

Description

int

0表示调用成功,非0表示调用失败,参见ReturnCode说明。