Resource Modify 0x0125

SwitchKit Name

Resource Modify

Type

EXS and SwitchKit API message

Description

Use this message to change parameters for a processing resource in the Excel platform.

Sent by

Host application

Related API Message

Resource Create (0x0124)

Resource Delete (0x126)

Resource Connect (0x127)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceModify;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_ResourceModifyAck;

 

C++ Class

class XLC_ResourceModify : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getConferenceID() const;

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

UBYTE *getData() const ;

void setData(UBYTE *x) ;

};

C++ Class Response

class XLC_ResourceModifyAck : 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 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 (0x0125)

3, 4

Message Type (0x0125)

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

10

:

AIB (same as message)

 

AEs

0x0D Channel

0x55 Conference ID

:

Data Type

0x00 TLVs

:

Data Type

0x00 TLVs

:

Number of TLVs to Follow

:

Number of TLVs to Follow

:

Mandatory Return TLVs

0x0602 Resource Type

:

TLVs

:

Checksum

 

Mandatory TLVs

0x0602 Resource Type

 

Optional TLVs

 

Optional TLVs if AIB is Conference and Resource Type is Conference or Child 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 if AIB is Channel and Resource Type is Conference or Child Conference:

0x0607 Output Gain Control

0x0608 Noise Gating Enable

0x060A Echo Suppression Enable

0x060C Automatic Gain Control Enable

0x068B Input Gain Control

 

 

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

0x067A Echo Cancel H Register Reset

 

:

Checksum