You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Record File Modify 0x011F

Record File Modify 0x011F

SwitchKit Name

RecordFileModify

Type

EXS API and SwitchKit API message

Description

Record File Modify 0x011F

NOTE: This message applies to the DSP Series 2 card only.

Use this message to modify a current record file session. You can pause, resume, or modify the gain of the recording.

Sent by

Host application

Related API Messages

Record File Start, Record File Stop

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE Action;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[220];

} XL_RecordFileModify;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[251];

} XL_RecordFileModifyAck;

C++ Class

class XLC_RecordFileModify : public XLC_OutboundMessage {

public:

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 getAction() const;

void setAction(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_RecordFileModifyAck : public XLC_OutboundMessage {

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);

;

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 (0x011F) | 3, 4 | Message Type (0x011F)
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) 0x0001 Invalid TLV Data Software cannot find the TLV Data Buffer. This error 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 Also see Common Response Status Values in the API Reference
Number of AEs to follow | 10 | AIB (same as message)
AEs Use one of the following: 0x0D Channel 0x55 Conference ID 0x45 Child Conference ID | 11 | Checksum
: | Action 0x00 Modify 0x01 Pause 0x02 Resume
: | Data Type 0x00 TLVs
: | Number of TLVs to Follow
: | TLVs With Action of Modify 0x05E3 Gain 0x0604 DTMF Clamping/Filtering Enable Positive Voice Detection with RTP If you are using PVD with RTP, the following TLVs are mandatory: 0x0689 - Start/Stop Sending RTP Packets 0x068A - Calender Time Offset for Sending RTP Packets If the Action field is Pause (0x01) or Resume (0x02), no TLVs are used
: | Checksum

Digital Signal Processor
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.
See Address Information Block.
Most Significant Bit
Least Significant Bit
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
Real-Time Transport Protocol. Supports transport of real-time data like interactive voice and video over packet-switched networks.