Recorded Announcement Disconnect 0x0056

SwitchKit Name

RecAnnDisconnect

Type

EXS API and SwitchKit API message

Description

This message allows the host to disconnect a channel from a voice recorded announcement.

The RAN Disconnect message may be used to cancel only RAN Play requests made with the RAN Connect message, which can be used only for RAN IDs below 4096.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

} XL_RecAnnDisconnect;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short Span;

UBYTE Channel;

} XL_RecAnnDisconnectAck;

C++ Class

class XLC_RecAnnDisconnect : public XLC_OneChannelOutbound {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

};

C++ Class Response

class XLC_RecAnnDisconnectAck : 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 (0x00NN)

3, 4

Message Type (0x0056)

3, 4

Message Type (0x0056)

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

AE

0x0D Channel

:

Checksum

:

AIB (same as message)

:

Checksum

This message always returns a positive acknowledgment (ACK).