You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Play File Stop 0x011D

Play File Stop 0x011D

SwitchKit Name

PlayFileStop

Type

EXS API and SwitchKit API message

Description

Play File Stop 0x011D

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

Use this message to end a current play file session. The message may be used to cancel only play file requests that were made with the new Play File Start message.

If you are stopping a play file to a conference (using the Conference ID AIB) you can use the File ID TLV. If File ID TLV is present, all instances of that file ID being played in the specified conference are stopped. If the File ID TLV is absent, all the files playing into that conference are stopped.

Sent by

Host Application

Related API Messages

Play File Start, Play File Modify

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_PlayFileStop;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[251];

} XL_PlayFileStopAck;

C++ Class

class XLC_PlayFileStop : 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_PlayFileStopAck : 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 (0x011D) | 3, 4 | Message Type (0x011D)
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)
10 | AIB (same one returned as sent)
11 | Checksum
: | Number of AEs to follow
: | AEs Use one of the following: 0x0D Channel 0x55 Conference ID (If playing file to a conference) 0x45 Child Conference ID (If playing file to child conference)
: | Data Type 0x00 (2-byte Global TLVs)
: | Number of TLVs
: | TLVs If the AIB specifies Conference ID (0x55) or Child Conference ID (0x45), use this TLV to indicate the ID of the file to be stopped: 0x05E0 File ID
: | Checksum

Digital Signal Processor
See Address Information Block.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
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.
Most Significant Bit
Least Significant Bit