You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Connect 0x0127
SwitchKit Name
Type
EXS and SwitchKit API message
Description
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 |
|||
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 Resource B
When using this message for faxing or Echo Cancel: |
: |
Number of TLVs to Follow |
|
: |
Data Type 0x00 TLVs |
: |
Mandatory Return TLVs |
: |
Number of TLVs to Follow |
: |
Checksum |
|
Mandatory TLVs 0x0602 Resource Type
If the Resource Type is Send or Receive Fax:
Optional TLVs If AIB is Conference and Resource Type is Conference: 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 0x0677 Echo Cancel G.176 Modem Answer Detection 0x0678 Echo Cancel NLP Threshold 0x0679 Echo Cancel CNG Noise Threshold
Optional TLVs for PVD/AMD
Optional TLVs for Send Fax or Receive Fax 0x0641 Header Parameter Format 0x0642 T.30 Control Parameter Max Value 0x0643 T.30 Control Parameter Transmit Level 0x0644 T.30 Control Parameter ECM Enabled 0x0645 T.30 Control Parameter Local Session ID |
||
: |
Checksum |