FMLiveSwitchDtmfPacket Class Reference

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

Instance Methods

(int) - duration
 Gets the duration in timestamp units (based on the negotiated clock rate). More...
 
(bool) - end
 Gets the end-bit. More...
 
(int) - eventCode
 Gets the event code. More...
 
(int) - getLength
 Gets the length. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchDtmfPacket class. More...
 
(void) - setDuration:
 Sets the duration in timestamp units (based on the negotiated clock rate). More...
 
(void) - setEnd:
 Sets the end-bit. More...
 
(void) - setEventCode:
 Sets the event code. More...
 
(void) - setVolume:
 Sets the volume in dBm0 with the sign removed. More...
 
(int) - volume
 Gets the volume in dBm0 with the sign removed. More...
 
(void) - writeToWithDataBuffer:
 Writes to a data buffer. More...
 

Class Methods

(FMLiveSwitchDtmfPacket *) + packet
 Initializes a new instance of the FMLiveSwitchDtmfPacket class. More...
 
(FMLiveSwitchDtmfPacket *) + readFromWithDataBuffer:
 Reads from a data buffer. More...
 

Detailed Description

A DTMF (telephone-event) packet.

Method Documentation

◆ duration

- (int) duration

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

◆ end

- (bool) end

Gets the end-bit.

◆ eventCode

- (int) eventCode

Gets the event code.

◆ getLength

- (int) getLength

Gets the length.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchDtmfPacket class.

◆ packet

Initializes a new instance of the FMLiveSwitchDtmfPacket class.

◆ readFromWithDataBuffer:

+ (FMLiveSwitchDtmfPacket*) readFromWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Reads from a data buffer.

Parameters
dataBufferThe data buffer.

◆ setDuration:

- (void) setDuration: (int)  value

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

◆ setEnd:

- (void) setEnd: (bool)  value

Sets the end-bit.

◆ setEventCode:

- (void) setEventCode: (int)  value

Sets the event code.

◆ setVolume:

- (void) 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.

◆ volume

- (int) volume

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.

◆ writeToWithDataBuffer:

- (void) writeToWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Writes to a data buffer.

Parameters
dataBufferThe data buffer.