Recorded Announcement Download Initiate 0x0052

SwitchKit Name

RecAnnDownloadInit

Type

EXS API and SwitchKit API message

Description

This is the first message sent by the host to initiate the downloading of a recorded announcement to a VRAS SIMM. If multiple SIMMs are to have the same announcement, each SIMM must be downloaded separately. If you try to use this message for the DSP Series 2 card, the Matrix Controller Series 3 card NACKs it.

For SwitchKit

This message downloads a voice file to a VRAS board on the Excel platform. The format and encoding correspond to the arguments of the RecAnnDownloadInitiate message. The slot and SIMM must refer to a valid VRAS SIMM, and the ID is used to reference this prompt from future messages. If the voice file is already present on the SIMM, the SwitchManager bypasses the downloading. If there is another voice file with that ID already on the SIMM, then the configuration fails. The VRAS SIMM must be cleared with a RecAnnDelete before the new voice file is downloaded.

Sent by

Host (SwitchManager for SwitchKit)

Example Message (Socket Log Output for SwitchKit)

See Recorded Announcement Download 0x0053 for the socket log output/example of the Recorded Announcement Download Initiate message and a Recorded Announcement Download message together.

SwitchKit Code

Configuration

RecordedAnnouncement(

file = quoted string,

slot = integer,

SIMM = integer,

id = integer,

format = integer,

encoding = integer

);

C Structure

typedef struct {

UBYTE Slot;

UBYTE SIMM;

unsigned short ID;

int Size;

int Checksum;

UBYTE Format;

UBYTE Encoding;

} XL_RecAnnDownloadInit;

C++ Class

class XLC_RecAnnDownloadInit : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getSIMM() const;

void setSIMM(UBYTE x);

unsigned short getID() const;

void setID(unsigned short x);

int getSize() const;

void setSize(int x);

int getChecksum() const;

void setChecksum(int x);

UBYTE getFormat() const;

void setFormat(UBYTE x);

UBYTE getEncoding() const;

void setEncoding(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 (0x0052)

3, 4

Message Type (0x0052)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

Address Method

0x00 - Individual AEs

8, 9

Response Status (MSB, LSB)

0x000A Invalid RAN Size
When the RAN_SIZE is larger than the
permitted size of 16,777,215 bytes
(0xFFFFFF), this response is returned in
the negative acknowledgment to the
Recorded Announcement Download
Initiate 0x0052
message.

Number of AEs to follow

AE

0x12 DSP SIMM

10

Checksum

:

RAN ID (MSB, LSB)

:

Announcement ID (MSB, LSB)

A number the host assigns to identify the announcement (0x00–0xFFF).

:

Announcement Size

A long word (4 bytes) with the number of bytes in the announcement to be downloaded.

:

Announcement Checksum

A long word (4 bytes) containing the simple sum of all the data bytes of the announcement.

:

Announcement Format

0x00 8-bit PCM

:

Encoding Format

0x00 A-law

0x01 µ-law

:

Checksum