@capgo/camera-preview

概述

CameraPreview插件的主界面。

核心功能

• start - 启动相机预览。
• stop - 停止相机预览。
• capture - 从相机中捕获一张照片。
• captureSample - 从相机预览流中捕获一帧。

公共API

方法	描述
start	启动相机预览。
stop	停止相机预览。
capture	从相机中捕获照片。
captureSample	从相机预览流中捕获单个帧。
getSupportedFlashModes	获取当前激活相机支持的闪光模式。
setAspectRatio	设置相机预览的比例。
getAspectRatio	获取当前相机预览的比例。
setGridMode	设置相机预览覆盖层的网格模式。
getGridMode	获取当前相机预览覆盖层的网格模式。
checkPermissions	检查当前相机（可选微型机）权限状态，无提示系统对话框。
requestPermissions	请求相机（可选微型机）权限。如果权限已被授予或拒绝，则返回当前状态，无提示。 showSettingsAlert 当为真且权限被拒绝时，会显示一个平台特定的提示，指导用户到应用设置。
getHorizontalFov	获取当前激活相机的水平视野。注意：在某些设备上，这可能是一个估计值。
getSupportedPictureSizes	获取所有相机支持的图片尺寸。
setFlashMode	设置当前激活相机的闪光模式。
flip	切换前置和后置相机。
setOpacity	设置相机预览的不透明度。
stopRecordVideo	停止正在进行的视频录制。
startRecordVideo	开始录制视频。
isRunning	检查相机预览是否正在运行。
getAvailableDevices	获取所有可用的相机设备。
getZoom	获取当前的缩放状态，包括最小值/最大值和当前镜头信息。
getZoomButtonValues	返回缩放按钮值以快速切换。- iOS/Android：包括 0.5 如果超广角可用；1 和 2 如果宽角可用；3 如果望远镜可用 - Web：不支持。
setZoom	设置相机的缩放级别。
getFlashMode	获取当前闪光模式。
removeAllListeners	移除所有已注册的监听器。
setDeviceId	切换到具有指定的 deviceId.
getDeviceId	获取当前绑定的摄像头设备ID。 在 Android 上，如果物理镜头请求降级到逻辑摄像头，这将返回绑定的逻辑摄像头 ID。
getPreviewSize	获取当前预览大小和位置。
setPreviewSize	设置预览大小和位置。
setFocus	将预览区域的焦点设置到特定点。
addListener	添加屏幕大小变化事件的监听器。
addListener	添加方向变化事件的监听器。
deleteFile	删除设备上的给定绝对路径下的文件。 使用此方法快速清理使用 storeToFile获取设备的安全区域内边距。 返回方向感知的 notch/camera cutout 内边距和当前方向。 在竖屏模式下：返回顶部内边距（顶部 notch）。 在横屏模式下：返回左侧内边距（ notch 移动到侧面）。 这具体针对所有现代手机的 cutout 区域（ notch、punch hole 等）。
getSafeAreaInsets	删除设备上的给定绝对路径下的文件。 使用此方法快速清理使用__CAPGO_KEEP_0__创建的临时图片。 在 web 上，这项功能不受支持并将抛出异常。
getOrientation	获取当前设备方向的跨平台格式。
getExposureModes	返回当前激活相机支持的曝光模式。模式可以包括：‘锁定’，‘自动’，‘连续’，‘自定义’。
getExposureMode	返回当前的曝光模式。
setExposureMode	设置曝光模式。
getExposureCompensationRange	返回曝光补偿（EV偏差）支持范围。
getExposureCompensation	返回当前的曝光补偿（EV偏差）。
setExposureCompensation	设置曝光补偿（EV偏差）。值将被限制在范围内。
getPluginVersion	获取本地Capacitor插件版本。

真实来源

此参考资料是从 src/definitions.ts 在 capacitor-相机预览.

继续从@capgo/相机预览

如果您正在使用 @capgo/相机预览 来规划原生媒体和界面行为，连接它与 使用@capgo/相机预览 为原生能力在使用@capgo/相机预览, 使用@capgo/capacitor-直播活动 为原生能力在使用@capgo/capacitor-直播活动, @capgo/capacitor-直播活动 为@capgo/capacitor-直播活动的实现细节, 使用 @capgo/capacitor-video-player 为原生能力在使用 @capgo/capacitor-video-player, 和 @capgo/capacitor-video-player 为实现细节在 @capgo/capacitor-video-player。