{WebTwainObject}.Addon.Camera
{WebTwainObject} denotes the
WebTwain
instance.Dynamsoft provides a built-in feature to handle camera capturing, prospective adjusting, etc. Check out the APIs showVideo() and closeVideo().
Methods
- getSourceList()
- selectSource()
- getCurrentSource()
- closeSource()
- getResolution()
- setResolution()
- getCurrentResolution()
- play()
- pause()
- resume()
- stop()
- getStatus()
- capture()
getSourceList
Syntax
/**
* Return a list of all available cameras.
*/
getSourceList(): Promise<DeviceInfo[]>;
interface DeviceInfo{
deviceId: string;
label: string;
}
Example
DWObject.Addon.Camera.getSourceList();
selectSource
Syntax
/**
* Select a camera to use.
* @param deviceId Specify the camera with its deviceId.
*/
selectSource(deviceId: string): Promise<DeviceInfo>;
getCurrentSource
Syntax
/**
* Return the info about the current camera.
*/
getCurrentSource():DeviceInfo;
closeSource
Syntax
/**
* Close the current camera.
*/
closeSource(): Promise<DeviceInfo>;
getResolution
Syntax
/**
* Return the resolutions supported by the current camera.
*/
getResolution(): Promise<Resolution[]>
interface Resolution{
width: number;
height: number;
}
setResolution
Syntax
/**
* Set the resolution for the current camera.
* @param resolution Specify the resolution.
*/
setResolution(resolution: Resolution): Promise<Resolution>;
getCurrentResolution
Syntax
/**
* Return the resolution of the current camera.
*/
getCurrentResolution(): Promise<Resolution>;
Usage notes
If the camera is playing, the actual resolution is returned. If the camera is not playing, the last set resolution or null is returned.
play
Syntax
/**
* Start streaming video from the current camera.
* @param element Specify an HTML element to put the video stream in.
* @param resolution Specify the initial resolution.
*/
play(element?: HTMLElement,
resolution?: Resolution
): Promise<Resolution>;
Usage notes
If no camera is chosen, the default camera is used.
If the method is called without arguments or null
is passed to element
, the video will show in the main viewer.
pause
Syntax
/**
* Pause the video stream.
*/
pause(): void;
resume
Syntax
/**
* Resume the video stream.
*/
resume(): void;
stop
Syntax
/**
* Stop the video stream.
*/
stop(): void;
getStatus
Syntax
/**
* Return the status of the current camera.
*/
getStatus(): string;
Usage notes
The status string is either empty or one of the following: “playing”, “paused”, “stopped”. An empty string means no camera is open.
capture
Syntax
/**
* Capture a frame from the video stream.
*/
capture(): Promise<Blob>;