digiCamControl

For detailed information regarding the library, API, and development guides, visit the official developer documentation website.

http://www.digicamcontrol.com/doc/development/lib

The behavior of the Dialog command changes based on the Type property:

• Message: Displays a standard message box with an OK button. Does not affect workflow flow unless Error is set.
• Warning: Displays a message box with a warning icon and an OK button.
• YesNo: Displays a question dialog with Yes and No buttons. If the user selects No, the command returns false, which typically halts the workflow execution.
• SaveFile: Opens a system SaveFileDialog.
  • Uses FileNameFilter for file extensions.
  • Uses the value of the specified Variable as the initial filename.
  • If the user confirms the save, the new file path is written back to the specified Variable.
  • If the user cancels, the command returns false and halts the workflow.

The Overlay command is a workflow plugin used to apply image overlays (watermarks) or text annotations to images. It supports both file-based overlays and dynamic text rendering with customizable fonts, colors, and positioning.

// Conceptual representation of an Overlay command configuration
{
  "Command": "Overlay",
  "Properties": {
    "OverlayFile": "path/to/watermark.png",
    "StrechOverlay": true,
    "Position": "Center",
    "Transparency": 80,
    "Text": "Hello World\nNew Line",
    "TextPointSize": 50,
    "TextFillColor": "Red",
    "TextStrokeColor": "Blue",
    "TextFont": "Arial",
    "TextPosition": "BottomRight",
    "TextTransparency": 100
  }
}

The WorkflowAction command is a plugin type used within a workflow to trigger specific internal system actions or navigate between views. It operates by sending messages to the WorkflowManager.

To use this command, you must configure two primary properties:

1. Action: A selection from a predefined list of available system actions.
2. ViewName: (Required only for the ShowView action) The name of the view to navigate to.

Commonly used actions include session management (FinishSession, CancelSession), navigation (ShowView, PreviousView), and photo management (NextPhoto, PrevPhoto, DeletePhoto, ClearPhotos).

/* Example configuration of a WorkflowAction command */
// Action: "ShowView"
// ViewName: "YourTargetViewName"

The TriggerEvent command allows you to trigger system-wide messages within the digiCamControl workflow engine. When executed, it broadcasts a message containing a specific event name and an optional message string. This is useful for signaling other parts of the workflow or external listeners that a specific milestone has been reached.

To use this command, you must provide two properties:

1. Event: A string representing the name of the event to trigger.
2. Message: A string containing the message payload associated with the event.

If the Event property is empty or whitespace, the command will fail to execute.

/* 
Properties required for TriggerEvent:

- Event (String): The name of the event to trigger.
- Message (String): The message content to accompany the event.
*/

The Wait command is a workflow plugin used to introduce a delay during the execution of a capture workflow. It pauses the workflow for a specified number of seconds before proceeding to the next command.

Configuration

When configuring the Wait command, you must provide the following property:

• Seconds: A numeric value representing the duration of the pause.
  • Type: Number
  • Default: 1
  • Allowed Range: 1 to 100 seconds.

// Example configuration for a Wait command
{
  "CommandName": "Wait",
  "Properties": {
    "Seconds": 5
  }
}

The ShellExecute command allows you to execute external shell commands or applications as part of a capture workflow. It requires two specific properties to be configured in the command object:

1. Executable: A string representing the path to the executable file or the command to run.
2. Parameter: A string containing the arguments or parameters to pass to the executable.

When the command is triggered, it uses the Utils.Run utility to launch the process with the provided executable and parameters.

// Conceptual configuration of the ShellExecute command properties
var command = new WorkFlowCommand();
command.Properties.Add(new CustomProperty { Name = "Executable", Value = "C:\Path\To\App.exe" });
command.Properties.Add(new CustomProperty { Name = "Parameter", Value = "--arg1 value1" });

The CameraAction command is a workflow plugin used to trigger specific hardware operations on the connected camera device. It is configured via a set of properties, primarily the Action property which determines the operation to perform.

Properties

• Action (ValueList): The specific camera operation to execute.
• Param1 (String): An optional parameter for the action.
• Param2 (String): An optional parameter for the action.

/* 
Configuration for CameraAction command:

Action: ["Capture", "CaptureNoAf", "StartLiveView", "StopLiveView", "Autofocus", "CaptureToPc", "CaptureToCard", "EnableCapture", "DisableCapture"]
Param1: string
Param2: string
*/

The Level command is an image processing plugin used to adjust the levels (brightness/contrast) of an image within a workflow. It allows you to define specific points for black, white, and midtones to re-map the image's color distribution.

This command uses workflow variables for its parameters, allowing for dynamic adjustments based on previous steps in the workflow.

// Example configuration of LevelAction properties
{
  "DisplayName": "Level",
  "Group": "ImageProcessing",
  "Properties": {
    "BlackPoint": "0",
    "MidPoint": "0",
    "WhitePoint": "0"
  }
}