This capacitor plugin allows iOS applications to capture media from the camera and microphone.
npm install @studiokloek/capacitor-plugin-mediacapture
npx cap synccheckPermissions()requestPermissions(...)startCameraSession(...)stopCameraSession()showCameraPreview(...)hideCameraPreview(...)startCameraRecording(...)stopCameraRecording()grabCameraImage(...)startMicrophoneSession(...)stopMicrophoneSession()startMicrophoneRecording(...)stopMicrophoneRecording()- Interfaces
- Type Aliases
checkPermissions() => Promise<PermissionStatus>Returns: Promise<PermissionStatus>
requestPermissions(permissions?: MediaCapturePluginPermissions | undefined) => Promise<PermissionStatus>| Param | Type |
|---|---|
permissions |
MediaCapturePluginPermissions |
Returns: Promise<PermissionStatus>
startCameraSession(options: CameraSessionOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
CameraSessionOptions |
Returns: Promise<boolean>
stopCameraSession() => Promise<boolean>Returns: Promise<boolean>
showCameraPreview(options: CameraPreviewShowOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
CameraPreviewShowOptions |
Returns: Promise<boolean>
hideCameraPreview(options: CameraPreviewHideOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
CameraPreviewHideOptions |
Returns: Promise<boolean>
startCameraRecording(options: StartCameraRecordingOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
StartCameraRecordingOptions |
Returns: Promise<boolean>
stopCameraRecording() => Promise<undefined | CameraRecordingResult>Returns: Promise<CameraRecordingResult>
grabCameraImage(options: GrabCameraImageOptions) => Promise<undefined | GrabCameraImageResult>| Param | Type |
|---|---|
options |
GrabCameraImageOptions |
Returns: Promise<GrabCameraImageResult>
startMicrophoneSession(options: MicrophoneSessionOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
MicrophoneSessionOptions |
Returns: Promise<boolean>
stopMicrophoneSession() => Promise<boolean>Returns: Promise<boolean>
startMicrophoneRecording(options: StartMicrophoneRecordingOptions) => Promise<boolean>| Param | Type |
|---|---|
options |
StartMicrophoneRecordingOptions |
Returns: Promise<boolean>
stopMicrophoneRecording() => Promise<undefined | MicrophoneRecordingResult>Returns: Promise<MicrophoneRecordingResult>
| Prop | Type |
|---|---|
camera |
MediaCapturePermissionState |
photos |
MediaCapturePermissionState |
microphone |
MediaCapturePermissionState |
| Prop | Type |
|---|---|
permissions |
MediaCapturePermissionType[] |
| Prop | Type |
|---|---|
video |
boolean |
audio |
boolean |
preset |
string |
position |
string |
fullFramePhotos |
boolean |
| Prop | Type |
|---|---|
frame |
{ x: number; y: number; width: number; height: number; } |
useDeviceOrientation |
boolean |
gravity |
string |
fadeDuration |
number |
| Prop | Type |
|---|---|
fadeDuration |
number |
| Prop | Type |
|---|---|
autoSave |
boolean |
useDeviceOrientation |
boolean |
duration |
number |
| Prop | Type |
|---|---|
url |
string |
| Prop | Type |
|---|---|
url |
string |
| Prop | Type |
|---|---|
autoSave |
boolean |
autoOrientation |
boolean |
autoAdjust |
boolean |
| Prop | Type |
|---|---|
sampleRate |
number |
reuseRecorder |
boolean |
numChannels |
number |
| Prop | Type |
|---|---|
duration |
number |
| Prop | Type |
|---|---|
url |
string |
PermissionState | 'limited'
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
'camera' | 'photos' | 'microphone'