6.0.4 • Published 1 month ago

@studiokloek/capacitor-plugin-mediacapture v6.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 month ago

@studiokloek/capacitor-plugin-mediacapture

This capacitor plugin allows iOS applications to capture media from the camera and microphone.

Install

yarn add @studiokloek/capacitor-plugin-mediacapture
npx cap sync

API

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>


requestPermissions(...)

requestPermissions(permissions?: MediaCapturePluginPermissions | undefined) => Promise<PermissionStatus>
ParamType
permissionsMediaCapturePluginPermissions

Returns: Promise<PermissionStatus>


startCameraSession(...)

startCameraSession(options: CameraSessionOptions) => Promise<boolean>
ParamType
optionsCameraSessionOptions

Returns: Promise<boolean>


stopCameraSession()

stopCameraSession() => Promise<boolean>

Returns: Promise<boolean>


showCameraPreview(...)

showCameraPreview(options: CameraPreviewShowOptions) => Promise<boolean>
ParamType
optionsCameraPreviewShowOptions

Returns: Promise<boolean>


hideCameraPreview(...)

hideCameraPreview(options: CameraPreviewHideOptions) => Promise<boolean>
ParamType
optionsCameraPreviewHideOptions

Returns: Promise<boolean>


startCameraRecording(...)

startCameraRecording(options: StartCameraRecordingOptions) => Promise<boolean>
ParamType
optionsStartCameraRecordingOptions

Returns: Promise<boolean>


stopCameraRecording()

stopCameraRecording() => Promise<undefined | CameraRecordingResult>

Returns: Promise<CameraRecordingResult>


grabCameraImage(...)

grabCameraImage(options: GrabCameraImageOptions) => Promise<undefined | GrabCameraImageResult>
ParamType
optionsGrabCameraImageOptions

Returns: Promise<GrabCameraImageResult>


startMicrophoneSession(...)

startMicrophoneSession(options: MicrophoneSessionOptions) => Promise<boolean>
ParamType
optionsMicrophoneSessionOptions

Returns: Promise<boolean>


stopMicrophoneSession()

stopMicrophoneSession() => Promise<boolean>

Returns: Promise<boolean>


startMicrophoneRecording(...)

startMicrophoneRecording(options: StartMicrophoneRecordingOptions) => Promise<boolean>
ParamType
optionsStartMicrophoneRecordingOptions

Returns: Promise<boolean>


stopMicrophoneRecording()

stopMicrophoneRecording() => Promise<undefined | MicrophoneRecordingResult>

Returns: Promise<MicrophoneRecordingResult>


Interfaces

PermissionStatus

PropType
cameraMediaCapturePermissionState
photosMediaCapturePermissionState
microphoneMediaCapturePermissionState

MediaCapturePluginPermissions

PropType
permissionsMediaCapturePermissionType[]

CameraSessionOptions

PropType
audioboolean
videoboolean
photoboolean
presetstring
positionstring
fullFramePhotosboolean

CameraPreviewShowOptions

PropType
frame{ x: number; y: number; width: number; height: number; }
gravitystring
fadeDurationnumber
useDeviceOrientationboolean

CameraPreviewHideOptions

PropType
fadeDurationnumber

StartCameraRecordingOptions

PropType
autoSaveboolean
durationnumber
useDeviceOrientationboolean

CameraRecordingResult

PropType
urlstring

GrabCameraImageResult

PropType
urlstring

GrabCameraImageOptions

PropType
autoSaveboolean
useDeviceOrientationboolean
autoAdjustboolean

MicrophoneSessionOptions

PropType
sampleRatenumber
reuseRecorderboolean
numChannelsnumber

StartMicrophoneRecordingOptions

PropType
durationnumber

MicrophoneRecordingResult

PropType
urlstring

Type Aliases

MediaCapturePermissionState

PermissionState | 'limited'

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

MediaCapturePermissionType

'camera' | 'photos' | 'microphone'

6.0.3

1 month ago

6.0.4

1 month ago

6.0.1

1 year ago

6.0.0

1 year ago

6.0.2

12 months ago

4.0.1

2 years ago

4.0.0

2 years ago

4.0.3

2 years ago

4.0.2

2 years ago

1.0.1

4 years ago