fm.liveswitch.dtmf.Packet Class Reference

A DTMF (telephone-event) packet. More...

Public Member Functions

int getDuration ()
 Gets the duration in timestamp units (based on the negotiated clock rate). More...
 
boolean getEnd ()
 Gets the end-bit. More...
 
int getEventCode ()
 Gets the event code. More...
 
int getLength ()
 Gets the length. More...
 
int getVolume ()
 Gets the volume in dBm0 with the sign removed. More...
 
 Packet ()
 Initializes a new instance of the fm.liveswitch.dtmf.Packet class. More...
 
void setDuration (int value)
 Sets the duration in timestamp units (based on the negotiated clock rate). More...
 
void setEnd (boolean value)
 Sets the end-bit. More...
 
void setEventCode (int value)
 Sets the event code. More...
 
void setVolume (int value)
 Sets the volume in dBm0 with the sign removed. More...
 
void writeTo (fm.liveswitch.DataBuffer dataBuffer)
 Writes to a data buffer. More...
 

Static Public Member Functions

static fm.liveswitch.dtmf.Packet readFrom (fm.liveswitch.DataBuffer dataBuffer)
 Reads from a data buffer. More...
 

Detailed Description

A DTMF (telephone-event) packet.

Constructor & Destructor Documentation

◆ Packet()

fm.liveswitch.dtmf.Packet.Packet ( )

Initializes a new instance of the fm.liveswitch.dtmf.Packet class.

Member Function Documentation

◆ getDuration()

int fm.liveswitch.dtmf.Packet.getDuration ( )

Gets the duration in timestamp units (based on the negotiated clock rate).

◆ getEnd()

boolean fm.liveswitch.dtmf.Packet.getEnd ( )

Gets the end-bit.

◆ getEventCode()

int fm.liveswitch.dtmf.Packet.getEventCode ( )

Gets the event code.

◆ getLength()

int fm.liveswitch.dtmf.Packet.getLength ( )

Gets the length.

◆ getVolume()

int fm.liveswitch.dtmf.Packet.getVolume ( )

Gets the volume in dBm0 with the sign removed.

Power levels range from 0 to -63 dBm0, so the value of this field ranges from 0-63, with higher values indicating lower volume.

◆ readFrom()

static fm.liveswitch.dtmf.Packet fm.liveswitch.dtmf.Packet.readFrom ( fm.liveswitch.DataBuffer  dataBuffer)
static

Reads from a data buffer.

Parameters
dataBufferThe data buffer.

◆ setDuration()

void fm.liveswitch.dtmf.Packet.setDuration ( int  value)

Sets the duration in timestamp units (based on the negotiated clock rate).

◆ setEnd()

void fm.liveswitch.dtmf.Packet.setEnd ( boolean  value)

Sets the end-bit.

◆ setEventCode()

void fm.liveswitch.dtmf.Packet.setEventCode ( int  value)

Sets the event code.

◆ setVolume()

void fm.liveswitch.dtmf.Packet.setVolume ( int  value)

Sets the volume in dBm0 with the sign removed.

Power levels range from 0 to -63 dBm0, so the value of this field ranges from 0-63, with higher values indicating lower volume.

◆ writeTo()

void fm.liveswitch.dtmf.Packet.writeTo ( fm.liveswitch.DataBuffer  dataBuffer)

Writes to a data buffer.

Parameters
dataBufferThe data buffer.