---
layout: default-layout
needAutoGenerateSidebar: true
title: Dynamic Web TWAIN SDK API Reference - Webcam Addon APIs
keywords: Dynamic Web TWAIN, Documentation, API Reference, Webcam Addon APIs
breadcrumbText: Webcam Addon
description: Dynamic Web TWAIN SDK Documentation API Reference Webcam Addon APIs Page
---
# {WebTwainObject}.Addon.Webcam
> {WebTwainObject} denotes the `WebTwain` instance.
The Webcam add-on works on Windows desktop. If you need to scan documents with camera on other platforms (macOS, Linux and mobile) or perform document boundary detection and cropping, you can use [Mobile Document Scanner](https://www.dynamsoft.com/use-cases/mobile-document-scanner/).
**Methods**
| [`CaptureImage()`](#captureimage) | [`CloseSource()`](#closesource) | [`GetCameraControlPropertySetting()`](#getcameracontrolpropertysetting) | [`GetCameraControlPropertyMoreSetting()`](#getcameracontrolpropertymoresetting) |
| [`GetVideoPropertySetting()`](#getvideopropertysetting) | [`GetVideoPropertyMoreSetting()`](#getvideopropertymoresetting) | [`SetCameraControlPropertySetting()`](#setcameracontrolpropertysetting) | [`SetVideoPropertySetting()`](#setvideopropertysetting) |
| [`GetFrameRate()`](#getframerate) | [`SetFrameRate()`](#setframerate) | [`GetMediaType()`](#getmediatype) | [`SetMediaType()`](#setmediatype) |
| [`GetResolution()`](#getresolution) | [`SetResolution()`](#setresolution) | [`GetFramePartURL()`](#getframeparturl) | [`GetFrameURL()`](#getframeurl) |
| [`GetSourceList()`](#getsourcelist) | [`SelectSource()`](#selectsource) | [`PauseVideo()`](#pausevideo) | [`PlayVideo()`](#playvideo) |
| [`SetVideoRotateMode()`](#setvideorotatemode) | [`StopVideo()`](#stopvideo) | | |
## CaptureImage()
Capture an image from the current camera.
**Syntax**
```typescript
CaptureImage(
successCallback: () => void,
failureCallback: (errorCode: number, errorString: string) => void
): void;
```
**Parameters**
`successCallback`: A callback function that is executed if the request succeeds.
`failureCallback`: A callback function that is executed if the request fails.
- `errorCode`: The error code.
- `errorString`: The error String
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v10.2+ |
not supported |
not supported |
not supported |
---
## GetSourceList()
Return a list of all available cameras.
**Syntax**
```typescript
GetSourceList(): string[];
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v10.2+ |
not supported |
not supported |
not supported |
---
## SelectSource()
Select a camera to use.
**Syntax**
```typescript
SelectSource(name: string): boolean;
```
**Parameters**
`name`: Specify the camera.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v10.2+ |
not supported |
not supported |
not supported |
---
## CloseSource()
Close the current camera.
**Syntax**
```typescript
CloseSource(): boolean;
```
**Usage notes**
When you close the camera, the video stream will stop at the last frame.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v10.2+ |
not supported |
not supported |
not supported |
---
## PlayVideo()
Start to play the video stream from the current camera.
**Syntax**
```typescript
PlayVideo(
DWTObject: WebTwain,
quality: number,
frameDidShow?: function () {}
): boolean;
```
**Parameters**
`DWTObject`: Specify a WebTwain instance to show the video.
`quality`: Specify the quality of the video.
`frameDidShow`: A callback function that is triggered after each video frame is shown.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## PauseVideo()
Pause the video.
**Syntax**
```typescript
PauseVideo(): boolean;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## StopVideo()
Stop the video.
**Syntax**
```typescript
StopVideo(): boolean;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
**Usage notes**
When you capture a frame, it's always the actual latest frame from the camera even if you have paused the video.
When you close the camera, the video stream will stop at the last frame.
---
## GetCameraControlPropertySetting()
Return information about the specified camera property. Please refer to [`CameraControlProperty`](/_articles/info/api/interfaces.md#cameracontrolproperty).
**Syntax**
```typescript
GetCameraControlPropertySetting(
property: Dynamsoft.DWT.EnumDWT_CameraControlProperty | number
): CameraControlProperty;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_CameraControlProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_cameracontrolproperty).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetCameraControlPropertyMoreSetting()
Return detailed information about the specified camera property. Please refer to [`CameraControlPropertyExtra`](/_articles/info/api/interfaces.md#cameracontrolpropertyextra).
**Syntax**
```typescript
GetCameraControlPropertyMoreSetting(
property: Dynamsoft.DWT.EnumDWT_CameraControlProperty | number
): CameraControlPropertyExtra;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_CameraControlProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_cameracontrolproperty).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## SetCameraControlPropertySetting()
Set the specified camera property.
**Syntax**
```typescript
SetCameraControlPropertySetting(
property: Dynamsoft.DWT.EnumDWT_CameraControlProperty | number,
value: number,
auto: boolean
): boolean;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_CameraControlProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_cameracontrolproperty).
`value`: Specify the value.
`auto`: Specify whether the property should change automatically.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetVideoPropertySetting()
Return information about the specified video property. Please refer to [`VideoControlProperty`](/_articles/info/api/interfaces.md#videocontrolproperty).
**Syntax**
```typescript
GetVideoPropertySetting(
property: Dynamsoft.DWT.EnumDWT_VideoProperty | number
): VideoControlProperty;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_VideoProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_videoproperty).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetVideoPropertyMoreSetting()
Return detailed information about the specified video property. Please refer to [`VideoControlPropertyExtra`](/_articles/info/api/interfaces.md#videocontrolpropertyextra).
**Syntax**
```typescript
GetVideoPropertyMoreSetting(
property: Dynamsoft.DWT.EnumDWT_VideoProperty | number
): VideoControlPropertyExtra;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_VideoProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_videoproperty).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## SetVideoPropertySetting()
Set the specified video property.
**Syntax**
```typescript
SetVideoPropertySetting(
property: Dynamsoft.DWT.EnumDWT_VideoProperty | number,
value: number,
auto: boolean
): boolean;
```
**Parameters**
`property`: Specify the property. Please refer to [EnumDWT_VideoProperty](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_videoproperty).
`value`: Specify the value.
`auto`: Specify whether the property should change automatically.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetFrameRate()
Return the frame rates supported by the current camera. Please refer to [`FrameRate`](/_articles/info/api/interfaces.md#framerate).
**Syntax**
```typescript
GetFrameRate(): FrameRate;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3.1+ |
not supported |
not supported |
not supported |
---
## GetMediaType()
Return the media types supported by the current camera. Please refer to [`MediaType`](/_articles/info/api/interfaces.md#mediatype).
**Syntax**
```typescript
GetMediaType(): MediaType;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetResolution()
Return the resolutions supported by the current camera. Please refer to [`Resolution`](/_articles/info/api/interfaces.md#resolution).
**Syntax**
```typescript
GetResolution(): Resolution;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## SetFrameRate()
Set the frame rate.
**Syntax**
```typescript
SetFrameRate(rate: number): boolean;
```
**Parameters**
`rate`: Specify the frame rate.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## SetMediaType()
Set the media type.
**Syntax**
```typescript
SetMediaType(type: string): boolean;
```
**Parameters**
`type`: Specify the media type.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## SetResolution()
Set the resolution.
**Syntax**
```typescript
SetResolution(resolution: string): boolean;
```
**Parameters**
`resolution`: Specify the resolution.
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
**Example**
```javascript
DWTObject.Addon.Webcam.SetResolution("640 x 480");
```
---
## SetVideoRotateMode()
Rotate the video.
**Syntax**
```typescript
SetVideoRotateMode(
mode: Dynamsoft.DWT.EnumDWT_VideoRotateMode | number
): boolean;
```
**Parameters**
`mode`: Specify the rotate mode. Please refer to [EnumDWT_VideoRotateMode](/_articles/info/api/Dynamsoft_Enum.md#dynamsoftdwtenumdwt_videorotatemode).
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3+ |
not supported |
not supported |
not supported |
---
## GetFrameURL()
Return the URL (http(s)://) for the latest frame.
**Syntax**
```typescript
GetFrameURL(): string;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3.1+ |
not supported |
not supported |
not supported |
---
## GetFramePartURL()
Return the internal URL (dwt://) for the latest frame.
**Syntax**
```typescript
GetFramePartURL(): string;
```
**Availability**
| H5(Windows) |
H5(macOS/TWAIN) |
H5(macOS/ICA) |
H5(Linux) |
| v14.3.1+ |
not supported |
not supported |
not supported |
**Usage notes**
`GetFrameURL()` returns a public URL that can be used to access the frame directly by any application capable of HTTP requests that runs on the same machine. For example: `https://127.0.0.1:18623/dwt/dwt_16000428/img?id=853407158&index=-1&width=-1&height=-1&webcam=80&t=1590481406860`.
`GetFramePartURL()` returns an internal URL that only Dynamsoft libraries such as the Barcode Reader add-on can read. For example: `dwt://dwt_16000428/img?id=853407158&index=-1&width=-1&height=-1&webcam=80&t=1590481403659`.