Play File Modify 0x011C

SwitchKit Name

PlayFileModify

Type

EXS API and SwitchKit API message

Description

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

Use this message to modify a current play file session. You can modify the gain and speed of the playback, pause or resume the playback, or skip forward or backward (in 100 ms increments) through the current file.

When modifying a file that is playing to a conference, use the Conference AIB instead of the Channel AIB. If you are modifying a file that is playing to a conference, use the optional File ID TLV. If you use the File ID TLV, all instances of that File ID being played in the specified conference are modified. If the File ID TLV is absent, all the files playing into that conference are modified.

Sent by

Host Application

Related API Messages

Play File Start, Play File Stop

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE Action;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[220];

} XL_PlayFileModify;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[251];

} XL_PlayFileModifyAck;

C++ Class

class XLC_PlayFileModify : 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_PlayFileModifyAck : 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