Play File Start 0x011B

SwitchKit Name

PlayFileStart

Type

EXS API and SwitchKit API message

Description

Play File Start 0x011B

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

Use this message to start playing a file.

You can either specify the channel and the DSP Series 2 card, or let the CSP Matrix Series 3 Card choose the DSP card by leaving the DSP slot set to 0xFF. The CSP Matrix Series 3 Card reports back which DSP Series 2 card has been selected.

If you are accessing files from an external server, you must send the Generic Card Configure message (0x0122) to set the Vocabulary Index File before you send this message, because you must identify a file’s ID and location before you can play it. Internal recordings are an exception to this rule. Internal recordings can be played without having their IDs in the Vocabulary Index File.

The Play File Start message may use File IDs from 0x00 to 0xFFFFFFFE. 0xFFFFFFFF is reserved by Dialogic for internal use, except when using media streaming over RTP, when the range is up to 0x0100000.

When recording a conference or playing a file to a conference, use the Conference AIB instead of the Channel AIB.

Sent by

Host Application

Related API Messages

Play File Modify, Play File Stop

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE FileCount;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[220];

} XL_PlayFileStart;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved[13];

UBYTE AddrInfo[251];

} XL_PlayFileStartAck;

C++ Class

class XLC_PlayFileStart : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getChannelSlot() const;

void setChannelSlot(UBYTE x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

UBYTE getConferenceSlot() const;
void setConferenceSlot(UBYTE 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 getFileCount() const ;

void setFileCount(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_PlayFileStartAck : public XLC_OutboundMessage {

public:

unsigned short getStatus() const

void setStatus(unsigned short x)

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getChannelSlot() const;

void setChannelSlot(UBYTE x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getConferenceSlot() const ;

void setConferenceSlot(UBYTE x);

XBYTE getSpan() const ;

void setSpan(XBYTE x) ;

UBYTE getChannel() const;

void setChannel(UBYTE x);

;

Hex API Message Format