Skip to main content
Every property supports hex values from the GET response — hex always works. Many properties also accept human-readable formats ("1/125", "f/2.8", "400"). Always GET the property first to see what your specific camera supports. See the auto-generated API reference for full request/response schemas.

Get Property

GET /api/cameras/{cameraId}/properties/{propertyName} — returns current value, human-readable format, writability flag, and all values the camera currently accepts.
curl http://localhost:8080/api/cameras/D10F60149B0C/properties/shutter-speed

Set Property

PUT /api/cameras/{cameraId}/properties/{propertyName} — set a camera property. Accepts hex values from available_values or human-readable strings.
FormatExampleDescription
Hex"0x1007d"Copy from GET response available_values — always works
Human-readable"1/125"For shutter speed
F-stop"f/5.6"For aperture
Decimal"400"For ISO
String enum"wide"For focus area, drive mode, etc.
The safest approach: GET the property first, pick a value from available_values, and send it back in your PUT.
curl -X PUT http://localhost:8080/api/cameras/D10F60149B0C/properties/shutter-speed \
  -H "Content-Type: application/json" \
  -d '{"value": "0x100fa"}'
The server validates against the camera’s current available_values and checks writability before sending to the SDK. If the property is not writable (e.g. shutter speed in Aperture Priority mode), you’ll get a 400 error.

Get All Properties

GET /api/cameras/{cameraId}/properties/all — returns all mapped properties with their current formatted values.
curl http://localhost:8080/api/cameras/D10F60149B0C/properties/all

Priority Key

Priority key must be set to pc-remote before the camera accepts any property changes or shooting commands.
  • GET /api/cameras/{cameraId}/priority-key — read current setting
  • PUT /api/cameras/{cameraId}/priority-key — set pc-remote or camera-position
curl -X PUT http://localhost:8080/api/cameras/D10F60149B0C/priority-key \
  -H "Content-Type: application/json" \
  -d '{"setting": "pc-remote"}'

Property Reference

All 56 properties organized by category. Every property supports hex values from the GET response — hex always works. Always GET the property first to see what your specific camera supports.
Properties marked R/W can be read and written. Read-only properties return data but reject SET requests. Some R/W properties may be read-only depending on the camera’s current mode.

Core Exposure

PropertyR/WDescription
isoR/WISO sensitivity (Auto, 125, 200, 400, …)
apertureR/WF-number (f/1.4, f/2.0, …, f/22)
shutter-speedR/WShutter speed (1/8000, …, 30s, Bulb)
exposure-program-modeR/WP, A, S, M, Auto, Movie modes
exposure-compensationR/WExposure bias (+/- EV steps)
exposure-stepR/WEV step size (1/3 or 1/2)
metering-modeR/WMulti, Center, Spot, Highlight, etc.
ae-lockR/WAuto-exposure lock (Off / On)

Focus & Zoom

PropertyR/WDescription
focus-modeR/WManual, AF-S, AF-C, AF-A, DMF
focus-areaR/WWide, Zone, Center, Flexible Spot, Tracking
focus-positionR/WAbsolute position 0-65535
focus-position-currentRead-onlyActual lens position
focus-driving-statusRead-onlyNot Driving / Driving
focus-distanceRead-onlyDistance in 1/1000 meter units
zoom-distanceRead-onlyFocal length in 0.001mm units
zoom-settingR/WOptical Zoom / Clear Image Zoom / Digital Zoom

White Balance

PropertyR/WDescription
white-balanceR/WAuto, Daylight, Shade, Cloudy, etc.
white-balance-color-tempR/WColor temperature in Kelvin (range: 2500-9900K)
awb-lockR/WAuto white balance lock (Off / On)

Drive & Shutter

PropertyR/WDescription
drive-modeR/WSingle, Continuous Hi/Lo, Timer, Bracket
shutter-typeR/WAuto, Mechanical, Electronic
shutter-modeR/WSpeed (shutter speed) / Angle (shutter angle)
shutter-angleR/WShutter angle in degrees (when shutter-mode = Angle)
silent-modeR/WSilent (electronic) shutter (Off / On)
flicker-less-shootingR/WAnti-flicker shooting (Off / On)

Flash

PropertyR/WDescription
flash-modeR/WOff, Auto, Fill, Rear Sync, Slow Sync
flash-compensationR/WFlash exposure compensation (+/- EV)
wireless-flashR/WWireless flash control (Off / On)

Image Format

PropertyR/WDescription
file-formatR/WRAW, JPEG, RAW+JPEG, HEIF
image-qualityR/WFine, Standard, Extra Fine
raw-compressionR/WUncompressed, Compressed, Lossless
image-sizeR/WL, M, S image resolution
aspect-ratioR/W3:2, 16:9, 1:1, 4:3
color-spaceR/WsRGB, AdobeRGB
still-image-store-destinationR/WHost PC (0x1), Memory Card (0x2), Both (0x3)

Image Processing

PropertyR/WDescription
droR/WD-Range Optimizer (Off, Auto, Lv1-Lv5)
high-iso-nrR/WHigh ISO noise reduction (Off, Low, Normal)
long-exposure-nrR/WLong exposure noise reduction (Off / On)
creative-lookR/WST, PT, NT, VV, VV2, FL, IN, SH, BW, SE
picture-profileR/WPP1-PP11, Off
aps-c-s35R/WAPS-C / Super 35mm crop mode (Off / On / Auto)

Stabilization

PropertyR/WDescription
image-stabilizationR/WSteadyShot for stills (Off / On)
movie-stabilizationR/WSteadyShot for video (Off / Standard / Active)

Video Recording

PropertyR/WDescription
recording-stateRead-onlyNot Recording / Recording
movie-file-formatR/WXAVC S 4K, XAVC S HD, XAVC HS 4K, etc.
movie-recording-settingR/WResolution/bitrate combination
movie-recording-frame-rateR/W24p, 30p, 60p, 120p, etc.
audio-recordingR/WAudio recording on/off
audio-input-master-levelR/WAudio input level (range: 0-31)

Timecode

PropertyR/WDescription
timecode-presetR/WTimecode preset value
timecode-formatR/WDrop Frame (DF) / Non-Drop Frame (NDF)
timecode-runR/WRec Run / Free Run
timecode-makeR/WPreset / Regenerate

CineEI & LUT

PropertyR/WDescription
movie-shooting-modeR/WNormal / CineEI / CineEI Quick / Flexible ISO
movie-shooting-mode-color-gamutR/WS-Gamut3.Cine, S-Gamut3, etc.
base-look-import-enableRead-onlyWhether base look import is available
embed-lut-fileR/WEmbed LUT in recording (Off / On)
pp-lut-base-lookR/WUser base look selection for Picture Profile LUT
exposure-indexR/WExposure Index in CineEI mode (e.g. 800 EI)
base-isoR/WBase ISO sensitivity (High / Low)
base-look-valueR/WActive base look / LUT with real names (e.g. “s709”, “User5:February.cube”)
shutter-angleR/WShutter angle in 1/1000° units

License & Image ID

PropertyR/WDescription
shooting-enableR/WEnable/disable shutter operation (license-gated)
image-id-stringR/WMakerNote string ID (Exif tag 0x2043, UTF-16)
image-id-string-max-lengthRead-onlyMaximum string length the camera accepts
image-id-numR/WMakerNote numeric ID (UInt64 range)
image-id-num-settingR/WEnable/disable numeric ID writing (Off / On)

Battery & Media

PropertyR/WDescription
battery-remainRead-onlyBattery percentage (0-100%)
overheating-stateRead-onlyCamera thermal state
media-slot1-statusRead-onlySlot 1 media status
media-slot1-remaining-photosRead-onlyRemaining photos on slot 1
media-slot1-remaining-timeRead-onlyRemaining recording time on slot 1 (seconds)
media-slot2-statusRead-onlySlot 2 media status
media-slot2-remaining-photosRead-onlyRemaining photos on slot 2
media-slot2-remaining-timeRead-onlyRemaining recording time on slot 2 (seconds)

Notable property notes

shutter-speed

Shutter speed is only writable in Manual (M) or Shutter Priority (S) mode. In P or A mode, the camera controls it and writable will be "false".

exposure-compensation

Values are signed — the server formats them as EV (e.g. “+1.0 EV”, “-2.0 EV”, “0.0 EV”). The step size depends on exposure-step (1/3 or 1/2 EV). Negative values use two’s complement (e.g. 0xf830 = -2.0 EV).

white-balance-color-temp

Range property. Min 2500K, Max 9900K, Step 100K. Set white-balance to Color Temp (0x8003) first, then adjust the temperature.

still-image-store-destination

Set to 0x1 (Host PC) or 0x3 (Both) for auto-transfer in remote mode. Also requires SetSaveInfo path to be configured.

shutter-angle / shutter-mode

Primarily available on cinema cameras (FX3A, FX3, FX2, FX30). Set shutter-mode to Angle (0x2) first. Values are in 1/10 degree units (e.g. 1800 = 180.0°). Value 0x0 = Off.

creative-look / picture-profile

Available look/profile slots vary by camera — A9 III supports 9 looks, A7 IV supports 8 looks; FX30 supports 13 profiles, A9 III supports 9, A7 IV supports 3. Custom slots (0x410x44) are used with PPLUT workflows.

movie-shooting-mode

Values: Normal (0x0001), CineEI (0x0301), CineEI Quick (0x0302), Flexible ISO (0x0201). See the CineEI guide for full workflows.

pp-lut-base-look

Only writable when picture-profile is set to a Custom slot (0x410x44 = Custom 1–4). Shows PPLUT 1–8 as options. May appear read-only in getAllProperties — use an individual GET for accurate state.

exposure-index / base-iso

Set movie-shooting-mode to CineEI (0x0301) first. The available EI values depend on base-iso — always re-read exposure-index after changing base-iso.

base-look-value

Requires CineEI mode (movie-shooting-mode = 0x0301). The first request may take ~3 seconds as the server fetches display strings from the camera. Returns real LUT names (e.g. “User5:February.cube”) when available; falls back to “Preset 1”, “User 5”, etc.

shooting-enable

Setting to Disabled (0x2) blocks all shutter operations via the SDK. License-gated — see Guardrails.

image-id-string

  • Stored as UTF-16BE in the SDK, decoded to UTF-8 in the API response
  • Maximum length from image-id-string-max-length (default 64, up to 128 chars)
  • Setting an empty string "" clears the Exif tag from subsequent images
  • With a license enabled, supports alphanumeric + symbols: . - _ ' @ ! ? # $ % & * + / = ^ { | } ~ ( ) : ; < > [ \ ] space
The string is embedded in the next image after setting. If you shoot immediately after setting, it may not be recorded — wait for the property change confirmation via SSE propertyChanged event.

image-id-num / image-id-num-setting

Enable numeric ID writing first (image-id-num-setting = 0x2), then set image-id-num (UInt64 range, decimal strings only — no hex).
image-id-num-setting resets to Off when the camera is powered off or PC Remote is disconnected. You must re-enable it each session.
For typed property getters and setters, use the SDK pages: TypeScript, Python, or Swift.