capacitor-camera-custom
v0.0.3
Published
Custom camera plugin with gallery, flash control and custom UI
Readme
capacitor-camera-custom
Custom camera plugin with gallery, flash control and custom UI
Install
npm install capacitor-camera-custom
npx cap syncAPI
requestPermissions()checkPermissions()startCamera(...)stopCamera()takePicture(...)toggleFlash()getFlashStatus()switchCamera()pickFromGallery()- Interfaces
requestPermissions()
requestPermissions() => Promise<PermissionStatus>Solicita permisos de cámara
Returns: Promise<PermissionStatus>
checkPermissions()
checkPermissions() => Promise<PermissionStatus>Verifica el estado de los permisos
Returns: Promise<PermissionStatus>
startCamera(...)
startCamera(options?: CameraStartOptions | undefined) => Promise<{ success: boolean; }>Inicia la vista previa de la cámara en un elemento HTML específico
| Param | Type | Description |
| ------------- | ----------------------------------------------------------------- | ---------------------------------------- |
| options | CameraStartOptions | - Opciones de configuración de la cámara |
Returns: Promise<{ success: boolean; }>
stopCamera()
stopCamera() => Promise<{ success: boolean; }>Detiene la vista previa de la cámara
Returns: Promise<{ success: boolean; }>
takePicture(...)
takePicture(options?: CaptureOptions | undefined) => Promise<CameraResult>Captura una foto de la vista previa actual
| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | CaptureOptions |
Returns: Promise<CameraResult>
toggleFlash()
toggleFlash() => Promise<FlashStatus>Alterna el estado del flash
Returns: Promise<FlashStatus>
getFlashStatus()
getFlashStatus() => Promise<FlashStatus>Obtiene el estado actual del flash
Returns: Promise<FlashStatus>
switchCamera()
switchCamera() => Promise<{ success: boolean; camera: 'front' | 'back'; }>Cambia entre cámara frontal y trasera
Returns: Promise<{ success: boolean; camera: 'front' | 'back'; }>
pickFromGallery()
pickFromGallery() => Promise<CameraResult>Abre la galería para seleccionar una imagen
Returns: Promise<CameraResult>
Interfaces
PermissionStatus
| Prop | Type | Description |
| ------------ | ---------------------------------------------- | ----------------------------------- |
| camera | 'granted' | 'denied' | 'prompt' | Estado del permiso de cámara |
| photos | 'granted' | 'denied' | 'prompt' | Estado del permiso de galería/fotos |
CameraStartOptions
| Prop | Type | Description | Default |
| --------------------- | ------------------------------ | ----------------------------------------------------------- | ------------------- |
| containerId | string | ID del elemento HTML donde se mostrará la cámara (solo web) | |
| cameraDirection | 'front' | 'back' | Cámara a usar inicialmente | 'back' |
| width | number | Ancho del preview | |
| height | number | Alto del preview | |
CameraResult
| Prop | Type | Description |
| ------------------ | -------------------- | ---------------------------------------- |
| image | string | Datos de la imagen en base64 |
| format | string | Formato de la imagen |
| flashEnabled | boolean | Si el flash estaba encendido al capturar |
CaptureOptions
| Prop | Type | Description | Default |
| --------------- | ------------------- | ---------------------------- | --------------- |
| quality | number | Calidad de la imagen (0-100) | 90 |
| maxWidth | number | Ancho máximo de la imagen | |
| maxHeight | number | Alto máximo de la imagen | |
FlashStatus
| Prop | Type | Description |
| --------------- | -------------------- | --------------------------- |
| available | boolean | Si el flash está disponible |
| enabled | boolean | Si el flash está encendido |
