This request returns a Cue Stack Info data structure for the specified cue stack. Use this response to determine which cues are active in a given cue stack.

URL:

/get.cgi?req=csi&name=<stackName>

Parameters:

  • name=<stackName> (optional)
    • The name of the desired cue stack.
    • If this parameter is not supplied, the default cue stack is assumed.

Response:

The following variable-length structure is returned by this request:

#define STACK_NAME_BUF_SIZE     16
#define CSI_TYPE_CUES           0
#define CSI_TYPE_PRESETS        1

typedef struct CueStackInfo {
    uint16_t            signature;              // Signature = 'CS'
    int16_t             version;                // Version = 0x0001 (or negative error code)
    char                stackName[STACK_NAME_BUF_SIZE]; // Name of stack
    uint8_t             type;                   // 0 = Cues, 1 = Presets
    uint8_t             playback;               // The playback number (for presets only)
    uint16_t            count;                  // Number of CueID/Status pairs
    uint32_t            data[64];               // Array of CueID/Status pairs (32 pairs max)
} CueStackInfo;

The CueID/Status pairs are included for any cue in the cue stack that is active in a playback fader. The CueID denotes the cue number and the Status value indicates in which playback fader the cue is active in. The CueID may have the value 0x40000000 added to it to indicate that the cue is active but modified.

 
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.