Resource Connect 0x0127

SwitchKit Name

ResourceConnect

Type

EXS and SwitchKit API message

Description

Resource Connect 0x0127

Use this message to connect to a resource.

Connect to a Child Conference

Use the Channel AIB and the Child Conference AIB. The Channel AIB indicates the Channel to be moved from the parent conference to the child conference. The Child Conference ID AIB indicates both the parent and child conference IDs.

NOTE: For the SwitchKit code, you must specify the span and channel before you specify the conference ID.

Sent by

Host application

Related API Messages

Resource Create (0x0124)

Resource Modify (0x125)

Resource Delete (0x126)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceConnect;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_ResourceConnectAck;

 

C++ Class

class XLC_ResourceConnect: public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getChannelSlot() const ;

void setChannelSlot(UBYTE x)

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

XBYTE getSpan() const ;

void setSpan(XBYTE x);

UBYTE getChannel() const ;

void setChannel(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE *getData() const ;

UBYTE *getData();

void setData(UBYTE *x) ;

};

C++ Class Response

class XLC_ResourceConnectAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

XBYTE getSpan() const ;

void setSpan(XBYTE x);

UBYTE getChannel() const ;

void setChannel(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE *getData() const;

UBYTE *getData();

void setData(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 (0x0127)

3, 4

Message Type (0x0127)

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)

8

:

AIB

Address Method

0x00 - Individual AEs

10 . . .

AIB (same as message)

Number of AEs to follow

:

Data Type

0x00 TLVs

AEs

When using this message for conferencing:

 

Resource A

0x0D Channel

Resource B

0x55 Conference ID

0x45 Child Conference ID

 

 

When using this message for faxing or Echo Cancel:

0x0D Channel

0x01 Slot

:

Number of TLVs to Follow

:

Data Type

0x00 TLVs

:

Mandatory Return TLVs

0x0602 Resource Type

:

Number of TLVs to Follow

:

Checksum

 

Mandatory TLVs

0x0602 Resource Type
(This is the B Resource Type)

 

If the Resource Type is Send or Receive Fax:

0x05E0 File ID

0x05E2 File Location

If the Resource Type is set to Send SMS (0x010A) or Receive SMS (0x010B):

0x0694 SMS Data

If the Resource Type is set to Receive FSK (0x010D):

0x0690 FSK Data

 

Optional TLVs

If AIB is Conference and Resource Type is Conference:

0x0604 DTMF Clamping/Filtering Enable (Default is Disabled)

0x0607 Output Gain Control (Default is 0db)

0x0608 Noise Gating Enable (Default is Disabled)

0x060A Echo Suppression Enable (Default is Disabled)

0x060C Automatic Gain Control Enable (Default is Disabled)

0x0612 Connection Type

0x060F Conference Failure Behavior

0x068B Input Gain Control

0x068D Transit Connection Mode

 

Optional TLVs

If AIB is Child Conference ID and Resource Type is Conference:

0x0604 DTMF Clamping/Filtering Enable (Default is Disabled)

0x0607 Output Gain Control (Default is 0db)

0x0608 Noise Gating Enable (Default is Disabled)

0x060A Echo Suppression Enable (Default is Disabled)

0x060C Automatic Gain Control Enable (Default is Disabled)

 

 

Optional TLVs for Echo Cancel Parameters

0x0673 Echo Cancel Tap Length

0x0674 Echo Cancel NLP Type

0x0675 Echo Cancel ADAPT

0x0676 Echo Cancel Bypass

0x0677 Echo Cancel G.176 Modem Answer Detection

0x0678 Echo Cancel NLP Threshold

0x0679 Echo Cancel CNG Noise Threshold

0x067E Echo Cancel Comfort Noise Level

 

Optional TLVs for PVD/AMD

0x0619 PVD Parameters

0x061B AMD Reports

Optional TLVs for Send Fax or Receive Fax

0x0641 Header Parameter Format

0x0643 T.30 Control Parameter Transmit Level

0x0644 T.30 Control Parameter ECM Enabled

0x0645 T.30 Control Parameter Local Session ID

0x0648 Receive Resolution Type

0x064C Receive Page Size

0x0651 Receive Enable ECM

0x0652 Receive Add Header

0x0655 Receive Timeout

0x0657 Receive Terminal ID

0x0661 Transmit Enable ECM

0x0662 Transmit Add Header

0x05FB Silence Threshold

0x0668 Transmit dbm Level

0x066A Transmit Terminal ID

0x068C FAX Page Range

Optional TLV for Send SMS (0x010A) or Receive SMS (0x010B)

0x0695 FSK Modem Type

:

Checksum