kaios-types
    Preparing search index...

    Interface CameraControl

    Controls the camera device. Maps to nsDOMCameraControl.

    interface CameraControl {
        active: boolean;
        capabilities: CameraCapabilities;
        effect: string;
        exposureCompensation: number;
        flashMode: string;
        focalLength: number;
        focusDistanceFar: number;
        focusDistanceNear: number;
        focusDistanceOptimum: number;
        focusMode: string;
        id: string;
        isoMode: string;
        meteringMode: string;
        onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null;
        onclose: EventHandler;
        onconfigurationchange: EventHandler;
        onfacesdetected: EventHandler;
        onfocus: EventHandler;
        onpicture: EventHandler;
        onposter: EventHandler;
        onpreviewstatechange: EventHandler;
        onrecorderstatechange: EventHandler;
        onremovetrack:
            | ((this: MediaStream, ev: MediaStreamTrackEvent) => any)
            | null;
        onshutter: EventHandler;
        pictureQuality: number;
        sceneMode: string;
        sensorAngle: number;
        whiteBalanceMode: string;
        zoom: number;
        addEventListener<K extends keyof MediaStreamEventMap>(
            type: K,
            listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addTrack(track: MediaStreamTrack): void;
        autoFocus(): Promise<boolean>;
        clone(): MediaStream;
        dispatchEvent(event: Event): boolean;
        getAudioTracks(): MediaStreamTrack[];
        getFocusAreas(): CameraRegion[];
        getMeteringAreas(): CameraRegion[];
        getPictureSize(): CameraSize;
        getThumbnailSize(): CameraSize;
        getTrackById(trackId: string): MediaStreamTrack | null;
        getTracks(): MediaStreamTrack[];
        getVideoTracks(): MediaStreamTrack[];
        pauseRecording(): void;
        release(): Promise<void>;
        removeEventListener<K extends keyof MediaStreamEventMap>(
            type: K,
            listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeTrack(track: MediaStreamTrack): void;
        resumeContinuousFocus(): void;
        resumePreview(): void;
        resumeRecording(): void;
        setConfiguration(
            configuration?: CameraConfiguration,
        ): Promise<CameraConfiguration>;
        setFocusAreas(focusAreas?: CameraRegion[]): void;
        setMeteringAreas(meteringAreas?: CameraRegion[]): void;
        setPictureSize(size?: CameraSize): void;
        setThumbnailSize(size?: CameraSize): void;
        startFaceDetection(): void;
        startRecording(
            options: CameraStartRecordingOptions,
            storageArea: DeviceStorage,
            filename: string,
        ): Promise<void>;
        stopFaceDetection(): void;
        stopRecording(): void;
        takePicture(options?: CameraPictureOptions): Promise<Blob>;
    }

    Hierarchy

    • MediaStream
      • CameraControl
    Index

    Properties

    active capabilities effect exposureCompensation flashMode focalLength focusDistanceFar focusDistanceNear focusDistanceOptimum focusMode id isoMode meteringMode onaddtrack onclose onconfigurationchange onfacesdetected onfocus onpicture onposter onpreviewstatechange onrecorderstatechange onremovetrack onshutter pictureQuality sceneMode sensorAngle whiteBalanceMode zoom

    Methods

    addEventListener addTrack autoFocus clone dispatchEvent getAudioTracks getFocusAreas getMeteringAreas getPictureSize getThumbnailSize getTrackById getTracks getVideoTracks pauseRecording release removeEventListener removeTrack resumeContinuousFocus resumePreview resumeRecording setConfiguration setFocusAreas setMeteringAreas setPictureSize setThumbnailSize startFaceDetection startRecording stopFaceDetection stopRecording takePicture

    Properties

    active: boolean

    The active read-only property of the true if the stream is currently active; otherwise, it returns false.

    MDN Reference

    capabilities: CameraCapabilities

    Capabilities of the camera.

    effect: string

    Current effect applied to the camera preview/capture.

    NS_ERROR_NOT_AVAILABLE

    exposureCompensation: number

    Exposure compensation index.

    NS_ERROR_NOT_AVAILABLE

    flashMode: string

    Current flash mode.

    NS_ERROR_NOT_AVAILABLE

    focalLength: number

    Focal length in millimeters.

    NS_ERROR_NOT_AVAILABLE

    focusDistanceFar: number

    Maximum focus distance in meters.

    NS_ERROR_NOT_AVAILABLE

    focusDistanceNear: number

    Minimum focus distance in meters.

    NS_ERROR_NOT_AVAILABLE

    focusDistanceOptimum: number

    Optimum focus distance in meters.

    NS_ERROR_NOT_AVAILABLE

    focusMode: string

    Current focus mode.

    NS_ERROR_NOT_AVAILABLE

    id: string

    The id read-only property of the MediaStream interface is a string containing 36 characters denoting a unique identifier (GUID) for the object.

    MDN Reference

    isoMode: string

    ISO sensitivity mode.

    NS_ERROR_NOT_AVAILABLE

    meteringMode: string

    Metering mode.

    NS_ERROR_NOT_AVAILABLE

    onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null

    MDN Reference

    onclose: EventHandler

    Event handler for camera close events.

    onconfigurationchange: EventHandler

    Event handler for configuration changes.

    onfacesdetected: EventHandler

    Event handler for face detection events.

    camera.control.face_detection.enabled

    onfocus: EventHandler

    Event handler for focus events.

    onpicture: EventHandler

    Event handler for picture events.

    onposter: EventHandler

    Event handler for poster creation events.

    onpreviewstatechange: EventHandler

    Event handler for preview state changes.

    onrecorderstatechange: EventHandler

    Event handler for recorder state changes.

    onremovetrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null

    MDN Reference

    onshutter: EventHandler

    Event handler for shutter events.

    pictureQuality: number

    Picture quality setting.

    NS_ERROR_NOT_AVAILABLE

    sceneMode: string

    Current scene mode.

    NS_ERROR_NOT_AVAILABLE

    sensorAngle: number

    Orientation of the sensor relative to the device.

    whiteBalanceMode: string

    Current white balance mode.

    NS_ERROR_NOT_AVAILABLE

    zoom: number

    Current zoom level.

    NS_ERROR_NOT_AVAILABLE

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Type Parameters

      • K extends keyof MediaStreamEventMap

      Parameters

      • type: K
      • listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addTrack() method of the MediaStream interface adds a new track to the stream.

      MDN Reference

      Parameters

      • track: MediaStreamTrack

      Returns void

    • Triggers auto-focus.

      Returns Promise<boolean>

      Promise resolving to boolean indicating success/failure of focus.

      NS_ERROR_NOT_AVAILABLE

    • The clone() method of the MediaStream interface creates a duplicate of the MediaStream.

      MDN Reference

      Returns MediaStream

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The getAudioTracks() method of the stream's track set where MediaStreamTrack.kind is audio.

      MDN Reference

      Returns MediaStreamTrack[]

    • The getTrackById() method of the MediaStream interface returns a MediaStreamTrack object representing the track with the specified ID string.

      MDN Reference

      Parameters

      • trackId: string

      Returns MediaStreamTrack | null

    • The getTracks() method of the stream's track set, regardless of MediaStreamTrack.kind.

      MDN Reference

      Returns MediaStreamTrack[]

    • The getVideoTracks() method of the js-nolint getVideoTracks() None.

      MDN Reference

      Returns MediaStreamTrack[]

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Type Parameters

      • K extends keyof MediaStreamEventMap

      Parameters

      • type: K
      • listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeTrack() method of the MediaStream interface removes a js-nolint removeTrack(track) - track - : A MediaStreamTrack that will be removed from the stream.

      MDN Reference

      Parameters

      • track: MediaStreamTrack

      Returns void

    • Starts face detection.

      Returns void

      NS_ERROR_NOT_AVAILABLE

      camera.control.face_detection.enabled

    • Stops face detection.

      Returns void

      NS_ERROR_NOT_AVAILABLE

      camera.control.face_detection.enabled

    Settings

    Member Visibility

    On This Page

    Properties
    Methods