This request returns an Extended Command Context data structure for the specified command context. This structure contains detailed information about a command context.

URL:

/get.cgi?req=ecc&id=<contextID>

Parameters:

  • id=<contextID> (optional)
    • 0 specifies the default context (same as used by CueServer Studio) [Default].
    • 1 to 4 specifies User 1 thru User 4 contexts (for multi-user input).
    • 5 specifies the Ethernet context.
    • 6 specifies the Serial context.
    • 7 specifies the Rule Actions context.

Response:

The following variable-length data structure will be returned by this request.

typedef struct ECCDataV3 {
    uint16_t            signature;              // Signature = 'CS'
    int16_t             version;                // Version = 0x0003 (or negative error code)
    uint8_t             curPlayback;            // Current Playback (1..32)
    uint8_t             curTarget;              // Current Target
    uint8_t             isDMXTarget;            // Is curTarget a DMX channel selection?
    uint8_t             reserved[13];           // -
    FadeTimes           fadeTimes;              // Current Fade Times
    char                stackName[STACK_NAME_BUF_SIZE];     // Name of current playback's stack
    char                zoneName[STACK_NAME_BUF_SIZE];      // Name of current zone
    uint8_t             variableData[];         // Selection buffers (see below)
//  uint16_t            sizeofSelectData;       // Number of bytes in selectData
//  uint8_t             selectData[];           // RLE compressed selection bitmask (max 2064 bytes)
//  uint16_t            sizeofMaskData;         // Number of bytes in maskData
//  uint8_t             maskData[];             // RLE compressed mask bitmask (max 2064 bytes)
//  uint16_t            sizeofStationData;      // Number of bytes in stationData
//  uint8_t             stationData[];          // RLE compressed station bitmask (max 129 bytes)
} ECCDataV3;

 
Errors:

If an error occurs during the processing of the request, only the first four bytes of the above structure will be returned by this URL. The first two bytes will have the “CS” signature and the next two bytes will contain an error value as described by the following table:

Error Value Description
-1 An internal shared memory error occurred.
-2 An invalid contextID was given.