You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Create 0x0124

Resource Create 0x0124

SwitchKit Name

Resource Create

Type

EXS and SwitchKit API message

Description

Resource Create 0x0124

Use this message to create a processing resource in the CSP.

Conference

To create a Unified conference, you send the following:

AIB: DSP Chip

Resource Type TLV: Conference

TLVs

Channel/DSP Pool

Conference Size

Monitor Conference Enable (to create a Monitor Conference)

Any optional conference TLVs

The Conference ID is returned in the response.

Child Conference

To create a Child Conference, you send the following:

AIB: Child Conference ID

TLVs

Resource Type: Child Conference

Any optional conference TLVs

The Child Conference ID is returned in the response.

Sent by

Host application

Related API Messages

Resource Modify (0x125)

Resource Delete (0x126)

Resource Connect (0x127)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceCreate;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_ResourceCreate Ack;

C++ Class

class XLC_ResourceCreate : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getDSPChip() const;

void DSPChip(UBYTE x);

UBYTE getDSPSlot() const;

void setDSPSlot(UBYTE x);

UBYTE getDSPSIMM() const ;

void setDSPSIMM(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_ResourceCreateAck: public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getDSPChip() const;

void DSPChip(UBYTE x);

UBYTE getDSPSlot() const;

void setDSPSlot(UBYTE x);

UBYTE getDSPSIMM() const ;

void setDSPSIMM(UBYTE x) ;

UBYTE getDataType() const;

void setDataType(UBYTE x) ;

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE getDataType() const;

UBYTE *getData() ;

void setDataType(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 (0x0124) | 3, 4 | Message Type (0x0124)
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) 0x0001 Invalid TLV Data Software can't find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV 0x000D Mandatory TLVs missing One or more mandatory TLVs are missing
8 : | AIB Address Method 0x00 - Individual AEs | 10 : | AIB (same as message)
Number of AEs to follow
AE 0x22 DSP Chip 0x45 Child Conference ID
: | Data Type 0x00 TLVs | : | Data Type 0x00 TLVs
10 | Number of TLVs to Follow | : | Number of TLVs to Follow
: | TLVs Mandatory for all: 0x0602 Resource Type Mandatory if Resource Type is Conference: 0x0603 Channel/DSP Pool 0x0613 Conference Size Optional if Resource Type is Conference or Child Conference: (Note: if Resource Type is Child Conference, only TLVs 0x0607 - 0x060E can be used) (Note: for these TLVs to work, the corresponding function must already be enabled on the card, using the DSP SIMM Configure message): 0x05E5 Barge In (Enable) 0x0604 DTMF Clamping/Filtering Enable (default is Disabled) 0x0605 EXS Conferencing Encoding Type (default Mixed) 0x0606 Monitor Conference Enable (default is Disabled) 0x0607 Output Gain Control (default 0db) 0x0608 Noise Gating Enable (default Disabled) 0x0609 Noise Gate Parameters 0x060A Echo Suppression Enable (default Disabled) 0x060B Echo Suppression Parameters 0x060C Automatic Gain Control Enable (default Disabled) 0x060D Automatic Gain Control Input Level 0x060E Automatic Gain Control Parameters 0x060F Conference Failure Behavior (default Purge) 0x068B Input Gain Control 0x068D Transit Connection Mode For Conferencing: The Conference can have listen-only channels connected to it. Optional if Resource Type is File Playback 0x05E5 Barge In (Enable) The File will play continuously until no timeslots are listening to it. Multiple timeslots can listen to the same File playout | : | TLVs Mandatory: 0x0602 Resource Type Mandatory if Resource Type is Conference or Child Conference: 0x0610 Conference ID
: | Checksum | : | Checksum

See Address Information Block.
Digital Signal Processor
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
Most Significant Bit
Least Significant Bit