Parameters Type Description Possible Input
sessionId String Unique session identifier obtained fromthe camera.startSession command.
Composed by 10 characters.
options Object Multiple properties (<key, value> pairs) to be set.
invalidParameterName : any input parameter is unrecognized.
Command Input Command Output Output Error
{"parameters" :{
"sessionId": "XXXXXX", "options": {
"captureMode": "XXXX"
}
cURL Example
curl X POST H "contenttype: application/json" http://192.168.1.168/osc/commands/execute d '{"name":
"camera.setOptions", "parameters": {"sessionId": "XXXXXXXXXX", "options": {"_videoBitrate": XX } }}'
c. Options
The following table shows all the options that can be changed and/or obtained by camera.setOptions and camera.getOptions. An option cannot be changed when its corresponding support is empty or only contains one option, e.g. when "shutterSpeedSupport" is empty (auto mode), clients cannot setOptions for "shutterSpeed". So, it is camera’s responsibility to update the available options whenever needed. “xxxSupport” options are NOT allowed to be set by clients.
Name Type Description
captureMode String Current capture mode. Default to “_video”.
captureModeSupport String Array List of capture modes currently available.
[“_video”, “image”, “_burst”, “_timelapse”,
“_setting”, “_live”]. “_live” mode is not available on battery mode.
exposureMode Number Current exposure mode, default to 0 (auto exposure).
exposureModeSupport Number
Array
List of exposure modes currently available
“ExposureMode”.
0 = Auto exposure 1 = Manual exposure
shutterSpeed Number Current shutter speed setting in microseconds.
shutterSpeedSupport Number
Array
List of shutter speeds currently available, e.g. [50, 100…2000, 5000] or [] when it is in “auto” mode.
whiteBalance String Current white balance setting, e.g. “_shadow”.
Default to “_auto_normal”.
whiteBalanceSupport String Array List of white balance settings currently available, which can be a subset of our predefined list:
[ “_auto_wide”, “_auto_normal”, “_sunny”,
“_shadow”, “_indoor”].
fileFormat Object Current image type and resolution, e.g.
{
“type”: “jpeg”, “width”: 4096, “height”: 2048 }
fileFormatSupport Object Array List of the file formats currently available. Results depends on the current captureMode, e.g.
{
exposureDelay Number Current delay between the takePicture command and when the exposure is started, in seconds.
exposureDelaySupport Object Range of exposure delays currently available, in seconds.
_hdrInCam* Boolean Turn embedded HDR status on/off. Default value is “false”.
hdrSupport Boolean Value must be ‘true’ or ‘false’ depending on if the camera supports this.
exposureBracket Object Current exposure bracket setting, with two entries,
"shots", an integer containing the number of shots to be taken, and "increment", a number containing fstop increment between shots. Relevant if "hdr"
option is enabled.
exposureBracketSupport
_timelapseInterval Number Current interval between two consecutive capturing pictures on “_timelapse” captureMode in seconds.
_timelapseIntervalSupport Number Array
Timelapse interval settings currently available in seconds. [1, 2, 5, 10, 15, 20, 30]
_burstDuration Number Current duration in second of capturing pictures on “_burst” captureMode.
_burstDurationSupport Number Array
List of “_burst” mode duration delays in seconds.
[5, 10, 15, 30]
_videoBitrate Number Current video encoding bitrate in bit/s.
minBitrate = 500000 maxBitrate = 20000000
_videoBitrateSupport Object Min and max encoding bitrate supported by the camera in bit/s. _videoFramerate Number Current video frame rate value in fps.
*Option available only on live mode
_videoFramerateSupport Object Min and max encoding frame rate supported by the camera in bit/s.
_recordFramerateBitrate Number video recording parameters:
0 : 30fps/15Mbps 1: 25fps/20Mbps
Defaut is 1.
_sensorMode String Current sensor mode used in “_video” mode.
“singleMode” : a single optical sensor is used.
“360Mode” : the three optical sensors are used outputting a spherical video.
Default is “360Mode”
_sensorModeSupport String Array List of sensor modes available in “_video” mode.
[ “singleMode”, “360Mode”]
_sensorNumber Number Current sensor used in “singleMode”: 1, 2 or 3.
Default is 1.
Cf : “360cam sensor index”.
_sensorNumberSupport Number
Array
List of _sensorNumber parameter inputs available.
[1, 2, 3]
gyro Boolean Turn camera Gyroscope module on/off. Value
must be ‘true’ or ‘false’. Default value is ‘true’ It can be set to true only when "gyroSupport" is
‘true’.
gyroSupport Boolean If the camera has a gyroscope, this value should be ‘true’, otherwise, ‘false’.
_dpcMode Boolean Video defective pixel correction mode.
false: soft DPC (less strong) true: hard DPC
Default value is ‘false’.
_rotationFlag Boolean Enable/Disable auto rotation metadata. Default value is ‘true’.
gpsPosition Object gpsPosition help GPS to hang signal faster by providing the position and the date/hour of the moment. The format is :
{
imageStabilization String Current image stabilization operation, e.g. "off"
Always “off” when gyro is ‘false’
imageStabilizationSupport String Array Image stabilization operations currently available.
Our predefined list is :
[ "off", "_horizontal_stabilization",
"_vibration_correction" ].
totalSpace Number Number of bytes of total storage. Cannot be set.
remainingSpace Number Number of bytes of free storage. Cannot be set.
remainingPictures Number Estimated number of remaining pictures based on current capture setting. Cannot be set.
remainingVideo Number Remaining record time available in seconds for video mode. Cannot be set.
_SDcardState Number SD card current state.
0: No SD card
1: Bad Filesystem format on SD card
2: SD card inserted and mounted
3: SD card full memory space
batteryLevel Number Expressed as a percentage of the battery
remaining.
dateTimeZone String Current date and time information. May be set by setOptions using phone’s date time and time zone. The format is "YYYY:MM:DD HH:MM:SS
the date and time separated by one blank character and one blank character between time and time and time zone. Time zone is an offset from the UTC time, e.g. 2014:05:18 01:04:29 +0200 means UTC+2.
d. Appendix
360cam sensor index