zapIAudioToneFrame Interface Reference
[ZAP Media Kit (ZMK) module]

import "zapIAudioToneFrame.idl";

List of all members.

---

Detailed Description

An RFC2833 audio/tone media frame.

Public Member Functions
unsigned short	getFrequencyAt (in unsigned short n)
	Accessor for nth frequency (0-based).
void	addFrequency (in unsigned short frequency)
	Add a frequency to the frame.
Public Attributes
attribute boolean	M
	Marker bit.
attribute unsigned short	modulation
	modulation frequency in Hz (9 bits: 0 to 511Hz).
attribute boolean	T
	'T' bit.
attribute unsigned short	volume
	Power level of the tone in dBm0 after dropping sign.
attribute unsigned short	duration
	Duration of tone in timestamp units (16 bits).
readonly attribute unsigned short	frequencyCount
	Number of frequencies in this tone.

---

Member Function Documentation

void zapIAudioToneFrame::addFrequency (  in unsigned short  frequency  )

Add a frequency to the frame. Frequencies are in Hz (12 bits: 0 to 4095Hz)

unsigned short zapIAudioToneFrame::getFrequencyAt (  in unsigned short  n  )

Accessor for nth frequency (0-based). Frequencies are in Hz (12 bits: 0 to 4095Hz)

---

Member Data Documentation

attribute unsigned short zapIAudioToneFrame::duration

Duration of tone in timestamp units (16 bits).

readonly attribute unsigned short zapIAudioToneFrame::frequencyCount

Number of frequencies in this tone.

attribute boolean zapIAudioToneFrame::M

Marker bit. Signifies the start of a new tone.

attribute unsigned short zapIAudioToneFrame::modulation

modulation frequency in Hz (9 bits: 0 to 511Hz). If the 'T' bit is set this must be divided by 3.

attribute boolean zapIAudioToneFrame::T

'T' bit. If set, the modulation frequency is to be divided by 3.

attribute unsigned short zapIAudioToneFrame::volume

Power level of the tone in dBm0 after dropping sign. (6 bits: 0 to -63dBm0)

---

The documentation for this interface was generated from the following file:

• /home/alex/devel/zap/mozilla/zap/zmk/src/zapIAudioToneFrame.idl

---