зеркало из https://github.com/mozilla/gecko-dev.git
376 строки
13 KiB
Plaintext
376 строки
13 KiB
Plaintext
#include "domstubs.idl"
|
|
|
|
#include "nsIDOMMediaStream.idl"
|
|
#include "nsIDOMDOMRequest.idl"
|
|
|
|
|
|
interface nsIDOMBlob;
|
|
interface nsIDOMDeviceStorage;
|
|
|
|
/* Used to set the dimensions of a captured picture,
|
|
a preview stream, a video capture stream, etc. */
|
|
dictionary CameraSize {
|
|
unsigned long width;
|
|
unsigned long height;
|
|
};
|
|
|
|
/* Camera regions are used to set focus and metering areas;
|
|
the coordinates are referenced to the sensor:
|
|
(-1000, -1000) is the top left corner
|
|
(1000, 1000) is the bottom left corner
|
|
The weight of the region can range from 0 to 1000. */
|
|
dictionary CameraRegion {
|
|
long top;
|
|
long left;
|
|
long bottom;
|
|
long right;
|
|
unsigned long weight;
|
|
};
|
|
|
|
/* The position information to record in the image header.
|
|
'NaN' indicates the information is not available. */
|
|
dictionary CameraPosition {
|
|
double latitude;
|
|
double longitude;
|
|
double altitude;
|
|
double timestamp;
|
|
};
|
|
|
|
[scriptable, uuid(177472c9-f83d-48b5-8782-03b43b27f25d)]
|
|
interface nsICameraCapabilities : nsISupports
|
|
{
|
|
/* an array of objects with 'height' and 'width' properties
|
|
supported for the preview stream */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval previewSizes;
|
|
|
|
/* an array of objects with 'height' and 'width' properties
|
|
supported for picture taking */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval pictureSizes;
|
|
|
|
/* an array of strings, e.g. [ "jpeg", "rgb565" ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval fileFormats;
|
|
|
|
/* an array of strings, e.g. [ "auto", "fluorescent", etc. ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval whiteBalanceModes;
|
|
|
|
/* an array of strings, e.g. [ "auto", "night", "beach", etc. ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval sceneModes;
|
|
|
|
/* an array of strings, e.g. [ "normal", "sepia", "mono", etc. ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval effects;
|
|
|
|
/* an array of strings, e.g. [ "auto", "off", "on", etc. ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval flashModes;
|
|
|
|
/* an array of strings, e.g. [ "auto", "fixed", "macro", etc. ] */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval focusModes;
|
|
|
|
/* the maximum number of focus areas supported by the camera */
|
|
[implicit_jscontext]
|
|
readonly attribute long maxFocusAreas;
|
|
|
|
/* the minimum supported exposure compensation value */
|
|
[implicit_jscontext]
|
|
readonly attribute double minExposureCompensation;
|
|
|
|
/* the maximum supported exposure compensation value */
|
|
[implicit_jscontext]
|
|
readonly attribute double maxExposureCompensation;
|
|
|
|
/* exposure compensation minimum step-size */
|
|
[implicit_jscontext]
|
|
readonly attribute double stepExposureCompensation;
|
|
|
|
/* the maximum number of metering areas supported by the camera */
|
|
[implicit_jscontext]
|
|
readonly attribute long maxMeteringAreas;
|
|
|
|
/* an array of doubles, e.g. [ 1.0, 1.2, 1.5, 2.0, 3.0, etc. ],
|
|
or null if zooming is not supported */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval zoomRatios;
|
|
|
|
/* an array of objects with 'height' and 'width' properties
|
|
supported for video recording */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval videoSizes;
|
|
|
|
/* an object with attributes for each of the supported recorder
|
|
profiles, e.g. recorderProfiles.cif, recorderProfiles.qvga,
|
|
etc. */
|
|
[implicit_jscontext]
|
|
readonly attribute jsval recorderProfiles;
|
|
};
|
|
|
|
/* These properties affect the video recording preview, e.g.
|
|
{
|
|
profile: "1080p",
|
|
rotation: 0
|
|
}
|
|
|
|
'profile' is one of the profiles returned by
|
|
nsICameraCapabilities.recorderProfiles'; if this profile is missing,
|
|
an arbitrary profile will be chosen.
|
|
|
|
'rotation' is the degrees clockwise to rotate the preview; if
|
|
this option is not supported, it will be ignored; if this option
|
|
is missing, the default is 0.
|
|
*/
|
|
dictionary CameraRecorderOptions
|
|
{
|
|
DOMString profile;
|
|
long rotation;
|
|
};
|
|
|
|
/* These properties affect the actual video recording, e.g.
|
|
{
|
|
rotation: 0,
|
|
maxFileSizeBytes: 1024 * 1024,
|
|
maxVideoLengthMs: 0
|
|
}
|
|
|
|
'rotation' is the degrees clockwise to rotate the recorded video; if
|
|
this options is not supported, it will be ignored; if this option is
|
|
missing, the default is 0.
|
|
|
|
'maxFileSizeBytes' is the maximum size in bytes to which the recorded
|
|
video file will be allowed to grow.
|
|
|
|
'maxVideoLengthMs' is the maximum length in milliseconds to which the
|
|
recorded video will be allowed to grow.
|
|
|
|
if either 'maxFileSizeBytes' or 'maxVideoLengthMs' is missing, zero,
|
|
or negative, that limit will be disabled.
|
|
*/
|
|
dictionary CameraStartRecordingOptions
|
|
{
|
|
long rotation;
|
|
long long maxFileSizeBytes;
|
|
long long maxVideoLengthMs;
|
|
};
|
|
|
|
[scriptable, function, uuid(0444a687-4bc9-462c-8246-5423f0fe46a4)]
|
|
interface nsICameraPreviewStreamCallback : nsISupports
|
|
{
|
|
void handleEvent(in nsIDOMMediaStream stream);
|
|
};
|
|
|
|
[scriptable, function, uuid(6baa4ac7-9c25-4c48-9bb0-5193b38b9b0a)]
|
|
interface nsICameraAutoFocusCallback : nsISupports
|
|
{
|
|
void handleEvent(in boolean success);
|
|
};
|
|
|
|
[scriptable, function, uuid(17af779e-cb6f-4ca5-890c-06468ff82e4f)]
|
|
interface nsICameraTakePictureCallback : nsISupports
|
|
{
|
|
void handleEvent(in nsIDOMBlob picture);
|
|
};
|
|
|
|
[scriptable, function, uuid(89a762f8-581b-410a-ad86-e2bd2113ad82)]
|
|
interface nsICameraStartRecordingCallback : nsISupports
|
|
{
|
|
void handleEvent();
|
|
};
|
|
|
|
[scriptable, function, uuid(fb80db71-e315-42f0-9ea9-dd3dd312ed70)]
|
|
interface nsICameraShutterCallback : nsISupports
|
|
{
|
|
void handleEvent();
|
|
};
|
|
|
|
[scriptable, function, uuid(0ef0f01e-ce74-4741-9bba-54376adfb7a2)]
|
|
interface nsICameraClosedCallback : nsISupports
|
|
{
|
|
void handleEvent();
|
|
};
|
|
|
|
[scriptable, function, uuid(550d675a-257d-4713-8b3d-0da53eba68fc)]
|
|
interface nsICameraRecorderStateChange : nsISupports
|
|
{
|
|
void handleStateChange(in DOMString newState);
|
|
};
|
|
|
|
[scriptable, function, uuid(f84d607b-554c-413d-8810-cf848642765a)]
|
|
interface nsICameraReleaseCallback : nsISupports
|
|
{
|
|
void handleEvent();
|
|
};
|
|
|
|
[scriptable, function, uuid(a302c6c9-3776-4d1d-a395-f4105d47c3d3)]
|
|
interface nsICameraErrorCallback : nsISupports
|
|
{
|
|
void handleEvent(in DOMString error);
|
|
};
|
|
|
|
/*
|
|
attributes here affect the preview, any pictures taken, and/or
|
|
any video recorded by the camera.
|
|
*/
|
|
[scriptable, uuid(c8e7418d-8913-4b66-bd9f-562fba627266)]
|
|
interface nsICameraControl : nsISupports
|
|
{
|
|
readonly attribute nsICameraCapabilities capabilities;
|
|
|
|
/* one of the vales chosen from capabilities.effects;
|
|
default is "none" */
|
|
attribute DOMString effect;
|
|
|
|
/* one of the values chosen from capabilities.whiteBalanceModes;
|
|
default is "auto" */
|
|
attribute DOMString whiteBalanceMode;
|
|
|
|
/* one of the valus chosen from capabilities.sceneModes;
|
|
default is "auto" */
|
|
attribute DOMString sceneMode;
|
|
|
|
/* one of the values chosen from capabilities.flashModes;
|
|
default is "auto" */
|
|
attribute DOMString flashMode;
|
|
|
|
/* one of the values chosen from capabilities.focusModes;
|
|
default is "auto", if supported, or "fixed" */
|
|
attribute DOMString focusMode;
|
|
|
|
/* one of the values chosen from capabilities.zoomRatios; other
|
|
values will be rounded to the nearest supported value;
|
|
default is 1.0 */
|
|
attribute double zoom;
|
|
|
|
/* an array of one or more objects that define where the
|
|
camera will perform light metering, each defining the properties:
|
|
{
|
|
top: -1000,
|
|
left: -1000,
|
|
bottom: 1000,
|
|
right: 1000,
|
|
weight: 1000
|
|
}
|
|
|
|
'top', 'left', 'bottom', and 'right' all range from -1000 at
|
|
the top-/leftmost of the sensor to 1000 at the bottom-/rightmost
|
|
of the sensor.
|
|
|
|
objects missing one or more of these properties will be ignored;
|
|
if the array contains more than capabilities.maxMeteringAreas,
|
|
extra areas will be ignored.
|
|
|
|
this attribute can be set to null to allow the camera to determine
|
|
where to perform light metering. */
|
|
[implicit_jscontext]
|
|
attribute jsval meteringAreas;
|
|
|
|
/* an array of one or more objects that define where the camera will
|
|
perform auto-focusing, with the same definition as meteringAreas.
|
|
|
|
if the array contains more than capabilities.maxFocusAreas, extra
|
|
areas will be ignored.
|
|
|
|
this attribute can be set to null to allow the camera to determine
|
|
where to focus. */
|
|
[implicit_jscontext]
|
|
attribute jsval focusAreas;
|
|
|
|
/* focal length in millimetres */
|
|
readonly attribute double focalLength;
|
|
|
|
/* the distances in metres to where the image subject appears to be
|
|
in focus. 'focusDistanceOptimum' is where the subject will appear
|
|
sharpest; the difference between 'focusDistanceFar' and
|
|
'focusDistanceNear' is the image's depth of field.
|
|
|
|
'focusDistanceFar' may be infinity. */
|
|
readonly attribute double focusDistanceNear;
|
|
readonly attribute double focusDistanceOptimum;
|
|
readonly attribute double focusDistanceFar;
|
|
|
|
/* 'compensation' is optional, and if missing, will
|
|
set the camera to use automatic exposure compensation.
|
|
|
|
acceptable values must range from minExposureCompensation
|
|
to maxExposureCompensation in steps of stepExposureCompensation;
|
|
invalid values will be rounded to the nearest valid value. */
|
|
[implicit_jscontext]
|
|
void setExposureCompensation([optional] in jsval compensation);
|
|
readonly attribute double exposureCompensation;
|
|
|
|
/* the function to call on the camera's shutter event, to trigger
|
|
a shutter sound and/or a visual shutter indicator. */
|
|
attribute nsICameraShutterCallback onShutter;
|
|
|
|
/* the function to call when the camera hardware is closed
|
|
by the underlying framework, e.g. when another app makes a more
|
|
recent call to get the camera. */
|
|
attribute nsICameraClosedCallback onClosed;
|
|
|
|
/* the function to call when the recorder changes state, either because
|
|
the recording process encountered an error, or because one of the
|
|
recording limits (see CameraStartRecordingOptions) was reached. */
|
|
attribute nsICameraRecorderStateChange onRecorderStateChange;
|
|
|
|
/* tell the camera to attempt to focus the image */
|
|
void autoFocus(in nsICameraAutoFocusCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
|
|
/* capture an image and return it as a blob to the 'onSuccess' callback;
|
|
if the camera supports it, this may be invoked while the camera is
|
|
already recording video.
|
|
|
|
invoking this function will stop the preview stream, which must be
|
|
manually restarted (e.g. by calling .play() on it). */
|
|
[implicit_jscontext]
|
|
void takePicture(in jsval aOptions, in nsICameraTakePictureCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
|
|
/* get a media stream to be used as a camera viewfinder in video mode;
|
|
'aOptions' is an CameraRecorderOptions object. */
|
|
[implicit_jscontext]
|
|
void getPreviewStreamVideoMode(in jsval aOptions, in nsICameraPreviewStreamCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
|
|
/* start recording video; 'aOptions' is a
|
|
CameraStartRecordingOptions object. */
|
|
[implicit_jscontext]
|
|
void startRecording(in jsval aOptions, in nsIDOMDeviceStorage storageArea, in DOMString filename, in nsICameraStartRecordingCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
|
|
/* stop precording video. */
|
|
void stopRecording();
|
|
|
|
/* get a media stream to be used as a camera viewfinder; the options
|
|
define the desired frame size of the preview, chosen from
|
|
capabilities.previewSizes, e.g.:
|
|
{
|
|
height: 640,
|
|
width: 480,
|
|
}
|
|
*/
|
|
[implicit_jscontext]
|
|
void getPreviewStream(in jsval aOptions, in nsICameraPreviewStreamCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
|
|
/* call in or after the takePicture() onSuccess callback to
|
|
resume the camera preview stream. */
|
|
void resumePreview();
|
|
|
|
/* release the camera so that other applications can use it; you should
|
|
probably call this whenever the camera is not longer in the foreground
|
|
(depending on your usage model).
|
|
|
|
the callbacks are optional, unless you really need to know when
|
|
the hardware is ultimately released.
|
|
|
|
once this is called, the camera control object is to be considered
|
|
defunct; a new instance will need to be created to access the camera. */
|
|
[binaryname(ReleaseHardware)] void release([optional] in nsICameraReleaseCallback onSuccess, [optional] in nsICameraErrorCallback onError);
|
|
};
|
|
|
|
[scriptable, function, uuid(a267afbc-d91c-413a-8de5-0b94aecffa3e)]
|
|
interface nsICameraGetCameraCallback : nsISupports
|
|
{
|
|
void handleEvent(in nsICameraControl camera);
|
|
};
|