[Contents] [Intro] [Reference] [Tutorial] [Questions [New [Index]
Overview -> Reference -> API Reference -> Programmers Guide

daVinci API - Programmers Guide

This document is an overview of the API for programmers who want to connect their application with daVinci.

Commands of the API

After connecting your application program with daVinci (section "How to connect an Application" explains this topic in detail), you can start sending commands to the API. The "Overview of Commands" is a useful reference to browse the command syntax. The commands are divided into eight categories with respect to their semantic. They are build hierarchically with parenthesis according to the category they belong to, e.g. command menu(file(exit)). The following categories are available:

Answers from the API

All commands sent to the API are confirmed after execution by returning an answer which is usually the ok answer, but communication_error(...) when the command failed. Some commands (listed here) return another answer instead of ok.

The rest of the answers (listed here) are events that are triggered by the user (e.g. to inform the application about selection of a graph node). Events can occur at any time, except when an API command is currently executed and not yet confirmed. Your application is responsible for handling an event. The event may trigger an operation in the application or can simply be ignored.

Here are some important topics that need to be considered by an application connected to the daVinci API:


daVinci V2.0 Online Documentation - Page update: Jun 13, 1996