Package-level declarations

Types

open class ImageCapture(videoTrack: MediaStreamTrack)

The ImageCapture interface of the MediaStream Image Capture API provides methods to enable the capture of images or photos from a camera or other photographic device. Available only in secure contexts.

MediaSettingsRange

interface MediaSettingsRange

PhotoCapabilities

interface PhotoCapabilities

PhotoSettings

interface PhotoSettings

RedEyeReduction

sealed interface RedEyeReduction

Properties

always

val RedEyeReduction.Companion.always: RedEyeReduction

auto

val FillLightMode.Companion.auto: FillLightMode

controllable

val RedEyeReduction.Companion.controllable: RedEyeReduction

flash

val FillLightMode.Companion.flash: FillLightMode

never

val RedEyeReduction.Companion.never: RedEyeReduction

off

val FillLightMode.Companion.off: FillLightMode

Functions

getPhotoCapabilities

inline suspend fun ImageCapture.getPhotoCapabilities(): PhotoCapabilities

The getPhotoCapabilities() method of the ImageCapture interface returns a Promise that resolves with an object containing the ranges of available configuration options.

getPhotoSettings

inline suspend fun ImageCapture.getPhotoSettings(): PhotoSettings

The getPhotoSettings() method of the ImageCapture interface returns a Promise that resolves with an object containing the current photo configuration settings.

grabFrame

inline suspend fun ImageCapture.grabFrame(): ImageBitmap

The grabFrame() method of the ImageCapture interface takes a snapshot of the live video in a MediaStreamTrack and returns a Promise that resolves with a ImageBitmap containing the snapshot.

takePhoto

inline suspend fun ImageCapture.takePhoto(): Blob

inline suspend fun ImageCapture.takePhoto(photoSettings: PhotoSettings): Blob

The takePhoto() method of the ImageCapture interface takes a single exposure using the video capture device sourcing a MediaStreamTrack and returns a Promise that resolves with a Blob containing the data.