Presets

The camera organizes modes of operation into Presets which consist of a camera mode and some corresponding settings.

The set of available Presets is dependent on the camera’s current state such as the currently active settings. Therefore, it is possible that the camera can be in a state where certain Presets can not currently be set. Special attention should be paid to the following settings since these have a drastic effect on the set of currently available Presets:

• Control Mode

Recommended Usage

The set of available Presets / Preset Groups can be found using Get Available Presets. Depending on the camera, this may be returned as a flat list or further separated into Preset Groups. It is possible for the groupings to vary per camera. Also, none of the following Preset attributes are consistent across cameras:

• Preset ID

• Preset Title ID

• Preset Icon ID

The recommended procedure to query and set Presets is:

1. Get Available Presets to retrieve a hierarchy of Preset Groups

2. Flatten all the Preset Groups into a flat list of Presets

3. Identify the desired Preset by its Preset Title ID

4. Use the Preset ID from step 3 to load the Preset with Load Preset

Preset Modified Status

Status 98 returns the camera’s Preset Modified Status value.

The value of this status is set to zero when the client sends a Get Preset Status message to the camera.

The value of this status is set to a non-zero value when:

• Preset settings submenu is exited in the camera UI (whether any settings were changed or not)

• A new preset is created

• A preset is deleted

• Preset ordering is changed within a preset group

• A preset is reset to factory defaults

Operations

Get Available Presets

Type:

Protobuf

Request

Get the set of currently available presets and optionally register to be notified when it changes.

Response: NotifyPresetStatus sent immediately

Notification: NotifyPresetStatus sent periodically as preset status changes, if registered.

The preset status changes when:

• A client changes one of a preset’s captioned settings via the API

• The user exits from a preset’s settings UI on the camera (e.g. long-press the preset pill and then press the back arrow)

• The user creates/deletes/reorders a preset within a group

UUID:

Query

Feature ID:

0xF5

Action ID:

0x72

Message:

RequestGetPresetStatus (docs) (source)

Response

Current Preset status

Sent either:

• Synchronously via initial response to RequestGetPresetStatus

• Asynchronously when Preset change if registered in RequestGetPresetStatus

UUID:

Query Response

Feature ID:

0xF5

Action ID:

0xF2

Message:

NotifyPresetStatus (docs) (source)

Notification

Current Preset status

Sent either:

• Synchronously via initial response to RequestGetPresetStatus

• Asynchronously when Preset change if registered in RequestGetPresetStatus

UUID:

Query Response

Feature ID:

0xF5

Action ID:

0xF3

Message:

NotifyPresetStatus (docs) (source)

Load Preset

Type:

TLV command

ID:

0x40

Load preset by ID.

A preset can only be loaded if it is currently available where available preset IDs can be found from Get Available Presets

Request

UUID:

Command

Parameters:

• preset (uint32) - preset ID

Response

UUID:

Command Response

Load Preset Group

Type:

TLV command

ID:

0x3E

The available group ID values can be found in EnumPresetGroup

Request

UUID:

Command

Parameters:

• preset (uint32) - preset group ID

Response

UUID:

Command Response

Update Custom Preset

Type:

Protobuf

Request

Request to Update the Title and / or Icon of the Active Custom Preset

This only operates on the currently active Preset and will fail if the current Preset is not custom.

The use cases are:

1. Update the Custom Preset Icon

   • icon_id is always optional and can always be passed

and / or

2. Update the Custom Preset Title to a…

   • Factory Preset Title: Set title_id to a non-PRESET_TITLE_USER_DEFINED_CUSTOM_NAME (94) value

   • Custom Preset Name: Set title_id to PRESET_TITLE_USER_DEFINED_CUSTOM_NAME (94) and specify a custom_name

Returns a ResponseGeneric with the status of the preset update request.

UUID:

Command

Feature ID:

0xF1

Action ID:

0x64

Message:

RequestCustomPresetUpdate (docs) (source)

Response

Generic Response used across many response / notification messages

UUID:

Command Response

Feature ID:

0xF1

Action ID:

0xE4

Message:

ResponseGeneric (docs) (source)