API.md

Modules

CameraApi

Classes

Aperture

ApiError ⇐ ApiIdentifier

ApiIdentifier

Camera

CameraBrowser

CameraFile

CameraProperty

Directory

ExposureCompensation

FileFormat

Flag

ImageQuality

ISOSensitivity

LiveViewImage

ObjectEvent ⇐ ApiIdentifier

Option

Flag

ShutterSpeed

StateEvent ⇐ ApiIdentifier

TimeZone

Volume

Constants

watchCameras ⇒ function

Watch for camera events

cameraBrowser : CameraBrowser

Global CameraBrowser instance

Typedefs

EventCallback : function

CameraPropertyValue : string | number | Array.<number> | PropertyValue

Interfaces

CameraDeviceEvent

PropertyChangeEvent ⇐ CameraDeviceEvent

FileChangeEvent ⇐ CameraDeviceEvent

DirectoryChangeEvent ⇐ CameraDeviceEvent

VolumeChangeEvent ⇐ CameraDeviceEvent

ObjectChangeEvent ⇐ CameraDeviceEvent

StateChangeEvent ⇐ CameraDeviceEvent

PropertyValue

MatchablePropertyValue

PropertyDateTime ⇐ PropertyValue

PropertyStyleDescription ⇐ PropertyValue

DirectoryEntry

ImageQualityProperties

CameraApi

CameraDeviceEvent

Kind: global interface
Properties

Name	Type
camera	Camera

PropertyChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
property	CameraProperty

FileChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
file	CameraFile

DirectoryChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
file	CameraFile

VolumeChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
file	CameraFile

ObjectChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
objectEvent	ObjectEvent

StateChangeEvent ⇐ CameraDeviceEvent

Kind: global interface
Extends: CameraDeviceEvent
Properties

Name	Type
camera	Camera
stateEvent	StateEvent

PropertyValue

Kind: global interface

MatchablePropertyValue

Kind: global interface

• MatchablePropertyValue
  • .findNearest(needle)
  • .findNearestFilter ⇒ boolean

matchablePropertyValue.findNearest(needle)

Kind: instance method of MatchablePropertyValue

Param	Type
needle	string | number
	MatchablePropertyValue~findNearestFilter

matchablePropertyValue.findNearestFilter ⇒ boolean

Kind: instance typedef of MatchablePropertyValue
Returns: boolean - isAllowed

Param	Type
value	MatchablePropertyValue

PropertyDateTime ⇐ PropertyValue

Kind: global interface
Extends: PropertyValue
Properties

Name	Type
year	number
month	number
day	number
hour	number
minute	number
seconds	number
milliseconds	number

PropertyStyleDescription ⇐ PropertyValue

Kind: global interface
Extends: PropertyValue
Properties

Name	Type
contrast	number
sharpness	number
saturation	number
colorTone	number
filterEffect	number
toningEffect	number
sharpFineness	number
sharpThreshold	number

DirectoryEntry

Kind: global interface
Properties

Name	Type
name	string

ImageQualityProperties

Kind: global interface
Properties

Name	Type
format	number
size	number
quality	number

Aperture

Kind: global class
Implements: PropertyValue

• Aperture
  • new Aperture(value_)
  • instance
    • .label : string
    • .value : number
    • .aperture : number
    • .stop : number
    • .toJSON() ⇒ Object
  • static
    • .ID : enum
    • .OneHalfValues : enum
    • .OneThirdValues : enum
    • .forLabel(label) ⇒ Aperture | null

new Aperture(value_)

Aperture property value

Param	Type
value_	number

aperture.label : string

Kind: instance property of Aperture
Read only: true

aperture.value : number

Kind: instance property of Aperture
Read only: true

aperture.aperture : number

Kind: instance property of Aperture
Read only: true

aperture.stop : number

Kind: instance property of Aperture
Read only: true

aperture.toJSON() ⇒ Object

Kind: instance method of Aperture

Aperture.ID : enum

Kind: static enum of Aperture
Read only: true
Properties

Name	Type	Default
Auto	number	0
NotValid	number	4294967295

Aperture.OneHalfValues : enum

Kind: static enum of Aperture
Read only: true
Properties

Name	Type	Default
8	number	1
11	number	1.1
12	number	1.2
16	number	1.4
19	number	1.6
20	number	1.8
24	number	2
27	number	2.2
28	number	2.5
32	number	2.8
35	number	3.2
36	number	3.5
40	number	4
43	number	4.5
44	number	4.5
45	number	5
48	number	5.6
51	number	6.3
52	number	6.7
53	number	7.1
56	number	8
59	number	9
60	number	9.5
61	number	10
64	number	11
68	number	13
69	number	14
72	number	16
75	number	18
76	number	19
77	number	20
80	number	22
83	number	25
84	number	27
85	number	29
88	number	32
91	number	36
92	number	38
93	number	40
96	number	45
99	number	51
100	number	54
101	number	57
104	number	64
107	number	72
108	number	76
109	number	80
112	number	91
133	number	3.4

Aperture.OneThirdValues : enum

Kind: static enum of Aperture
Read only: true
Properties

Name	Type	Default
13	number	1.2
21	number	1.8
29	number	2.5
37	number	3.5
67	number	13

Aperture.forLabel(label) ⇒ Aperture | null

Create instance for label.

Kind: static method of Aperture

Param	Type
label	string

ApiError ⇐ ApiIdentifier

Kind: global class
Extends: ApiIdentifier

• ApiError ⇐ ApiIdentifier
  • new ApiError()
  • instance
    • .label : string
    • .identifier : number
    • .equalTo(other) ⇒ boolean
    • .Symbol_toPrimitive(hint) ⇒ string | number | null
    • .toJSON() ⇒ Object
  • static
    • .Code : enum

new ApiError()

An internal class that will be added to Exceptions as "EDS_ERROR" property.

Example

try {
} catch (e) {
  if ("EDS_ERROR" in e && e.EDS_ERROR.equalTo(ApiError.Code.DEVICE_BUSY)) {
  }
}

apiError.label : string

Kind: instance property of ApiError
Read only: true

apiError.identifier : number

Kind: instance property of ApiError
Read only: true

apiError.equalTo(other) ⇒ boolean

Kind: instance method of ApiError
Overrides: equalTo

Param	Type	Description
other	number | ApiError	The other value

apiError.Symbol_toPrimitive(hint) ⇒ string | number | null

Allows type cast to number and string. The string will be a hexadecimal code representation of the number

Kind: instance method of ApiError

Param	Type
hint	string

apiError.toJSON() ⇒ Object

Kind: instance method of ApiError

ApiError.Code : enum

Kind: static enum of ApiError
Read only: true
Properties

Name	Type	Default
CANNOT_MAKE_OBJECT	number	41220
CAPTURE_ALREADY_TERMINATED	number	8216
COMM_BUFFER_FULL	number	195
COMM_DEVICE_INCOMPATIBLE	number	194
COMM_DISCONNECTED	number	193
COMM_PORT_IS_IN_USE	number	192
COMM_USB_BUS_ERR	number	196
DEVICEPROP_NOT_SUPPORTED	number	8202
DEVICE_BUSY	number	129
DEVICE_CF_GATE_CHANGED	number	137
DEVICE_DIAL_CHANGED	number	138
DEVICE_DISK_ERROR	number	136
DEVICE_EMERGENCY	number	131
DEVICE_INTERNAL_ERROR	number	133
DEVICE_INVALID	number	130
DEVICE_INVALID_PARAMETER	number	134
DEVICE_MEMORY_FULL	number	132
DEVICE_NOT_FOUND	number	128
DEVICE_NOT_INSTALLED	number	139
DEVICE_NOT_LAUNCHED	number	228
DEVICE_NOT_RELEASED	number	141
DEVICE_NO_DISK	number	135
DEVICE_STAY_AWAKE	number	140
DIR_ENTRY_EXISTS	number	67
DIR_ENTRY_NOT_FOUND	number	66
DIR_IO_ERROR	number	65
DIR_NOT_EMPTY	number	68
DIR_NOT_FOUND	number	64
ENUM_NA	number	240
FILE_ALREADY_EXISTS	number	43
FILE_CLOSE_ERROR	number	36
FILE_DATA_CORRUPT	number	45
FILE_DISK_FULL_ERROR	number	42
FILE_FORMAT_UNRECOGNIZED	number	44
FILE_IO_ERROR	number	32
FILE_NAMING_NA	number	46
FILE_NOT_FOUND	number	34
FILE_OPEN_ERROR	number	35
FILE_PERMISSION_ERROR	number	41
FILE_READ_ERROR	number	39
FILE_SEEK_ERROR	number	37
FILE_TELL_ERROR	number	38
FILE_TOO_MANY_OPEN	number	33
FILE_WRITE_ERROR	number	40
HANDLE_NOT_FOUND	number	242
INCOMPATIBLE_VERSION	number	6
INCOMPLETE_TRANSFER	number	8199
INTERNAL_ERROR	number	2
INVALID_CODE_FORMAT	number	8214
INVALID_DEVICEPROP_FORMAT	number	8219
INVALID_DEVICEPROP_VALUE	number	8220
INVALID_FN_CALL	number	241
INVALID_FN_POINTER	number	101
INVALID_HANDLE	number	97
INVALID_ID	number	243
INVALID_INDEX	number	99
INVALID_LENGTH	number	100
INVALID_OBJECTFORMATCODE	number	8203
INVALID_PARAMETER	number	96
INVALID_PARENTOBJECT	number	8218
INVALID_POINTER	number	98
INVALID_SORT_FN	number	102
INVALID_STRAGEID	number	8200
INVALID_TRANSACTIONID	number	8196
LENS_COVER_CLOSE	number	40966
LOW_BATTERY	number	41217
MEMORYSTATUS_NOTREADY	number	41222
MEM_ALLOC_FAILED	number	3
MEM_FREE_FAILED	number	4
MISSING_SUBCOMPONENT	number	10
NOT_CAMERA_SUPPORT_SDK_VERSION	number	8225
NOT_SUPPORTED	number	7
NO_VALID_OBJECTINFO	number	8213
OBJECT_NOTREADY	number	41218
OPERATION_CANCELLED	number	5
OPERATION_REFUSED	number	40965
PARTIAL_DELETION	number	8210
PROPERTIES_MISMATCH	number	81
PROPERTIES_NOT_LOADED	number	83
PROPERTIES_UNAVAILABLE	number	80
PROTECTION_VIOLATION	number	9
PTP_DEVICE_BUSY	number	8217
SELECTION_UNAVAILABLE	number	11
SELF_TEST_FAILED	number	8209
SESSION_ALREADY_OPEN	number	8222
SESSION_NOT_OPEN	number	8195
SPECIFICATION_BY_FORMAT_UNSUPPORTED	number	8212
SPECIFICATION_OF_DESTINATION_UNSUPPORTED	number	8224
STI_DEVICE_CREATE_ERROR	number	226
STI_DEVICE_RELEASE_ERROR	number	227
STI_INTERNAL_ERROR	number	225
STI_UNKNOWN_ERROR	number	224
STREAM_ALREADY_OPEN	number	162
STREAM_BAD_OPTIONS	number	171
STREAM_CLOSE_ERROR	number	164
STREAM_COULDNT_BEGIN_THREAD	number	170
STREAM_END_OF_STREAM	number	172
STREAM_IO_ERROR	number	160
STREAM_NOT_OPEN	number	161
STREAM_OPEN_ERROR	number	163
STREAM_PERMISSION_ERROR	number	169
STREAM_READ_ERROR	number	167
STREAM_SEEK_ERROR	number	165
STREAM_TELL_ERROR	number	166
STREAM_WRITE_ERROR	number	168
TAKE_PICTURE_AF_NG	number	36097
TAKE_PICTURE_CARD_NG	number	36103
TAKE_PICTURE_CARD_PROTECT_NG	number	36104
TAKE_PICTURE_LV_REL_PROHIBIT_MODE_NG	number	36109
TAKE_PICTURE_MIRROR_UP_NG	number	36099
TAKE_PICTURE_MOVIE_CROP_NG	number	36105
TAKE_PICTURE_NO_CARD_NG	number	36102
TAKE_PICTURE_NO_LENS_NG	number	36107
TAKE_PICTURE_RESERVED	number	36098
TAKE_PICTURE_SENSOR_CLEANING_NG	number	36100
TAKE_PICTURE_SILENCE_NG	number	36101
TAKE_PICTURE_SPECIAL_MOVIE_MODE_NG	number	36108
TAKE_PICTURE_STROBO_CHARGE_NG	number	36106
TRANSACTION_CANCELLED	number	8223
UNEXPECTED_EXCEPTION	number	8
UNIMPLEMENTED	number	1
UNKNOWN_COMMAND	number	40961
UNKNOWN_VENDOR_CODE	number	8215
USB_DEVICE_LOCK_ERROR	number	208
USB_DEVICE_UNLOCK_ERROR	number	209
WAIT_TIMEOUT_ERROR	number	244

ApiIdentifier

Kind: global class
Access: protected

• ApiIdentifier
  • new ApiIdentifier(identifier_, labels)
  • .label : string
  • .identifier : number
  • .Symbol_toPrimitive(hint) ⇒ string | number | null
  • .equalTo(other) ⇒ boolean
  • .toJSON() ⇒ Object

new ApiIdentifier(identifier_, labels)

Superclass for identifier wrappers. Provides the identifiers as class constants and string representations.

Param	Type
identifier_	number
labels	Object.<number>

apiIdentifier.label : string

Kind: instance property of ApiIdentifier
Read only: true

apiIdentifier.identifier : number

Kind: instance property of ApiIdentifier
Read only: true

apiIdentifier.Symbol_toPrimitive(hint) ⇒ string | number | null

Allows type cast to number and string. The string will be a hexadecimal code representation of the number

Kind: instance method of ApiIdentifier

Param	Type
hint	string

apiIdentifier.equalTo(other) ⇒ boolean

Kind: instance method of ApiIdentifier

Param	Type	Description
other	number	Value to compare with

apiIdentifier.toJSON() ⇒ Object

Kind: instance method of ApiIdentifier

Camera

Kind: global class

• Camera
  • new Camera([indexOrPort])
  • instance
    • .description
    • .portName
    • .setEventHandler(listener)
    • .connect()
    • .disconnect()
    • .getProperty(propertyID, specifier) ⇒ CameraProperty
    • .setProperty(propertyID, value)
    • .setProperties(properties)
    • .sendCommand(command, parameter)
    • .takePicture()
    • .isLiveViewActive() ⇒ boolean
    • .startLiveView()
    • .stopLiveView()
    • .downloadLiveViewImage() ⇒ string
    • .getLiveViewImage() ⇒ LiveViewImage
    • .getVolumes() ⇒ Array.<Volume>
  • static
    • .EventName : enum
    • .Command : enum
    • .PressShutterButton : enum

new Camera([indexOrPort])

Camera device

Param	Type	Default
[indexOrPort]	number | string	0

camera.description

Kind: instance property of Camera
Read only: true

camera.portName

Kind: instance property of Camera
Read only: true

camera.setEventHandler(listener)

Set event handler callback

Kind: instance method of Camera

Param	Type
listener	EventCallback

camera.connect()

Connect to device

Kind: instance method of Camera

camera.disconnect()

Disconnect from device

Kind: instance method of Camera

camera.getProperty(propertyID, specifier) ⇒ CameraProperty

Fetch a camera property by ID or label

Kind: instance method of Camera

Param	Type	Default
propertyID	number | string
specifier	number	0

camera.setProperty(propertyID, value)

Kind: instance method of Camera

Param	Type
propertyID	PropertyIdentifier
value	PropertyValue

camera.setProperties(properties)

Kind: instance method of Camera

Param	Type
properties	PropertiesData

camera.sendCommand(command, parameter)

Kind: instance method of Camera

Param	Type	Default
command	number
parameter	number	0

camera.takePicture()

Trigger picture shot, successful shot will trigger an object event

Kind: instance method of Camera

camera.isLiveViewActive() ⇒ boolean

Return true if the LiveView is currently active

Kind: instance method of Camera

camera.startLiveView()

Request LiveView start, triggers event on success

Kind: instance method of Camera

camera.stopLiveView()

Request LiveView stop, triggers event on success

Kind: instance method of Camera

camera.downloadLiveViewImage() ⇒ string

Deprecated

Kind: instance method of Camera

camera.getLiveViewImage() ⇒ LiveViewImage

Kind: instance method of Camera

camera.getVolumes() ⇒ Array.<Volume>

Kind: instance method of Camera

Camera.EventName : enum

Kind: static enum of Camera
Read only: true
Properties

Name	Type	Default
CameraConnect	string	"CameraConnect"
CameraDisconnect	string	"CameraDisconnect"
DirectoryCreate	string	"DirectoryCreate"
DownloadRequest	string	"DownloadRequest"
Error	string	"Error"
FileCreate	string	"FileCreate"
KeepAlive	string	"KeepAlive"
LiveViewStart	string	"LiveViewStart"
LiveViewStop	string	"LiveViewStop"
ObjectChange	string	"ObjectChange"
PropertyChangeOptions	string	"PropertyChangeOptions"
PropertyChangeValue	string	"PropertyChangeValue"
StateChange	string	"StateChange"
VolumeChange	string	"VolumeChange"

Camera.Command : enum

Kind: static enum of Camera
Read only: true
Properties

Name	Type	Default
BulbEnd	number	3
BulbStart	number	2
DoClickWBEvf	number	260
DoEvfAf	number	258
DriveLensEvf	number	259
DrivePowerZoom	number	269
ExtendShutDownTimer	number	1
MovieSelectSwOFF	number	264
MovieSelectSwON	number	263
PressShutterButton	number	4
RequestRollPitchLevel	number	265
RequestSensorCleaning	number	274
SetRemoteShootingMode	number	271
TakePicture	number	0

Camera.PressShutterButton : enum

Kind: static enum of Camera
Read only: true
Properties

Name	Type	Default
Completely	number	3
CompletelyNonAF	number	65539
Halfway	number	1
HalfwayNonAF	number	65537
OFF	number	0

CameraBrowser

Kind: global class
Emits: CameraAdd, CameraRemove, Error, ObjectChange, StateChange, PropertyChangeValue, CameraBrowser#event:PropertyChangeAllowed, DownloadRequest, LiveViewStart, LiveViewStop

• CameraBrowser
  • new CameraBrowser()
  • instance
    • .setEventHandler(listener)
    • .initialize()
    • .terminate()
    • .triggerEvents()
    • .getCamera([at], [exactOnly])
    • .getCameras() ⇒ Array.<Camera>
    • .update()
    • "CameraAdd"
    • "CameraRemove"
    • "PropertyChangeValue"
    • "PropertyChangeOptions"
    • "DownloadRequest"
    • "ObjectChange"
    • "StateChange"
    • "LiveViewStart"
    • "LiveViewStop"
    • "Error"
  • static
    • .EventName : enum

new CameraBrowser()

Access to Canon Cameras

Example

const {cameraBrowser, watchCameras} = require('@dimensional/napi-canon-cameras');
cameraBrowser.setEventHandler(
  (eventName, event) => { console.log(eventName, event); }
);

process.on('SIGINT', () => process.exit());

console.log(cameraBrowser.getCameras());

watchCameras();

cameraBrowser.setEventHandler(listener)

Set event handler callback

Kind: instance method of CameraBrowser

Param	Type
listener	EventCallback

cameraBrowser.initialize()

Initialize SDK

Kind: instance method of CameraBrowser

cameraBrowser.terminate()

Terminate SDK and free all resources

Kind: instance method of CameraBrowser

cameraBrowser.triggerEvents()

Trigger SDK events

Kind: instance method of CameraBrowser

cameraBrowser.getCamera([at], [exactOnly])

Get camera at port or index. Returns the first camera in the internal list if port or position is invalid. USe the exactOnly argument to disable the fallback.

Kind: instance method of CameraBrowser

Param	Type	Default	Description
[at]	string | number	0	index or port name
[exactOnly]	boolean	false

cameraBrowser.getCameras() ⇒ Array.<Camera>

Get currently connected cameras.

Kind: instance method of CameraBrowser

cameraBrowser.update()

Update internal camera list

Kind: instance method of CameraBrowser

"CameraAdd"

New camera found

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera

"CameraRemove"

Camera removed or not found while enumerating current devices

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera

"PropertyChangeValue"

Property value change

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera
property	CameraProperty

"PropertyChangeOptions"

Property value change

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera
property	CameraProperty

"DownloadRequest"

New image available for download

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera
file	CameraFile

"ObjectChange"

Generic object change event, for debugging

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera
objectEvent	ObjectEvent

"StateChange"

Camera state changed

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera
stateEvent	StateChange

"LiveViewStart"

Camera live view started

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera

"LiveViewStop"

Camera live view stopped

Kind: event emitted by CameraBrowser
Properties

Name	Type
camera	Camera

"Error"

API Error

Kind: event emitted by CameraBrowser

CameraBrowser.EventName : enum

Kind: static enum of CameraBrowser
Read only: true
Properties

Name	Type	Default
CameraAdd	string	"CameraAdd"
CameraConnect	string	"CameraConnect"
CameraDisconnect	string	"CameraDisconnect"
CameraRemove	string	"CameraRemove"
DirectoryCreate	string	"DirectoryCreate"
DownloadRequest	string	"DownloadRequest"
Error	string	"Error"
FileCreate	string	"FileCreate"
KeepAlive	string	"KeepAlive"
LiveViewStart	string	"LiveViewStart"
LiveViewStop	string	"LiveViewStop"
ObjectChange	string	"ObjectChange"
PropertyChangeOptions	string	"PropertyChangeOptions"
PropertyChangeValue	string	"PropertyChangeValue"
StateChange	string	"StateChange"
VolumeChange	string	"VolumeChange"

CameraFile

Kind: global class
Implements: DirectoryEntry

• CameraFile
  • new CameraFile()
  • .name
  • .localFile
  • .groupID
  • .size
  • .format
  • .downloadToPath(path) ⇒ string
  • .downloadToFile(fileName) ⇒ string
  • .downloadToString() ⇒ string
  • .downloadThumbnailToString() ⇒ string

new CameraFile()

Provided in the DownloadRequestEvent. Allows to download the file from camera.

cameraFile.name

Camera provided file name (without path)

Kind: instance property of CameraFile
Read only: true

cameraFile.localFile

Local file name including path after download.

Kind: instance property of CameraFile
Read only: true

cameraFile.groupID

Multiple formats of the same picture share an ID

Kind: instance property of CameraFile
Read only: true

cameraFile.size

File/image size in bytes

Kind: instance property of CameraFile
Read only: true

cameraFile.format

Format

Kind: instance property of CameraFile
Read only: true

cameraFile.downloadToPath(path) ⇒ string

Download into a path using camera provided file name

Kind: instance method of CameraFile
Returns: string - local file name

Param	Type
path	string

cameraFile.downloadToFile(fileName) ⇒ string

Download into a specific file

Kind: instance method of CameraFile
Returns: string - local file name

Param	Type
fileName	string

cameraFile.downloadToString() ⇒ string

Download into a base64 encoded string

Kind: instance method of CameraFile
Returns: string - base64 encoded string

cameraFile.downloadThumbnailToString() ⇒ string

Download thumbnail into a base64 encoded string

Kind: instance method of CameraFile
Returns: string - base64 encoded string

CameraProperty

Kind: global class

• CameraProperty
  • new CameraProperty(camera, propertyID, [propertySpecifier])
  • instance
    • .label : string
    • .identifier : number
    • .specifier : number
    • .available : boolean
    • .value : CameraPropertyValue
    • .allowedValues : Array.<CameraPropertyValue>
    • .toJSON() ⇒ Object
  • static
    • .ID : enum

new CameraProperty(camera, propertyID, [propertySpecifier])

Camera property/setting.

Param	Type	Default
camera	Camera
propertyID	number
[propertySpecifier]	number	0

Example

const property = camera.getProperty(Property.ID.Av);
console.log(property.value, property.allowedValues);

cameraProperty.label : string

Kind: instance property of CameraProperty
Read only: true

cameraProperty.identifier : number

Kind: instance property of CameraProperty
Read only: true

cameraProperty.specifier : number

Kind: instance property of CameraProperty
Read only: true

cameraProperty.available : boolean

Kind: instance property of CameraProperty
Read only: true

cameraProperty.value : CameraPropertyValue

Kind: instance property of CameraProperty

cameraProperty.allowedValues : Array.<CameraPropertyValue>

Kind: instance property of CameraProperty

cameraProperty.toJSON() ⇒ Object

Kind: instance method of CameraProperty

CameraProperty.ID : enum

Kind: static enum of CameraProperty
Read only: true
Properties

Name	Type	Default
AEBracket	number	1038
AEMode	number	1024
AEModeSelect	number	1078
AFMode	number	1028
Artist	number	1048
AutoPowerOffSetting	number	16778334
Av	number	1029
AvailableShots	number	1034
BatteryLevel	number	8
BatteryQuality	number	16
BodyIDEx	number	21
Bracket	number	1035
CFn	number	9
ColorSpace	number	269
ColorTemperature	number	263
Copyright	number	1049
CurrentFolder	number	13
CurrentStorage	number	12
DC_Strobe	number	1537
DC_Zoom	number	1536
DateTime	number	6
DepthOfField	number	1051
DriveMode	number	1025
EFCompensation	number	1054
EVF_RollingPitching	number	16778564
Evf_AFMode	number	1294
Evf_ClickWBCoeffs	number	16778502
Evf_ColorTemperature	number	1283
Evf_CoordinateSystem	number	1344
Evf_DepthOfFieldPreview	number	1284
Evf_FocusAid	number	1289
Evf_Histogram	number	1290
Evf_HistogramB	number	1304
Evf_HistogramG	number	1303
Evf_HistogramR	number	1302
Evf_HistogramStatus	number	1292
Evf_HistogramY	number	1301
Evf_ImageClipRect	number	1349
Evf_ImagePosition	number	1291
Evf_Mode	number	1281
Evf_OutputDevice	number	1280
Evf_PowerZoom_CurPosition	number	1360
Evf_PowerZoom_MaxPosition	number	1361
Evf_PowerZoom_MinPosition	number	1362
Evf_WhiteBalance	number	1282
Evf_Zoom	number	1287
Evf_ZoomPosition	number	1288
Evf_ZoomRect	number	1345
ExposureCompensation	number	1031
FEBracket	number	1039
FirmwareVersion	number	7
FixedMovie	number	16778274
FlashCompensation	number	1032
FlashMode	number	1044
FlashOn	number	1042
FocalLength	number	1033
FocusInfo	number	260
GPSAltitude	number	2054
GPSAltitudeRef	number	2053
GPSDateStamp	number	2077
GPSLatitude	number	2050
GPSLatitudeRef	number	2049
GPSLongitude	number	2052
GPSLongitudeRef	number	2051
GPSMapDatum	number	2066
GPSSatellites	number	2056
GPSStatus	number	2057
GPSTimeStamp	number	2055
GPSVersionID	number	2048
HDDirectoryStructure	number	32
ICCProfile	number	259
ISOBracket	number	1040
ISOSpeed	number	1026
ImageQuality	number	256
JpegQuality	number	257
LensBarrelStatus	number	1541
LensName	number	1037
LensStatus	number	1046
MakerName	number	5
ManualWhiteBalanceData	number	16777732
MeteringMode	number	1027
MirrorLockUpState	number	16778273
MirrorUpSetting	number	16778296
MovieParam	number	16778275
MyMenu	number	14
NoiseReduction	number	1041
Orientation	number	258
OwnerName	number	4
PictureStyle	number	276
PictureStyleCaption	number	512
PictureStyleDescription	number	277
PowerZoom_Speed	number	1092
ProductName	number	2
Record	number	1296
RedEye	number	1043
SaveTo	number	11
SummerTimeSetting	number	16777240
TemperatureStatus	number	16778261
TimeZone	number	16777239
Tv	number	1030
UTCTime	number	16777238
WhiteBalance	number	262
WhiteBalanceBracket	number	1036
WhiteBalanceShift	number	264

Directory

Kind: global class
Implements: DirectoryEntry

• Directory
  • .name ⇒ string
  • .length ⇒ number
  • .getEntries() ⇒ Array.<DirectoryEntry>

directory.name ⇒ string

Kind: instance property of Directory
Read only: true

directory.length ⇒ number

Entry count

Kind: instance property of Directory

directory.getEntries() ⇒ Array.<DirectoryEntry>

Kind: instance method of Directory

ExposureCompensation

Kind: global class

• ExposureCompensation
  • new ExposureCompensation(value_)
  • instance
    • .label : string
    • .value : number
    • .compensation : number
  • static
    • .Values : enum
    • .forLabel(label) ⇒ ExposureCompensation | null

new ExposureCompensation(value_)

Encapsulate Object for a exposure compensation value

Param	Type
value_	number

exposureCompensation.label : string

Kind: instance property of ExposureCompensation
Read only: true

exposureCompensation.value : number

Kind: instance property of ExposureCompensation
Read only: true

exposureCompensation.compensation : number

Kind: instance property of ExposureCompensation
Read only: true

ExposureCompensation.Values : enum

Kind: static enum of ExposureCompensation
Read only: true
Properties

Name	Type	Default
0	number	0
3	number	0.3333333333333333
4	number	0.5
5	number	0.6666666666666666
8	number	1
11	number	1.3333333333333333
12	number	1.5
13	number	1.6666666666666665
16	number	2
19	number	2.3333333333333335
20	number	2.5
21	number	2.6666666666666665
24	number	3
27	number	3.3333333333333335
28	number	3.5
29	number	3.6666666666666665
32	number	4
35	number	4.333333333333333
36	number	4.5
37	number	4.666666666666667
40	number	5
216	number	-5
219	number	-4.666666666666667
220	number	-4.5
221	number	-4.333333333333333
224	number	-4
227	number	-3.6666666666666665
228	number	-3.5
229	number	-3.3333333333333335
232	number	-3
235	number	-2.6666666666666665
236	number	-2.5
237	number	-2.3333333333333335
240	number	-2
243	number	-1.6666666666666665
244	number	-1.5
245	number	-1.3333333333333333
248	number	-1
251	number	-0.6666666666666666
252	number	-0.5
253	number	-0.3333333333333333

ExposureCompensation.forLabel(label) ⇒ ExposureCompensation | null

Create instance for label.

Kind: static method of ExposureCompensation

Param	Type
label	string

FileFormat

Kind: global class

• FileFormat
  • new FileFormat(value_)
  • instance
    • .label : string
    • .value : number
  • static
    • .ID : enum

new FileFormat(value_)

Param	Type
value_	number

fileFormat.label : string

Kind: instance property of FileFormat
Read only: true

fileFormat.value : number

Kind: instance property of FileFormat
Read only: true

FileFormat.ID : enum

Kind: static enum of FileFormat
Read only: true
Properties

Name	Type	Default
CR2	number	45315
CR3	number	45320
HEIF_CODE	number	45323
JPEG	number	14337
MP4	number	47490
Unknown	number	0

Flag

Kind: global class

• Flag
  • new Flag(value)
  • new Flag(value)
  • instance
    • .label : string
    • .value : number
    • .flag : boolean
    • .toJSON() ⇒ Object
  • static
    • .True : number
    • .False : number
    • .forLabel(label) ⇒ Flag

new Flag(value)

Boolean property value

Param	Type
value	number | boolean

new Flag(value)

Boolean property value

Param	Type
value	number | boolean

flag.label : string

Kind: instance property of Flag
Read only: true

flag.value : number

Kind: instance property of Flag
Read only: true

flag.flag : boolean

Kind: instance property of Flag
Read only: true

flag.toJSON() ⇒ Object

Kind: instance method of Flag

Flag.True : number

Kind: static property of Flag
Read only: true

Flag.False : number

Kind: static property of Flag
Read only: true

Flag.forLabel(label) ⇒ Flag

Create instance for label.

Kind: static method of Flag

Param	Type
label	string

ImageQuality

Kind: global class

• ImageQuality
  • new ImageQuality(value_)
  • instance
    • .label : string
    • .value : number
    • .main : ImageQualityProperties
    • .secondary : ImageQualityProperties
  • static
    • .ID : enum
    • .Format : enum
    • .Size : enum
    • .CompressionQuality : enum

new ImageQuality(value_)

Param	Type
value_	number

imageQuality.label : string

Kind: instance property of ImageQuality
Read only: true

imageQuality.value : number

Kind: instance property of ImageQuality
Read only: true

imageQuality.main : ImageQualityProperties

Kind: instance property of ImageQuality
Read only: true

imageQuality.secondary : ImageQualityProperties

Kind: instance property of ImageQuality
Read only: true

ImageQuality.ID : enum

Kind: static enum of ImageQuality
Read only: true
Properties

Name	Type	Default
CR	number	6553359
CRHEIFL	number	6488192
CRHEIFLF	number	6488195
CRHEIFLN	number	6488194
CRHEIFMF	number	6488451
CRHEIFMN	number	6488450
CRHEIFS1F	number	6491779
CRHEIFS1N	number	6491778
CRHEIFS2F	number	6492035
CRLJ	number	6488080
CRLJF	number	6488083
CRLJN	number	6488082
CRM1J	number	6489360
CRM1JF	number	6489363
CRM1JN	number	6489362
CRM2J	number	6489616
CRM2JF	number	6489619
CRM2JN	number	6489618
CRMJ	number	6488336
CRMJF	number	6488339
CRMJN	number	6488338
CRS1J	number	6491664
CRS1JF	number	6491667
CRS1JN	number	6491666
CRS2J	number	6491920
CRS2JF	number	6491923
CRS3JF	number	6492179
CRSJ	number	6488592
CRSJF	number	6488595
CRSJN	number	6488594
HEIFL	number	8453903
HEIFLF	number	8650511
HEIFLN	number	8584975
HEIFMF	number	25427727
HEIFMN	number	25362191
HEIFS1F	number	243531535
HEIFS1N	number	243465999
HEIFS2F	number	260308751
LargeJPEG	number	1113871
LargeJPEGFine	number	1310479
LargeJPEGNormal	number	1244943
MR	number	23396111
MRLJ	number	23330832
MRLJF	number	23330835
MRLJN	number	23330834
MRM1J	number	23332112
MRM2J	number	23332368
MRMJF	number	23331091
MRMJN	number	23331090
MRS1JF	number	23334419
MRS1JN	number	23334418
MRS2JF	number	23334675
MRS3JF	number	23334931
MRSJ	number	23331344
MRSJF	number	23331347
MRSJN	number	23331346
Middle1JPEG	number	84999951
Middle2JPEG	number	101777167
MiddleJPEG	number	17891087
MiddleJPEGFine	number	18087695
MiddleJPEGNormal	number	18022159
RAW	number	6618895
RAWAndLargeJPEG	number	6553616
RAWAndLargeJPEGFine	number	6553619
RAWAndLargeJPEGNormal	number	6553618
RAWAndMiddle1JPEG	number	6554896
RAWAndMiddle2JPEG	number	6555152
RAWAndMiddleJPEG	number	6553872
RAWAndMiddleJPEGFine	number	6553875
RAWAndMiddleJPEGNormal	number	6553874
RAWAndSmall1JPEG	number	6557200
RAWAndSmall1JPEGFine	number	6557203
RAWAndSmall1JPEGNormal	number	6557202
RAWAndSmall2JPEG	number	6557456
RAWAndSmall2JPEGFine	number	6557459
RAWAndSmall3JPEGFine	number	6557715
RAWAndSmallJPEG	number	6554128
RAWAndSmallJPEGFine	number	6554131
RAWAndSmallJPEGNormal	number	6554130
RHEIFL	number	6553728
RHEIFLF	number	6553731
RHEIFLN	number	6553730
RHEIFMF	number	6553987
RHEIFMN	number	6553986
RHEIFS1F	number	6557315
RHEIFS1N	number	6557314
RHEIFS2F	number	6557571
SR	number	40173327
SRLJ	number	40108048
SRLJF	number	40108051
SRLJN	number	40108050
SRM1J	number	40109328
SRM2J	number	40109584
SRMJF	number	40108307
SRMJN	number	40108306
SRS1JF	number	40111635
SRS1JN	number	40111634
SRS2JF	number	40111891
SRS3JF	number	40112147
SRSJ	number	40108560
SRSJF	number	40108563
SRSJN	number	40108562
Small1JPEGFine	number	236191503
Small1JPEGNormal	number	236125967
Small2JPEGFine	number	252968719
Small3JPEGFine	number	269745935
SmallJPEG	number	34668303
SmallJPEG1	number	235994895
SmallJPEG2	number	252772111
SmallJPEGFine	number	34864911
SmallJPEGNormal	number	34799375
Unknown	number	4294967295

ImageQuality.Format : enum

Kind: static enum of ImageQuality
Read only: true
Properties

Name	Type	Default
CR2	number	6
CRW	number	2
HEIF	number	8
JPEG	number	1
RAW	number	4
Unknown	number	0

ImageQuality.Size : enum

Kind: static enum of ImageQuality
Read only: true
Properties

Name	Type	Default
Large	number	0
Middle	number	1
Middle1	number	5
Middle2	number	6
Small	number	2
Small1	number	14
Small2	number	15
Small3	number	16
Unknown	number	4294967295

ImageQuality.CompressionQuality : enum

Kind: static enum of ImageQuality
Read only: true
Properties

Name	Type	Default
Fine	number	3
Lossless	number	4
Normal	number	2
SuperFine	number	5
Unknown	number	4294967295

ISOSensitivity

Kind: global class
Implements: PropertyValue

• ISOSensitivity
  • new ISOSensitivity(value_)
  • instance
    • .label : string
    • .value : number
    • .sensitivity : number
    • .toJSON() ⇒ Object
  • static
    • .ID : enum
    • .Values : enum
    • .forLabel(label) ⇒ ISOSensitivity | null

new ISOSensitivity(value_)

ISO Sensitivity property value

Param	Type
value_	number

isoSensitivity.label : string

Kind: instance property of ISOSensitivity
Read only: true

isoSensitivity.value : number

Kind: instance property of ISOSensitivity
Read only: true

isoSensitivity.sensitivity : number

Kind: instance property of ISOSensitivity
Read only: true

isoSensitivity.toJSON() ⇒ Object

Kind: instance method of ISOSensitivity

ISOSensitivity.ID : enum

Kind: static enum of ISOSensitivity
Read only: true
Properties

Name	Type	Default
Auto	number	0

ISOSensitivity.Values : enum

Kind: static enum of ISOSensitivity
Read only: true
Properties

Name	Type	Default
40	number	6
48	number	12
56	number	25
64	number	50
72	number	100
75	number	125
77	number	160
80	number	200
83	number	250
85	number	320
88	number	400
91	number	500
93	number	640
96	number	800
99	number	1000
101	number	1250
104	number	1600
107	number	2000
109	number	2500
112	number	3200
115	number	4000
117	number	5000
120	number	6400
123	number	8000
125	number	10000
128	number	12800
131	number	16000
133	number	20000
136	number	25600
139	number	32000
141	number	40000
144	number	51200
147	number	64000
149	number	80000
152	number	102400
160	number	204800
168	number	409600
176	number	819200

ISOSensitivity.forLabel(label) ⇒ ISOSensitivity | null

Create instance for label.

Kind: static method of ISOSensitivity

Param	Type
label	string

LiveViewImage

Kind: global class

• LiveViewImage
  • new LiveViewImage()
  • .coordinateSystem ⇒ Size
  • .histogram ⇒ Histogram
  • .histogramStatus ⇒ Option
  • .position ⇒ Position
  • .visibleArea ⇒ Rectangle
  • .zoom ⇒ Option
  • .zoomPosition ⇒ Position
  • .zoomArea ⇒ Rectangle
  • .getDataURL() ⇒ string

new LiveViewImage()

Provided in getLiveViewImage. Allows to download the file from camera.

liveViewImage.coordinateSystem ⇒ Size

Coordinate system of the live view image

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.histogram ⇒ Histogram

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.histogramStatus ⇒ Option

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.position ⇒ Position

Cropping position of the enlarged live view image

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.visibleArea ⇒ Rectangle

Visible area information according to Canon camera aspect settings

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.zoom ⇒ Option

The zoom factor

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.zoomPosition ⇒ Position

The focus and zoom border position

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.zoomArea ⇒ Rectangle

Focus and zoom border rectangle

Kind: instance property of LiveViewImage
Read only: true

liveViewImage.getDataURL() ⇒ string

Return as data url, the image will be base64 encoded.

Kind: instance method of LiveViewImage
Returns: string - data url

ObjectEvent ⇐ ApiIdentifier

Kind: global class
Extends: ApiIdentifier

• ObjectEvent ⇐ ApiIdentifier
  • new ObjectEvent(identifier)
  • instance
    • .label : string
    • .identifier : number
    • .equalTo(other) ⇒ boolean
    • .Symbol_toPrimitive(hint) ⇒ string | number | null
    • .toJSON() ⇒ Object
  • static
    • .ID : enum

new ObjectEvent(identifier)

Encapsulate Object Event Identifiers For Easy Read And Debug

Param	Type
identifier	number

objectEvent.label : string

Kind: instance property of ObjectEvent
Read only: true

objectEvent.identifier : number

Kind: instance property of ObjectEvent
Read only: true

objectEvent.equalTo(other) ⇒ boolean

Kind: instance method of ObjectEvent
Overrides: equalTo

Param	Type	Description
other	number | ObjectEvent	The other value

objectEvent.Symbol_toPrimitive(hint) ⇒ string | number | null

Allows type cast to number and string. The string will be a hexadecimal code representation of the number

Kind: instance method of ObjectEvent

Param	Type
hint	string

objectEvent.toJSON() ⇒ Object

Kind: instance method of ObjectEvent

ObjectEvent.ID : enum

Kind: static enum of ObjectEvent
Read only: true
Properties

Name	Type	Default
All	number	512
DirItemCancelTransferDT	number	522
DirItemContentChanged	number	519
DirItemCreated	number	516
DirItemInfoChanged	number	518
DirItemRemoved	number	517
DirItemRequestTransfer	number	520
DirItemRequestTransferDT	number	521
FolderUpdateItems	number	515
VolumeAdded	number	524
VolumeInfoChanged	number	513
VolumeRemoved	number	525
VolumeUpdateItems	number	514

Option

Kind: global class

• Option
  • new Option(propertyID_, value_)
  • instance
    • .label : string
    • .value : number
    • .propertyID : number
  • static
    • .AEMode : enum
    • .AEModeSelect : enum
    • .AFMode : enum
    • .BatteryQuality : enum
    • .Bracket : enum
    • .ColorSpace : enum
    • .DCStrobe : enum
    • .DriveMode : enum
    • .EvfAFMode : enum
    • .EvfHistogramStatus : enum
    • .EvfOutputDevice : enum
    • .EvfZoom : enum
    • .LensBarrelStatus : enum
    • .LensStatus : enum
    • .MeteringMode : enum
    • .MirrorUpStatus : enum
    • .MovieQuality : enum
    • .NoiseReduction : enum
    • .RedEye : enum
    • .Record : enum
    • .SaveTo : enum
    • .WhiteBalance : enum
    • .forLabel(label) ⇒ Option | null

new Option(propertyID_, value_)

Option represents a property value from a property specific list. It provides constants for all possible property values. However it depends on the camera and the camera status which option values are available.

Param	Type
propertyID_	number
value_	number

option.label : string

Kind: instance property of Option
Read only: true

option.value : number

Kind: instance property of Option
Read only: true

option.propertyID : number

Kind: instance property of Option
Read only: true

Option.AEMode : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
A_DEP	number	5
Av	number	2
BackgroundBlur	number	62
BacklitScenes	number	24
Bulb	number	4
CandlelightPortraits	number	28
Children	number	26
Closeup	number	14
CreativeAuto	number	19
CreativeFilter	number	29
Custom	number	7
DEP	number	6
Fireworks	number	57
Fisheye	number	33
FlashOff	number	15
Flexible	number	55
Food	number	27
Green	number	9
GroupPhoto	number	46
Hdr_Bold	number	38
Hdr_Embossed	number	39
Hdr_Standard	number	36
Hdr_Vivid	number	37
Landscape	number	13
Lock	number	8
Manual	number	3
Miniature	number	35
Movie	number	20
Movie_DirectMono	number	43
Movie_Fantasy	number	40
Movie_Memory	number	42
Movie_Mini	number	44
Movie_Old	number	41
Myself	number	50
NightPortrait	number	10
NightScenes	number	23
OilPainting	number	56
PanningAssist	number	45
Panorama	number	53
PhotoInMovie	number	21
PlusMovieAuto	number	51
Portrait	number	12
ProgramAE	number	0
RoughMonoChrome	number	30
SCN	number	25
SceneIntelligentAuto	number	22
Silent	number	54
SmoothSkin	number	52
SoftFocus	number	31
Sports	number	11
StarNightScape	number	59
StarPortrait	number	58
StarTimelapseMovie	number	61
StarTrails	number	60
ToyCamera	number	32
Tv	number	1
Unknown	number	4294967295
VideoBlog	number	63
WaterColor	number	34

Option.AEModeSelect : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
A_DEP	number	5
Av	number	2
BackgroundBlur	number	62
BacklitScenes	number	24
Bulb	number	4
CandlelightPortraits	number	28
Children	number	26
Closeup	number	14
CreativeAuto	number	19
CreativeFilter	number	29
Custom	number	7
Custom2	number	16
Custom3	number	17
DEP	number	6
Fireworks	number	57
Fisheye	number	33
FlashOff	number	15
Flexible	number	55
Food	number	27
Green	number	9
GroupPhoto	number	46
Hdr_Bold	number	38
Hdr_Embossed	number	39
Hdr_Standard	number	36
Hdr_Vivid	number	37
Landscape	number	13
Lock	number	8
Manual	number	3
Miniature	number	35
Movie	number	20
Movie_DirectMono	number	43
Movie_Fantasy	number	40
Movie_Memory	number	42
Movie_Mini	number	44
Movie_Old	number	41
Myself	number	50
NightPortrait	number	10
NightScenes	number	23
OilPainting	number	56
PanningAssist	number	45
Panorama	number	53
PhotoInMovie	number	21
PlusMovieAuto	number	51
Portrait	number	12
ProgramAE	number	0
RoughMonoChrome	number	30
SCN	number	25
SceneIntelligentAuto	number	22
Silent	number	54
SmoothSkin	number	52
SoftFocus	number	31
Sports	number	11
StarNightScape	number	59
StarPortrait	number	58
StarTimelapseMovie	number	61
StarTrails	number	60
ToyCamera	number	32
Tv	number	1
Unknown	number	4294967295
WaterColor	number	34

Option.AFMode : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
AIFocus	number	2
AIServo	number	1
ManualFocus	number	3
NotValid	number	4294967295
OneShot	number	0

Option.BatteryQuality : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Full	number	3
Half	number	1
High	number	2
Low	number	0

Option.Bracket : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
AEBracket	number	1
BracketOff	number	4294967295
FEBracket	number	8
ISOBracket	number	2
WBBracket	number	4

Option.ColorSpace : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
AdobeRGB	number	2
Unknown	number	4294967295
sRGB	number	1

Option.DCStrobe : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Auto	number	0
Off	number	3
On	number	1
SlowSynchro	number	2

Option.DriveMode : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
ContinuousShooting	number	1
HighSpeedContinuous	number	4
LowSpeedContinuous	number	5
SelfTimer10sec	number	16
SelfTimer2sec	number	17
SelfTimerContinuous	number	7
SilentContinuousShooting	number	20
SilentHSContinuous	number	21
SilentLSContinuous	number	22
SilentSingleShooting	number	19
SingleShooting	number	0
SingleSilentShooting	number	6
SuperHighSpeed14fps	number	18
Video	number	2

Option.EvfAFMode : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
ExpandAFAreaAround	number	6
ExpandAFAreaCross	number	5
FaceTracking	number	2
FlexiZoneMulti	number	3
LargeZoneAFHorizontal	number	7
LargeZoneAFVertical	number	8
OnePointAF	number	1
Quick	number	0
SpotAF	number	10
TrackingAF	number	9
ZoneAF	number	4

Option.EvfHistogramStatus : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Grayout	number	2
Hide	number	0
Normal	number	1

Option.EvfOutputDevice : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
None	number	0
PC	number	2
SmallPC	number	8
TFT	number	1

Option.EvfZoom : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Fit	number	1
x10	number	10
x5	number	5

Option.LensBarrelStatus : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Inner	number	0
Outer	number	1

Option.LensStatus : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Attached	number	1
NotAttached	number	0

Option.MeteringMode : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
CenterWeightedAverage	number	5
Evaluative	number	3
NotValid	number	4294967295
Partial	number	4
Spot	number	1

Option.MirrorUpStatus : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Disable	number	0
DuringShooting	number	2
Enable	number	1

Option.MovieQuality : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
"1280x720 100.0fps For editing(ALL-I)"	number	71696
"1280x720 100.0fps Standard(IPB)"	number	71728
"1280x720 119.9fps For editing(ALL-I)"	number	71952
"1280x720 119.9fps Standard(IPB)"	number	71984
"1280x720 25.00fps Standard(IPB)"	number	70704
"1280x720 29.97fps Light(IPB)"	number	70961
"1280x720 29.97fps Standard(IPB)"	number	70960
"1280x720 50.00fps"	number	67072
"1280x720 50.00fps For editing(ALL-I)"	number	71184
"1280x720 50.00fps Standard(IPB)"	number	71216
"1280x720 59.94fps"	number	67328
"1280x720 59.94fps For editing(ALL-I)"	number	71440
"1280x720 59.94fps Standard(IPB)"	number	71472
"1920x1080 100.0fps For editing(ALL-I)"	number	6160
"1920x1080 119.9fps For editing(ALL-I)"	number	6416
"1920x1080 23.98fps"	number	512
"1920x1080 23.98fps For editing(ALL-I)"	number	4624
"1920x1080 23.98fps For editing(ALL-I)Crop"	number	134222352
"1920x1080 23.98fps Standard(IPB)"	number	4656
"1920x1080 23.98fps Standard(IPB)Crop"	number	134222384
"1920x1080 24.00fps For editing(ALL-I)"	number	4880
"1920x1080 24.00fps For editing(ALL-I)Crop"	number	134222864
"1920x1080 24.00fps Standard(IPB)"	number	4912
"1920x1080 24.00fps Standard(IPB)Crop"	number	134222896
"1920x1080 25.00fps"	number	1024
"1920x1080 25.00fps For editing(ALL-I)"	number	5136
"1920x1080 25.00fps For editing(ALL-I)Crop"	number	134222897
"1920x1080 25.00fps Light(IPB)"	number	5169
"1920x1080 25.00fps Standard(IPB)"	number	5168
"1920x1080 25.00fps Standard(IPB)Crop"	number	134223120
"1920x1080 29.94fps Standard(IPB)Crop"	number	134223153
"1920x1080 29.97fps"	number	1280
"1920x1080 29.97fps For editing(ALL-I)"	number	1296
"1920x1080 29.97fps For editing(ALL-I)Crop"	number	134223152
"1920x1080 29.97fps Light(IPB)"	number	5425
"1920x1080 29.97fps Standard(IPB)"	number	5424
"1920x1080 50.00fps For editing(ALL-I)"	number	5648
"1920x1080 50.00fps For editing(ALL-I)Crop"	number	134223376
"1920x1080 50.00fps Standard(IPB)"	number	5680
"1920x1080 50.00fps Standard(IPB)Crop"	number	134223408
"1920x1080 59.94fps For editing(ALL-I)"	number	5904
"1920x1080 59.94fps For editing(ALL-I)Crop"	number	134223632
"1920x1080 59.94fps Standard(IPB)"	number	5936
"1920x1080 59.94fps Standard(IPB)Crop"	number	134223664
"23.98fps (RAW)"	number	668272
"24.00fps (RAW)"	number	668528
"25.00fps (RAW)"	number	668784
"29.97fps (RAW)"	number	669040
"3840x2160 100.0fps For editing(ALL-I)"	number	333840
"3840x2160 119.9fps For editing(ALL-I)"	number	334096
"3840x2160 23.98fps For editing(ALL-I)"	number	134550032
"3840x2160 23.98fps Standard(IPB)"	number	134550064
"3840x2160 24.00fps For editing(ALL-I)"	number	332560
"3840x2160 24.00fps Standard(IPB)"	number	332592
"3840x2160 25.00fps For editing(ALL-I)"	number	134550544
"3840x2160 25.00fps Standard(IPB)"	number	134550576
"3840x2160 29.97fps For editing(ALL-I)"	number	134550800
"3840x2160 29.97fps Standard(IPB)"	number	134550832
"3840x2160 50.00fps For editing(ALL-I)"	number	134551056
"3840x2160 50.00fps Standard(IPB)"	number	134551088
"3840x2160 59.94fps For editing(ALL-I)"	number	134551312
"3840x2160 59.94fps Standard(IPB)"	number	134551344
"4096x2160 100.0fps For editing(ALL-I)"	number	202768
"4096x2160 119.9fps For editing(ALL-I)"	number	203024
"4096x2160 23.98fps For editing(ALL-I)"	number	201232
"4096x2160 23.98fps For editing(ALL-I) Crop"	number	134418960
"4096x2160 23.98fps Motion JPEG"	number	197184
"4096x2160 23.98fps Standard(IPB)"	number	201264
"4096x2160 23.98fps Standard(IPB)Crop"	number	134418992
"4096x2160 24.00fps For editing(ALL-I)"	number	201488
"4096x2160 24.00fps For editing(ALL-I)Crop"	number	134419216
"4096x2160 24.00fps Motion JPEG"	number	197440
"4096x2160 24.00fps Standard(IPB)"	number	201520
"4096x2160 24.00fps Standard(IPB)Crop"	number	134419248
"4096x2160 25.00fps For editing(ALL-I)"	number	201744
"4096x2160 25.00fps For editing(ALL-I)Crop"	number	134419472
"4096x2160 25.00fps Motion JPEG"	number	197696
"4096x2160 25.00fps Standard(IPB)"	number	201776
"4096x2160 25.00fps Standard(IPB)Crop"	number	134419504
"4096x2160 29.94fps Standard(IPB)Crop"	number	134419760
"4096x2160 29.970fps Standard(IPB)"	number	202032
"4096x2160 29.97fps For editing(ALL-I)"	number	202000
"4096x2160 29.97fps For editing(ALL-I)Crop"	number	134419728
"4096x2160 29.97fps Motion JPEG"	number	197952
"4096x2160 50.00fps For editing(ALL-I)"	number	202256
"4096x2160 50.00fps For editing(ALL-I)Crop"	number	134419984
"4096x2160 50.00fps Standard(IPB)"	number	202288
"4096x2160 50.00fps Standard(IPB)Crop"	number	134420016
"4096x2160 59.94fps For editing(ALL-I)"	number	202512
"4096x2160 59.94fps For editing(ALL-I)Crop"	number	134420240
"4096x2160 59.94fps Standard(IPB)"	number	202544
"4096x2160 59.94fps Standard(IPB)Crop"	number	134420272
"50.00fps (RAW)"	number	669296
"59.94fps (RAW)"	number	669552
"640x480 25.00fps"	number	132096
"640x480 29.97ffps"	number	132352
"7680x4320 23.98fps For editing(ALL-I)"	number	594448
"7680x4320 23.98fps Standard(IPB)"	number	594480
"7680x4320 25.00fps For editing(ALL-I)"	number	594960
"7680x4320 25.00fps Standard(IPB)"	number	594992
"7680x4320 29.97fps For editing(ALL-I)"	number	595216
"7680x4320 29.97fps Standard(IPB)"	number	595248
"8192x4320 23.98fps For editing(ALL-I)"	number	528912
"8192x4320 23.98fps Standard(IPB)"	number	528944
"8192x4320 24.00fps For editing(ALL-I)"	number	529168
"8192x4320 24.00fps Standard(IPB)"	number	529200
"8192x4320 25.00fps For editing(ALL-I)"	number	529424
"8192x4320 25.00fps Standard(IPB)"	number	529456
"8192x4320 29.97fps For editing(ALL-I)"	number	529680
"8192x4320 29.97fps Standard(IPB)"	number	529712

Option.NoiseReduction : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Auto	number	4
Off	number	0
On1	number	1
On2	number	2
On3	number	3

Option.RedEye : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Invalid	number	4294967295
Off	number	0
On	number	1

Option.Record : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Begin	number	4
End	number	0

Option.SaveTo : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
Both	number	3
Camera	number	1
Host	number	2

Option.WhiteBalance : enum

Kind: static enum of Option
Read only: true
Properties

Name	Type	Default
AutoAmbiencePriority	number	0
AutoWhitePriority	number	23
Click	number	4294967295
Cloudy	number	2
ColorTemperature	number	9
CustomPC1	number	10
CustomPC2	number	11
CustomPC3	number	12
CustomPC4	number	20
CustomPC5	number	21
Daylight	number	1
Flash	number	5
Fluorescent	number	4
Pasted	number	4294967294
Shade	number	8
Tungsten	number	3
WhitePaper	number	6
WhitePaper2	number	15
WhitePaper3	number	16
WhitePaper4	number	18
WhitePaper5	number	19

Option.forLabel(label) ⇒ Option | null

Create instance for label.

Kind: static method of Option

Param	Type
label	string

Flag

Kind: global class

• Flag
  • new Flag(value)
  • new Flag(value)
  • instance
    • .label : string
    • .value : number
    • .flag : boolean
    • .toJSON() ⇒ Object
  • static
    • .True : number
    • .False : number
    • .forLabel(label) ⇒ Flag

new Flag(value)

Boolean property value

Param	Type
value	number | boolean

new Flag(value)

Boolean property value

Param	Type
value	number | boolean

flag.label : string

Kind: instance property of Flag
Read only: true

flag.value : number

Kind: instance property of Flag
Read only: true

flag.flag : boolean

Kind: instance property of Flag
Read only: true

flag.toJSON() ⇒ Object

Kind: instance method of Flag

Flag.True : number

Kind: static property of Flag
Read only: true

Flag.False : number

Kind: static property of Flag
Read only: true

Flag.forLabel(label) ⇒ Flag

Create instance for label.

Kind: static method of Flag

Param	Type
label	string

ShutterSpeed

Kind: global class

• ShutterSpeed
  • new ShutterSpeed(value_)
  • instance
    • .label : string
    • .value : number
    • .seconds : number
    • .stop : number
    • .toJSON() ⇒ Object
  • static
    • .ID : enum
    • .OneHalfValues : enum
    • .OneThirdValues : enum
    • .forLabel(label) ⇒ ShutterSpeed | null

new ShutterSpeed(value_)

Encapsulate Object for a Shutter Speed value

Param	Type
value_	number

shutterSpeed.label : string

Kind: instance property of ShutterSpeed
Read only: true

shutterSpeed.value : number

Kind: instance property of ShutterSpeed
Read only: true

shutterSpeed.seconds : number

Kind: instance property of ShutterSpeed
Read only: true

shutterSpeed.stop : number

Kind: instance property of ShutterSpeed
Read only: true

shutterSpeed.toJSON() ⇒ Object

Kind: instance method of ShutterSpeed

ShutterSpeed.ID : enum

Kind: static enum of ShutterSpeed
Read only: true
Properties

Name	Type	Default
Auto	number	0
Bulb	number	12
NotValid	number	4294967295

ShutterSpeed.OneHalfValues : enum

Kind: static enum of ShutterSpeed
Read only: true
Properties

Name	Type	Default
16	number	30
19	number	25
20	number	20
24	number	15
27	number	13
28	number	10
32	number	8
36	number	6
37	number	5
40	number	4
43	number	3.2
44	number	3
45	number	2.5
48	number	2
51	number	1.6
52	number	1.5
53	number	1.3
56	number	1
59	number	0.8
60	number	0.7
61	number	0.6
64	number	0.5
67	number	0.4
68	number	0.3
72	number	0.25
75	number	0.2
76	number	0.16666666666666666
80	number	0.125
84	number	0.1
85	number	0.07692307692307693
88	number	0.06666666666666667
92	number	0.05
93	number	0.04
96	number	0.03333333333333333
99	number	0.025
100	number	0.022222222222222223
101	number	0.02
104	number	0.016666666666666666
107	number	0.0125
108	number	0.011111111111111112
109	number	0.01
112	number	0.008
115	number	0.00625
116	number	0.005555555555555556
117	number	0.005
120	number	0.004
123	number	0.003125
124	number	0.002857142857142857
125	number	0.0025
128	number	0.002
131	number	0.0015625
132	number	0.0013333333333333333
133	number	0.00125
136	number	0.001
139	number	0.0008
140	number	0.0006666666666666666
141	number	0.000625
144	number	0.0005
147	number	0.0004
148	number	0.0003333333333333333
149	number	0.0003125
152	number	0.00025
155	number	0.0002
156	number	0.00016666666666666666
157	number	0.00015625
160	number	0.000125

ShutterSpeed.OneThirdValues : enum

Kind: static enum of ShutterSpeed
Read only: true
Properties

Name	Type	Default
21	number	20
29	number	10
35	number	6
69	number	0.3
77	number	0.16666666666666666
83	number	0.1
91	number	0.05

ShutterSpeed.forLabel(label) ⇒ ShutterSpeed | null

Create instance for label.

Kind: static method of ShutterSpeed

Param	Type
label	string

StateEvent ⇐ ApiIdentifier

Kind: global class
Extends: ApiIdentifier

• StateEvent ⇐ ApiIdentifier
  • new StateEvent(identifier)
  • instance
    • .label : string
    • .identifier : number
    • .equalTo(other) ⇒ boolean
    • .Symbol_toPrimitive(hint) ⇒ string | number | null
    • .toJSON() ⇒ Object
  • static
    • .ID : enum

new StateEvent(identifier)

Encapsulate Object Event Identifiers For Easy Read And Debug

Param	Type
identifier	number

stateEvent.label : string

Kind: instance property of StateEvent
Read only: true

stateEvent.identifier : number

Kind: instance property of StateEvent
Read only: true

stateEvent.equalTo(other) ⇒ boolean

Kind: instance method of StateEvent
Overrides: equalTo

Param	Type	Description
other	number | StateEvent	The other value

stateEvent.Symbol_toPrimitive(hint) ⇒ string | number | null

Allows type cast to number and string. The string will be a hexadecimal code representation of the number

Kind: instance method of StateEvent

Param	Type
hint	string

stateEvent.toJSON() ⇒ Object

Kind: instance method of StateEvent

StateEvent.ID : enum

Kind: static enum of StateEvent
Read only: true
Properties

Name	Type	Default
AfResult	number	777
All	number	768
BulbExposureTime	number	784
CaptureError	number	773
InternalError	number	774
JobStatusChanged	number	770
PowerZoomInfoChanged	number	785
ShutDownTimerUpdate	number	772
Shutdown	number	769
WillSoonShutDown	number	771

TimeZone

Kind: global class
Implements: PropertyValue

• TimeZone
  • new TimeZone(value_)
  • instance
    • .label : string
    • .value : number
    • .zone : number
    • .difference : number
    • .toJSON() ⇒ Object
  • static
    • .Zones : enum

new TimeZone(value_)

TimeZone property value

Param	Type
value_	number

timeZone.label : string

Kind: instance property of TimeZone
Read only: true

timeZone.value : number

Kind: instance property of TimeZone
Read only: true

timeZone.zone : number

Kind: instance property of TimeZone
Read only: true

timeZone.difference : number

Kind: instance property of TimeZone
Read only: true

timeZone.toJSON() ⇒ Object

Kind: instance method of TimeZone

TimeZone.Zones : enum

Kind: static enum of TimeZone
Read only: true
Properties

Name	Type	Default
0	string	"None"
1	string	"Chatham Islands"
2	string	"Wellington"
3	string	"Solomon Island"
4	string	"Sydney"
5	string	"Adeladie"
6	string	"Tokyo"
7	string	"Hong Kong"
8	string	"Bangkok"
9	string	"Yangon"
10	string	"Dacca"
11	string	"Kathmandu"
12	string	"Delhi"
13	string	"Karachi"
14	string	"Kabul"
15	string	"Dubai"
16	string	"Tehran"
17	string	"Moscow"
18	string	"Cairo"
19	string	"Paris"
20	string	"London"
21	string	"Azores"
22	string	"Fernando de Noronha"
23	string	"São Paulo"
24	string	"Newfoundland"
25	string	"Santiago"
26	string	"Caracas"
27	string	"New York"
28	string	"Chicago"
29	string	"Denver"
30	string	"Los Angeles"
31	string	"Anchorage"
32	string	"Honolulu"
33	string	"Samoa"
34	string	"Riyadh"
35	string	"Manaus"
256	string	"UTC"
65535	string	"UTC"

Volume

Kind: global class

• Volume
  • instance
    • .label ⇒ string
    • .storageType ⇒ number
    • .isReadable ⇒ boolean
    • .isWritable ⇒ boolean
    • .freeCapacity ⇒ number
    • .maximumCapacity ⇒ number
    • .length ⇒ number
    • .getEntries() ⇒ Array.<DirectoryEntry>
  • static
    • .StorageType : enum

volume.label ⇒ string

Kind: instance property of Volume
Read only: true

volume.storageType ⇒ number

Storage type

Kind: instance property of Volume
Read only: true
See: Volume.StorageType

volume.isReadable ⇒ boolean

Kind: instance property of Volume

volume.isWritable ⇒ boolean

Kind: instance property of Volume

volume.freeCapacity ⇒ number

Kind: instance property of Volume

volume.maximumCapacity ⇒ number

Kind: instance property of Volume

volume.length ⇒ number

Entry count

Kind: instance property of Volume

volume.getEntries() ⇒ Array.<DirectoryEntry>

Kind: instance method of Volume

Volume.StorageType : enum

Kind: static enum of Volume
Read only: true
Properties

Name	Type	Default
CFast	number	5
CompactFlash	number	1
HardDrive	number	4
NoMemoryCard	number	0
SDCard	number	2

watchCameras ⇒ function

Watch for camera events

Kind: global constant
Returns: function - stop

Param	Type	Default
[timeout]	int	1000

cameraBrowser : CameraBrowser

Global CameraBrowser instance

Kind: global constant

EventCallback : function

Kind: global typedef

Param	Type
eventName	string
event	CameraDeviceEvent | ApiError

CameraPropertyValue : string | number | Array.<number> | PropertyValue

Kind: global typedef