Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

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

import "zapITToneGenerator.idl";

List of all members.

Public Member Functions

void play (in ACString tonesData)
 Play the tone sequence described by 'tonesData'.


Member Function Documentation

void zapITToneGenerator::play in ACString  tonesData  ) 
 

Play the tone sequence described by 'tonesData'.

Any sequence currently being played will be immediately replaced by the new sequence.

tonesData has the following syntax:

  • tonesData: command *
  • command: tone-cmd | repeat-all-flag
  • tone-cmd: '@' duration tone-par*
  • tone-par: volume-par | freq-par | modulation-par
  • volume-par: 'v' volume
  • freq-par: '+' frequency
  • modulation-par: '*' modulation-frequency [ '/' '3' ]
  • repeat-all-flag: 'R'

  • volume, frequency, modulation-frequency are integers
  • duration is the tone duration in seconds (decimal number).
  • volume is in dBm0 with reversed sign.
  • frequency is in Hz. Multiple frequencies can be specified.
  • modulation-frequency is in Hz and will be divided by 3 if '/3' is appended.

Range limits are as defined in RFC2833 for audio/tone packets with the exception of duration which may be longer. A duration of 0 signifies a continuous tone.


The documentation for this interface was generated from the following file:
Generated on Fri Aug 29 12:00:05 2008 for Mozilla ZAP by  doxygen 1.4.4