You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Record File Stop 0x0120
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
NOTE: This message applies to the DSP Series 2 card only.
Use this message to end a current record file session.
Sent by
Host Application
Related API Messages
Record File Start, Record File Modify
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[253];
} XL_RecordFileStop;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE reserved6[13];
UBYTE AddrInfo[251];
} XL_RecordFileStopAck;
C++ Class
class XLC_RecordFileStop : 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)
};
C++ Class Response
class XLC_RecordFileStopAck : 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 (0x0120) |
3, 4 |
Message Type (0x0120) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x00 - Individual AEs
|
8, 9 |
0x0001 Invalid TLV Data Software can't find the TLV Data Buffer. This can also 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. |
Number of AEs to follow |
: |
AIB Same as message |
|
AEs Use one of the following:
and (if recording a conference) 0x01 Slot |
: |
Checksum |
|
|
Checksum |