You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Recorded Announcement Query 0x0057

Recorded Announcement Query 0x0057

SwitchKit Name

RecAnnQuery

Type

EXS API and SwitchKit API message

Description

Recorded Announcement Query 0x0057

This message allows the host to query information about the announcements stored on a VRAS SIMM. The information is reported to the host via the Recorded Announcement Report message:

• If announcements are stored on the SIMM, the response to this message indicates the number of announcements stored on the specified SIMM.

• If no announcements are stored on the VRAS SIMM, the CSP does not send a report.

In the Recorded Announcement Report message, the host will receive the ID, size, checksum, format, and encoding format for each announcement stored on the specified SIMM.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE SIMM;

} XL_RecAnnQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Slot;

UBYTE SIMM;

unsigned short AnnounceCount;

} XL_RecAnnQueryAck;

C++ Class

class XLC_RecAnnQuery : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getSIMM() const;

void setSIMM(UBYTE x);

};

C++ Class Response

class XLC_RecAnnQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getSIMM() const;

void setSIMM(UBYTE x);

unsigned short getAnnounceCount() const;

void setAnnounceCount(unsigned short x);

};

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x00NN)
3, 4 | Message Type (0x0057) | 3, 4 | Message Type (0x0057)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB)
Number of AEs to follow | 10 | AIB (same as message)
AE 0x12 DSP SIMM | : | Announcement Count (MSB, LSB) The total number of announcements on the specified VRAS SIMM.
: | Checksum | : | Checksum

Voice Recorded Announcement System
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Most Significant Bit
Least Significant Bit