You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Recorded Announcement Connect 0x0055
Recorded Announcement Connect 0x0055
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
Use this message to connect a channel to one or a series of downloaded voice recorded announcements (RANs).
NOTE: You can use this message for the DSP Series 2 card, but only for RAN IDs below 4096. In Excel platforms using the DSP Series 2 card with the DSP-ONE card, the Matrix Controller examines the announcement ID(s) and determines if there are any DSP-ONE cards that can play the entire list of announcements. If there is no DSP-ONE card that can do this, the request is passed to the DSP Series 2 card. Because of this, all the announcements must be accessible via NFS.
Sent by
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
UBYTE Config;
UBYTE Event;
UBYTE Cnt;
unsigned short ID1;
unsigned short ID2;
unsigned short ID3;
unsigned short ID4;
unsigned short ID5;
unsigned short ID6;
unsigned short ID7;
unsigned short ID8;
unsigned short ID9;
unsigned short ID10;
UBYTE OtherIDs[200];
} XL_RecAnnConnect;
C Structure Response
typedef struct {
unsigned short Status;
unsigned short Span;
UBYTE Channel;
} XL_RecAnnConnectAck;
C++ Class
class XLC_RecAnnConnect : public XLC_OneChannelOutbound {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getConfig() const;
void setConfig(UBYTE x);
UBYTE getEvent() const;
void setEvent(UBYTE x);
UBYTE getCnt() const;
void setCnt(UBYTE x);
unsigned short getID1() const;
void setID1(unsigned short x);
unsigned short getID2() const;
void setID2(unsigned short x);
unsigned short getID3() const;
void setID3(unsigned short x);
unsigned short getID4() const;
void setID4(unsigned short x);
unsigned short getID5() const;
void setID5(unsigned short x);
unsigned short getID6() const;
void setID6(unsigned short x);
unsigned short getID7() const;
void setID7(unsigned short x);
unsigned short getID8() const;
void setID8(unsigned short x);
unsigned short getID9() const;
void setID9(unsigned short x);
unsigned short getID10() const;
void setID10(unsigned short x);
const UBYTE *getOtherIDs() const;
UBYTE *getOtherIDs();
void setOtherIDs(UBYTE *x);
};
C++ Class Response
class XLC_RecAnnConnectAck : public
XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE 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 (0x0007) |
3, 4 |
Message Type (0x0055) |
3, 4 |
Message Type (0x0055) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
:
|
Address Method 0x00 - Individual AEs |
||
Number of AEs to follow |
|||
AE |
8, 9 |
||
10, 11 |
State (MSB, LSB) If the preceding Status field is a positive acknowledgement, this field does not apply. |
||
: |
AIB (same as message) |
||
: |
Checksum |
||
: |
Configuration Flag This field is a bit mask. Bit 0 If set, enables Barge-In feature. The channel connects to an announcement even if the
1-7 Reserved (must be 0x00) |
||
: |
Event Flag This field is a bit mask.
Bit 0 - If set, a Call Processing Event of "Recorded Announcement Completed" (0x26) is
1 - If set, a Call Processing Event of "Recorded Announcement Started" (0x25) is generated when the announcement starts.
2-7 - Reserved (Must be 0x00) |
||
: |
Announcement Count (n) Number of announcements to follow. The host can chain together multiple announcements to |
||
: |
Announcement ID [0, 1] |
||
: |
Announcement ID [2, 3] |
||
: |
: |
||
: |
Announcement ID [x, y] |
||
: |
Checksum |