Conference Delete Request 0x004C

SwitchKit Name

ConferenceDeleteRequest

Type

EXS API and SwitchKit API message

Description

NOTE: If you are using the DSP Series 2 card, use the Resource Delete 0x0126 message to delete a conference.

Use this message to delete a conference on the MFDSP or DSP-ONE card. A response Status value of positive acknowledgment (0x0010) indicates that conference deletion has been "initiated" by the Excel platform. When deletion is complete, the Excel platform will send a Conference Deleted message to the host.

To delete all conferences, specify 0xFFFF in the Conference ID field.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short ConferenceID;

UBYTE ForcedFlag;

} XL_ConferenceDeleteRequest;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short ConferenceID;

} XL_ConferenceDeleteRequestAck;

C++ Class

class XLC_ConferenceDeleteRequest : public XLC_OutboundMessage {

public:

unsigned short getConferenceID() const;

void setConferenceID(unsigned short x);

UBYTE getForcedFlag() const;

void setForcedFlag(UBYTE x);

};

C++ Class Response

class XLC_ConferenceDeleteRequestAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getConferenceID() const;

void setConferenceID(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 (0x0009)

3, 4

Message Type (0x004C)

3, 4

Message Type (0x004C)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

Status (MSB, LSB)

10, 11

Conference ID (MSB, LSB)

12

Checksum

8, 9

Conference ID (MSB, LSB)

Number assigned to the conference in the Response to the Conference Create message.

NOTE: For this field, the value 0xFFFF has a special meaning (Delete all conferences)

10

Forced Flag

0x00 Graceful deletion

The conference will be deleted after all the channels in the conference are released.

 

0x01 Forced deletion

All channels involved in the conference will be released or parked
(according to their configured Release Mode) and the conference will be deleted.

11

Checksum