Interface Capture

This plugin provides access to the device's audio, image, and video capture capabilities.

Index

Properties

Methods

Properties

public supportedAudioModes: ConfigurationData[]

The audio recording formats supported by the device.

public supportedImageModes: ConfigurationData[]

The recording image sizes and formats supported by the device.

public supportedVideoModes: ConfigurationData[]

The recording video resolutions and formats supported by the device.

Methods

public captureAudio(onSuccess: (mediaFiles: MediaFile[]) => void, onError: (error: CaptureError) => void, options?: AudioOptions)

Start the audio recorder application and return information about captured audio clip files.

Parameters

  • onSuccess: (mediaFiles: MediaFile[]) => void

    Executes when the capture operation finishes with an array of MediaFile objects describing each captured audio clip file.

  • onError: (error: CaptureError) => void

    Executes, if the user terminates the operation before an audio clip is captured, with a CaptureError object, featuring the CaptureError.CAPTURE_NO_MEDIA_FILES error code.

  • options?: AudioOptions optional

    Encapsulates audio capture configuration options.

public captureImage(onSuccess: (mediaFiles: MediaFile[]) => void, onError: (error: CaptureError) => void, options?: ImageOptions)

Start the camera application and return information about captured image files.

Parameters

  • onSuccess: (mediaFiles: MediaFile[]) => void

    Executes when the capture operation finishes with an array of MediaFile objects describing each captured image clip file.

  • onError: (error: CaptureError) => void

    Executes, if the user terminates the operation before an audio clip is captured, with a CaptureError object, featuring the CaptureError.CAPTURE_NO_MEDIA_FILES error code.

  • options?: ImageOptions optional

    Encapsulates audio capture configuration options.

public captureVideo(onSuccess: (mediaFiles: MediaFile[]) => void, onError: (error: CaptureError) => void, options?: VideoOptions)

Start the video recorder application and return information about captured video clip files.

Parameters

  • onSuccess: (mediaFiles: MediaFile[]) => void

    Executes when the capture operation finishes with an array of MediaFile objects describing each captured video clip file.

  • onError: (error: CaptureError) => void

    Executes, if the user terminates the operation before an audio clip is captured, with a CaptureError object, featuring the CaptureError.CAPTURE_NO_MEDIA_FILES error code.

  • options?: VideoOptions optional

    Encapsulates audio capture configuration options.