接入文档
H5 lite方案
界面与兼容性说明
H5兼容性配置指引
H5兼容性配置指引
本文说明 H5方案在不同宿主环境下的摄像头、麦克风配置。H5 页面无法自行申请系统权限,需要宿主放行;只在应用清单里声明权限不够,还要在 WebView 的权限回调里显式放行。H5活体方案包括webRTC和录制上传两种模式,接入方需要对这两种模式都做兼容性配置。
按接入形态查看对应小节:iframe 内嵌、App 内 WebView、Uniapp X。
# iframe接入配置指引
使用iframe内嵌,有以下注意事项
1、在iframe内加入属性 allow="camera *;microphone *",相机、麦克风都要放行,缺一项对应能力不可用。
2、父页面需要是https。
# App调用H5兼容性配置指引
1.需要使用https;
2.安卓,IOS、鸿蒙 通过web-view使用需要进行一定的适配。
# 安卓解决方案:
Android5.0 之后的版本原生webview,app层面需要摄像机权限和麦克风权限。
text
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
网页中会实时弹出获取摄像头权限,需要在webview授权处理中允许
说明
在 Android 上,试过在程序上动态赋予摄像头权限后,开启网页调用摄像头还是会提示权限被拒绝,原因是 Android 浏览器上回调默认是拒绝的,还是需要重 webChromeClient 里面的方法,手动赋予或者自定义 dialog 提示用户是否授权。
text
// 以下成员和方法放在 Activity 类中
private static final int WEB_MEDIA_PERMISSION_REQUEST = 200;
private PermissionRequest pendingMediaRequest;
private boolean mediaPermissionInFlight;
// 初始化 WebView 时调用,需在 loadUrl() 之前执行。
// 如果已有 WebChromeClient,请将这两个回调合并到现有实现中。
private void setupWebMediaPermission(WebView webView) {
webView.setWebChromeClient(new WebChromeClient() {
@Override
public void onPermissionRequest(PermissionRequest request) {
runOnUiThread(() -> requestWebMediaPermission(request));
}
@Override
public void onPermissionRequestCanceled(PermissionRequest request) {
runOnUiThread(() -> {
if (pendingMediaRequest == request) {
pendingMediaRequest = null;
}
});
}
});
}
// 将网页资源映射到 Android 系统权限
private String androidPermissionFor(String resource) {
if (PermissionRequest.RESOURCE_VIDEO_CAPTURE.equals(resource)) {
return Manifest.permission.CAMERA;
}
if (PermissionRequest.RESOURCE_AUDIO_CAPTURE.equals(resource)) {
return Manifest.permission.RECORD_AUDIO;
}
return null;
}
// H5 请求权限时,检查并申请缺少的系统权限
private void requestWebMediaPermission(PermissionRequest request) {
if (isFinishing() || isDestroyed() || mediaPermissionInFlight) {
request.deny();
return;
}
List<String> missingPermissions = new ArrayList<>();
for (String resource : request.getResources()) {
String permission = androidPermissionFor(resource);
if (permission != null
&& Build.VERSION.SDK_INT >= Build.VERSION_CODES.M
&& checkSelfPermission(permission)
!= PackageManager.PERMISSION_GRANTED
&& !missingPermissions.contains(permission)) {
missingPermissions.add(permission);
}
}
pendingMediaRequest = request;
if (missingPermissions.isEmpty()) {
completeWebMediaPermission();
} else {
mediaPermissionInFlight = true;
requestPermissions(
missingPermissions.toArray(new String[0]),
WEB_MEDIA_PERMISSION_REQUEST
);
}
}
// 接收系统授权结果
@Override
public void onRequestPermissionsResult(
int requestCode, String[] permissions, int[] grantResults) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
if (requestCode == WEB_MEDIA_PERMISSION_REQUEST) {
mediaPermissionInFlight = false;
completeWebMediaPermission();
}
}
// 只向 H5 放行网页请求且系统已授权的相机、麦克风资源
private void completeWebMediaPermission() {
PermissionRequest request = pendingMediaRequest;
pendingMediaRequest = null;
if (request == null) {
return; // 网页可能已取消请求
}
List<String> grantedResources = new ArrayList<>();
for (String resource : request.getResources()) {
String permission = androidPermissionFor(resource);
if (permission != null
&& (Build.VERSION.SDK_INT < Build.VERSION_CODES.M
|| checkSelfPermission(permission)
== PackageManager.PERMISSION_GRANTED)) {
grantedResources.add(resource);
}
}
if (grantedResources.isEmpty() || isFinishing() || isDestroyed()) {
request.deny();
} else {
request.grant(grantedResources.toArray(new String[0]));
}
}
// 合并到 Activity 已有的 onDestroy() 中,在销毁 WebView 前执行
@Override
protected void onDestroy() {
if (pendingMediaRequest != null) {
pendingMediaRequest.deny();
pendingMediaRequest = null;
}
super.onDestroy();
}
# IOS解决方案
WebRTC在iOS上,仅支持WKWebView。
需在配置里加上摄像头和麦克风的使用权限。App 的 info.plist 中加入:
text
.NSMicrophoneUsageDescription
.NSCameraUsageDescription
OC语法:
text
WKWebViewConfiguration *configuration = [[WKWebViewConfiguration alloc] init]; // 初始化配置对象
configuration.allowsInlineMediaPlayback = YES; // 默认是NO,这个值决定了用内嵌HTML5播放视频还是用本地的全屏控制,其中NO为使用原生全屏控制器,YES为视频内嵌播放。
// 设置为自动播放, 不需要用户采取任何手势开启播放
if (@available(iOS 10.0, *)) {
configuration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone; //WKAudiovisualMediaTypeNone 音视频的播放不需要用户手势触发,即为自动播放,iOS 10.0+支持
} else {
configuration.requiresUserActionForMediaPlayback = NO;
}
WKWebView *webView = [[WKWebView alloc] initWithFrame:CGRectZero configuration:configuration];
Swift语法
text
let configuration = WKWebViewConfiguration() // 初始化配置对象
configuration.allowsInlineMediaPlayback = true // 默认是false,这个值决定了用内嵌HTML5播放视频还是用本地的全屏控制
// 设置为自动播放,不需要用户采取任何手势开启播放
if #available(iOS 10.0, *) {
configuration.mediaTypesRequiringUserActionForPlayback = [] // WKAudiovisualMediaTypeNone 音视频的播放不需要用户手势触发,即为自动播放,iOS 10.0+支持
} else {
configuration.requiresUserActionForMediaPlayback = false
}
let webView = WKWebView(frame: CGRect.zero, configuration: configuration)
# 鸿蒙解决方案:
1、在module.json5 中声明H5所需权限:
text
"requestPermissions": [
{
"name": "ohos.permission.INTERNET",
"reason": "$string:EntryAbility_permission_internet",
"usedScene": {
"abilities": [
"EntryAbility"
],
"when": "always"
}
},
// camera permisson
{
"name": "ohos.permission.CAMERA",
"reason": "$string:EntryAbility_permission_camera",
"usedScene": {
"abilities": [
"EntryAbility"
],
"when": "always"
}
},
// audio permission
{
"name": "ohos.permission.MICROPHONE",
"reason": "$string:EntryAbility_permission_microphone",
"usedScene": {
"abilities": [
"EntryAbility"
],
"when": "always"
}
}
]
2、创建 WebviewController
text
private controller: webview.WebviewController = new webview.WebviewController();
3、创建 Web 组件
text
Web({ src: this.url, controller: this.controller })
.width('100%')
.height('100%')
.javaScriptAccess(true)
// H5 调用 getUserMedia 时触发,此刻才真正需要摄像头:
// 先确保运行时权限(已授权则直接返回,不会重复弹框),拿到权限再对网页放行
.onPermissionRequest((event) => {
if (!event) {
return;
}
const request = event.request;
const resources = request.getAccessibleResource();
PermissionUtils.requestPermissions(this.getUIContext().getHostContext() as common.UIAbilityContext,
FACE_PERMISSIONS).then((granted: boolean) => {
request.grant(resources);
}).catch((err: BusinessError) => {
console.error(`requestPermissions failed, code: ${err.code}, message: ${err.message}`);
try {
request.deny();
} catch (denyErr) {
console.warn('deny web permission request failed after request error');
}
});
})
# 录制上传类活体(视频读数、静默录制)适配说明
下载demo并根据指引配置。
# Uniapp X接入配置指引
1、注册并创建 uni-app 开发环境。
uni-app 开发接⼊具体参照 uni 官⽹。
2、下载demo并根据指引配置插件。