home *** CD-ROM | disk | FTP | other *** search
/ Merciful 1 / Merciful - Disc 1.iso / software / a / asm_one / asm-onev1.25a.dms / in.adf / Release3.1 / AutoDocs3.1.lha / doc / sound_dtc.doc < prev    next >
Encoding:
Text File  |  1993-08-12  |  2.6 KB  |  95 lines
  1. TABLE OF CONTENTS
  2.  
  3. sound.datatype/sound.datatype
  4. sound.datatype/sound.datatype                   sound.datatype/sound.datatype
  5.  
  6.     NAME
  7.     sound.datatype -- root data type for sounds.
  8.  
  9.     FUNCTION
  10.     The sound.datatype is the super-class for any sound related
  11.     classes.
  12.  
  13.     METHODS
  14.     OM_NEW -- Create a new sound object.
  15.  
  16.     OM_GET -- Obtain the value of an attribute.
  17.  
  18.     OM_SET -- Set the values of multiple attributes.
  19.  
  20.     OM_UPDATE -- Update the values of multiple attributes.
  21.  
  22.     OM_DISPOSE -- Dispose of a sound object.
  23.  
  24.     GM_LAYOUT -- Layout the object and notify the application of the
  25.         title and size.
  26.  
  27.     GM_HITTEST -- Determine if the object has been hit with the
  28.         mouse.
  29.  
  30.     GM_GOACTIVE -- Tell the object to go active.  On SELECTDOWN, the
  31.         sound will start playing.
  32.  
  33.     GM_HANDLEINPUT -- Handle input.  Currently input (other than
  34.         SELECTDOWN) doesn't affect the sound.
  35.  
  36.     GM_RENDER -- Cause the graphic to render.  Currently the graphic
  37.         for the sound is just a static icon.
  38.  
  39.     DTM_TRIGGER -- Cause an event to occur.  Currently the only
  40.         trigger event is STM_PLAY, which will cause the sound to start
  41.         playing.
  42.  
  43.     DTM_COPY -- Copy the entire sound to the clipboard as 8SVX.
  44.  
  45.     DTM_WRITE -- Write the entire sound to a file as 8SVX.
  46.  
  47.     TAGS
  48.     SDTA_VoiceHeader (struct VoiceHeader *) -- Set and get the base
  49.         information for the sound.  VoiceHeader is defined in
  50.         <datatypes/soundclass.h>.
  51.  
  52.         Applicability is (ISG).
  53.  
  54.     SDTA_Sample (UWORD *) -- Set and get the sound data.  Starting
  55.         V40 the sample data does not need to be in CHIP memory.
  56.  
  57.         Applicability is (ISG).
  58.  
  59.     SDTA_SampleLength (ULONG) -- Length of the sound data.
  60.  
  61.         Applicability is (ISG).
  62.  
  63.     SDTA_Period (UWORD) -- Set and get the period of the sound.
  64.         This attribute can be used to affect a playing sound.
  65.  
  66.         Default for this tag is 394.  Applicability is (ISG).
  67.  
  68.     SDTA_Volume (UWORD) -- Set and get the volume of the sound. This
  69.         attribute can be used to affect a playing sound.
  70.  
  71.         Valid range is from 0 to 64.  Default for this tag is 64.
  72.         Applicability is (ISG).
  73.  
  74.     SDTA_Cycles (UWORD) -- Set and get the number of cycles the
  75.         sound will be played.
  76.  
  77.         Default for this tag is 1.  Applicability is (ISG).
  78.  
  79.     The following tags are new for V40.
  80.  
  81.     SDTA_SignalTask (struct Task *) -- Task to signal when the
  82.         is complete, or if SDTA_Continuous is TRUE, when
  83.         the next buffer is needed.
  84.  
  85.     SDTA_SignalBit (BYTE) -- Signal bit to use with SDTA_SignalTask
  86.         or -1 to disable.
  87.  
  88.     SDTA_Continuous (BOOL) -- Used to indicate that the sound
  89.         datatype will be fed a continuous stream of data.  Defaults
  90.         to FALSE.
  91.  
  92.     BUGS
  93.     Still doesn't support stereo or channel selection.
  94.  
  95.