Record File Start 0x011E

SwitchKit Name

RecordFileStart

Type

EXS API and SwitchKit API message

Description

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

Use this message to start a file recording.

You can select the channel and the DSP card, or let the Matrix Controller choose the DSP Card by leaving the DSP slot set to 0xFF. The Matrix Controller card reports back in the response which DSP Card has been selected.

The Initial Silence Timer specifies how much silence is allowed before the card aborts the recording. The Final Silence Timer specifies how much silence is allowed before the silence triggers the card to stop recording voice.

Any delay between the beginning of conversation and the beginning of recording can result into clipped recorded media. To alleviate this potential problem, Excel recommends sending the Record File Start message before the conversation begins (before the Resource Connect message). Recording sessions involve a signal energy detection threshold, so the silence before conversation will not be recorded.

Sent by

Host Application

Related API Message

Record File Modify, Record File Stop

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];;

} XL_RecordFileStart;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[251];

} XL_RecordFileStartAck;

C++ Class

class XLC_RecordFileStart : 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 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_RecordFileStartAck : 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