home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / DeveloperDisk300794.lha / superplay-lib_3_1.LHA / superplay-lib / Programmers / Docs / SPObject_Ref_ENG.doc < prev    next >
Encoding:
Text File  |  1994-07-21  |  20.0 KB  |  925 lines
  1.  
  2.    $VER: SPObject_Ref_ENG.doc V2.2 (21.7.94)
  3.  
  4.    © 1994 by Andreas R. Kleinert. All rights reserved.
  5.  
  6.    - Feel free to translate this Doc-File into other languages. -
  7.  
  8.        Andreas R. Kleinert,
  9.        Grube Hohe Grethe 23,
  10.        D-57074 Siegen,
  11.        Germany.                        email : Fido 2:2457/345.10
  12.                                                (checked weekly)
  13.  
  14.    * DO _NEVER_ ACCESS ANY SPOBJECTS DIRECTLY.
  15.    * DO NEVER BYPASS superplay.library !
  16.  
  17.    THE FOLLOWING NOTES ARE ONLY FOR PROGRAMMERS OF SPOBJECTS :
  18.  
  19.    Here is a listing of the function set, which any of the version 1
  20.    and version 2 SPObjects does contain, in an Autodoc-like style of
  21.    description :
  22.  
  23.         SPO_AllocHandle            ; since Version 1
  24.         SPO_FreeHandle
  25.         SPO_Read
  26.         SPO_StartReplay
  27.         SPO_Write
  28.         SPO_StopReplay
  29.         SPO_FreeResources
  30.         SPO_SetAccessMode
  31.         SPO_SetWriteSubType
  32.         SPO_SetWriteName
  33.         SPO_SetReadeName
  34.         SPO_FileInfoRequest
  35.         SVO_CheckFileType
  36.         SPO_SetReqIOWindow
  37.         SPO_ContinueReplay
  38.         SPO_FastForward
  39.         SPO_FastBackward
  40.         SPO_GetSampleBuffer         *** OBSOLETE : Use SPO_GetSampleList()
  41.         SPO_GetSampleInfo           *** OBSOLETE : Use SPO_GetSampleList()
  42.         SPO_GetSampleList          ; since Version 2
  43.         SPO_SetSampleList
  44.  
  45. -----------------------------------------------------------------------------
  46.    Functions available since Version 1 :
  47. -----------------------------------------------------------------------------
  48.  
  49.    NAME
  50.         SPO_AllocHandle
  51.  
  52.    SYNOPSIS
  53.  
  54.         APTR SPO_AllocHandle(APTR future)
  55.         D0   -$1e            A1
  56.  
  57.    FUNCTION
  58.  
  59.         Allocates a handle for accessing a Sample/Module via SPObjects.
  60.  
  61.    INPUT(S)
  62.  
  63.         future - always NULL yet
  64.  
  65.    RESULT
  66.  
  67.         A pointer to a new allocated Handle or NULL, if allocation failed.
  68.  
  69.    WARNING
  70.  
  71.         Test, if the result was NULL, or not !
  72.  
  73.    BUGS
  74.  
  75.         -
  76.  
  77.    SINCE
  78.  
  79.         ... version 1 of the superplay.library.
  80.  
  81.    SEE ALSO
  82.  
  83.         SPO_FreeResources, SPO_FreeHandle
  84.  
  85. -----------------------------------------------------------------------------
  86.  
  87.    NAME
  88.         SPO_FreeHandle
  89.  
  90.    SYNOPSIS
  91.  
  92.         VOID SPO_FreeHandle(APTR handle)
  93.         D0   -$24           A1
  94.  
  95.    FUNCTION
  96.  
  97.        Stops playing, frees all Resources and delocates a Handle, which has
  98.        been allocated with SPO_AllocHandle before.
  99.  
  100.    INPUT(S)
  101.  
  102.         handle - a valid handle
  103.  
  104.    RESULT
  105.  
  106.         -
  107.  
  108.    BUGS
  109.  
  110.         -
  111.  
  112.    SINCE
  113.  
  114.         ... version 1 of the superplay.library.
  115.  
  116.    SEE ALSO
  117.  
  118.         SPO_AllocHandle, SPO_StopReplay, SPO_FreeResources
  119.  
  120. -----------------------------------------------------------------------------
  121.  
  122.    NAME
  123.         SPO_Read
  124.  
  125.    SYNOPSIS
  126.  
  127.         ULONG SPO_Read(APTR handle)
  128.         D0    -$2a     A1
  129.  
  130.    FUNCTION
  131.  
  132.         Loads the Sample/Module described by FileName, which then may
  133.         e.g. be replayed by SPO_StartReplay.
  134.  
  135.    INPUT(S)
  136.  
  137.         handle   - a valid handle
  138.  
  139.    RESULT
  140.  
  141.         NULL or an adequate SPERR-Errorcode.
  142.  
  143.    BUGS
  144.  
  145.         -
  146.  
  147.    SINCE
  148.  
  149.         ... version 1 of the superplay.library.
  150.  
  151.    SEE ALSO
  152.  
  153.         SPO_AllocHandle, SPO_StopReplay, SPO_StartReplay, SPO_ContinueReplay,
  154.         SPO_FastForward, SPO_FastBackward, SPO_FreeHandle
  155.  
  156. -----------------------------------------------------------------------------
  157.  
  158.    NAME
  159.         SPO_StartReplay
  160.  
  161.    SYNOPSIS
  162.  
  163.         ULONG SPO_StartReplay(APTR handle)
  164.         D0    -$30            A1
  165.  
  166.    FUNCTION
  167.  
  168.         Play the Sample/Module described by FileName, which has been loaded
  169.         via SPO_Read before.
  170.  
  171.         Playing can be stopped either via full delocation of the handle
  172.         or temporal interruption with SPO_StopReplay.
  173.  
  174.    INPUT(S)
  175.  
  176.         handle   - a valid handle
  177.  
  178.    RESULT
  179.  
  180.         NULL or an adequate SPERR-Errorcode.
  181.  
  182.    BUGS
  183.  
  184.         -
  185.  
  186.    SINCE
  187.  
  188.         ... version 1 of the superplay.library.
  189.  
  190.    SEE ALSO
  191.  
  192.         SPO_AllocHandle, SPO_Read, SPO_StopReplay, SPO_ContinueReplay,
  193.         SPO_FastForward, SPO_FastBackward, SPO_FreeHandle
  194.  
  195. -----------------------------------------------------------------------------
  196.  
  197.    NAME
  198.         SPO_Write
  199.  
  200.    SYNOPSIS
  201.  
  202.         ULONG SPO_Write(APTR handle, struct SPObjectBase *SourceBase,
  203.         D0    -$36      A1           A2
  204.  
  205.                         APTR source_handle)
  206.                         A3
  207.  
  208.    FUNCTION
  209.  
  210.         This functions allows to access an other SPObject, get the Sample-
  211.         Data from there (only works with SampleType-SPObjects) and
  212.         then writes this data in its own FileFormat.
  213.  
  214.         *** NEW FEATURE : ***
  215.  
  216.         This functions acts different in Versions >= 2 :
  217.  
  218.         1) If "SourceBase" and "source_handle" are both NULL,
  219.            it is checked, whether a SampleList has been set via
  220.            "SPO_SetSampleList()", and then this SampleList is completely
  221.            saved.
  222.  
  223.            ELSE
  224.  
  225.         2) a) If a Version 1 SPObject is the Source, the old behaviour
  226.               takes place.
  227.            b) If a Version 2 SPObject takes place, the new SampleList
  228.               functions are supported (and completely saved).
  229.  
  230.         So, what's new ? Well, if you've any self-created SampleLists,
  231.         you now can save them by just setting them via SPO_SetSampleList()
  232.         and then calling SPO_Write() with NULL parameters for the
  233.         Source-SPObject variables.
  234.  
  235.    INPUT(S)
  236.  
  237.         handle        - a valid handle
  238.                         (used for Write Access)
  239.         SourceBase    - pointer to Base of other SPObject
  240.                         (may be NULL for V2+ SPObjects)
  241.         source_handle - handle for accessing the other SPObject
  242.                         (may be NULL for V2+ SPObjects)
  243.  
  244.    RESULT
  245.  
  246.         NULL or an adequate SPERR-Errorcode.
  247.  
  248.    BUGS
  249.  
  250.         -
  251.  
  252.    SINCE
  253.  
  254.         ... version 1 of the superplay.library.
  255.  
  256.    SEE ALSO
  257.  
  258.         SPO_AllocHandle, SPO_Read, SPO_FreeHandle
  259.  
  260. -----------------------------------------------------------------------------
  261.  
  262.    NAME
  263.         SPO_StopReplay
  264.  
  265.    SYNOPSIS
  266.  
  267.         VOID SPO_StopReplay(APTR handle)
  268.         D0   -$3c           A1
  269.  
  270.    FUNCTION
  271.  
  272.         Stops playing the Sample/Module, indentified by the handle.
  273.         Some SPObjects support to continue the Sample/Module with
  274.         SPO_ContinueReplay after calling SPO_StopReplay.
  275.  
  276.    INPUT(S)
  277.  
  278.         handle - a valid handle
  279.  
  280.    RESULT
  281.  
  282.         -
  283.  
  284.    BUGS
  285.  
  286.         -
  287.  
  288.    SINCE
  289.  
  290.         ... version 1 of the superplay.library.
  291.  
  292.    SEE ALSO
  293.  
  294.         SPO_ContinueReplay, SPO_FreeResources, SPO_FreeHandle
  295.  
  296. -----------------------------------------------------------------------------
  297.  
  298.    NAME
  299.         SPO_FreeResources
  300.  
  301.    SYNOPSIS
  302.  
  303.         VOID SPO_FreeResources(APTR handle)
  304.         D0   -$42              A1
  305.  
  306.    FUNCTION
  307.  
  308.         Frees all resources belonging to the specific Sample/Module,
  309.         indentified by the handle, which are not needed to just replay it.
  310.         Playing of the Sample/Module is not stopped and/or interrupted.
  311.  
  312.    INPUT(S)
  313.  
  314.         handle - a valid handle
  315.  
  316.    RESULT
  317.  
  318.         -
  319.  
  320.    BUGS
  321.  
  322.         -
  323.  
  324.    SINCE
  325.  
  326.         ... version 1 of the superplay.library.
  327.  
  328.    SEE ALSO
  329.  
  330.         SPO_AllocHandle, SPO_StopReplay, SPO_FreeHandle
  331.  
  332. -----------------------------------------------------------------------------
  333.  
  334.    NAME
  335.         SPO_SetAccessMode
  336.  
  337.    SYNOPSIS
  338.  
  339.         ULONG SPO_SetAccessMode(APTR handle, ULONG mode)
  340.         D0    -$48              A1           D1
  341.  
  342.    FUNCTION
  343.  
  344.         Initializes a Handle for ClipBoard or AmigaDOS access,
  345.         depending on the "mode" parameter.
  346.  
  347.    INPUT(S)
  348.  
  349.         handle - a valid handle
  350.         mode   - access mode value
  351.  
  352.  
  353.    RESULT
  354.  
  355.         NULL or an adequate SPERR-Errorcode.
  356.  
  357.    BUGS
  358.  
  359.         -
  360.  
  361.    SINCE
  362.  
  363.         ... version 1 of the superplay.library.
  364.  
  365.    SEE ALSO
  366.  
  367.         -
  368.  
  369. -----------------------------------------------------------------------------
  370.  
  371.    NAME
  372.         SPO_SetWriteSubType
  373.  
  374.    SYNOPSIS
  375.  
  376.         ULONG SPO_SetWriteSubType(APTR handle, ULONG write_type, APTR future)
  377.         D0    -$4e                A1           A2                A3
  378.  
  379.    FUNCTION
  380.  
  381.         Sets the write_type for a SPO_Write() call.
  382.         See description there and example SourceCodes for more and
  383.         detailed information.
  384.  
  385.    INPUT(S)
  386.  
  387.         handle     - a valid handle
  388.         write_type - a valid temporary write_type code form the SPObject List
  389.         future     - always NULL yet
  390.  
  391.  
  392.    RESULT
  393.  
  394.         NULL or an adequate SPERR-Errorcode.
  395.  
  396.    BUGS
  397.  
  398.         -
  399.  
  400.    SINCE
  401.  
  402.         ... version 1 of the superplay.library.
  403.  
  404.    SEE ALSO
  405.  
  406.         SPO_Write
  407.  
  408. -----------------------------------------------------------------------------
  409.  
  410.    NAME
  411.         SPO_SetWriteName
  412.  
  413.    SYNOPSIS
  414.  
  415.         ULONG SPO_SetWriteName(APTR handle, ULONG write_name, APTR future)
  416.         D0    -$54             A1           A2                A3
  417.  
  418.    FUNCTION
  419.  
  420.         Sets the write_name for a SPO_Write() call.
  421.         See description there and example SourceCodes for more and
  422.         detailed information.
  423.  
  424.    INPUT(S)
  425.  
  426.         handle     - a valid handle
  427.         write_name - a valid AmigaDOS FilePath and -Name description
  428.         future     - always NULL yet
  429.  
  430.  
  431.    RESULT
  432.  
  433.         NULL or an adequate SPERR-Errorcode.
  434.  
  435.    BUGS
  436.  
  437.         -
  438.  
  439.    SINCE
  440.  
  441.         ... version 1 of the superplay.library.
  442.  
  443.    SEE ALSO
  444.  
  445.         SPO_Write
  446.  
  447. -----------------------------------------------------------------------------
  448.  
  449.    NAME
  450.         SPO_SetReadName
  451.  
  452.    SYNOPSIS
  453.  
  454.         ULONG SPO_SetReadName(APTR handle, ULONG reade_name, APTR future)
  455.         D0    -$5a            A1           A2                A3
  456.  
  457.    FUNCTION
  458.  
  459.         Sets the reade_name for a SPO_Read() call.
  460.         See description there and example SourceCodes for more and
  461.         detailed information.
  462.  
  463.    INPUT(S)
  464.  
  465.         handle     - a valid handle
  466.         write_name - a valid AmigaDOS FilePath and -Name description
  467.         future     - always NULL yet
  468.  
  469.  
  470.    RESULT
  471.  
  472.         NULL or an adequate SPERR-Errorcode.
  473.  
  474.    BUGS
  475.  
  476.         -
  477.  
  478.    SINCE
  479.  
  480.         ... version 1 of the superplay.library.
  481.  
  482.    SEE ALSO
  483.  
  484.         SPO_Write
  485.  
  486. -----------------------------------------------------------------------------
  487.  
  488.    NAME
  489.         SPO_FileInfoRequest
  490.  
  491.    SYNOPSIS
  492.  
  493.         ULONG SPO_FileInfoRequest(APTR handle, struct Window *window,
  494.         D0    -$60                A1           A2
  495.  
  496.                                   APTR future)
  497.                                   A3
  498.  
  499.    FUNCTION
  500.  
  501.         Pops up an Info-Requester with more or less detailed information
  502.         on the currently loaded Sample/Module.
  503.         A window pointer may be given to select the place to pop it up.
  504.  
  505.    INPUT(S)
  506.  
  507.         handle - a valid handle
  508.         window - a valid Window Pointer or NULL
  509.         future - always NULL yet
  510.  
  511.  
  512.    RESULT
  513.  
  514.         NULL or an adequate SPERR-Errorcode.
  515.  
  516.    BUGS
  517.  
  518.         -
  519.  
  520.    SINCE
  521.  
  522.         ... version 1 of the superplay.library.
  523.  
  524.    SEE ALSO
  525.  
  526.         SPO_SetReqIOWindow
  527.  
  528. -----------------------------------------------------------------------------
  529.  
  530.    NAME
  531.         SPO_CheckFileType
  532.  
  533.    SYNOPSIS
  534.  
  535.         ULONG SPO_CheckFileType(BPTR filehandle, UBYTE *filename,
  536.         D0    -$66              A1                 A2
  537.  
  538.                                 struct SPOCheckFile *spo_check)
  539.                                 A3
  540.  
  541.    FUNCTION
  542.  
  543.         Checks, if the given file (or ClipBoard entry, or whatever)
  544.         fits to this SPObject and can be handled therein.
  545.  
  546.         Upto Version 2 of superplay.library ClipBoard-Support with
  547.         external SPObjects would not have worked at all.
  548.         Since V2 the specification of external Version 2 SPObjects
  549.         has been modified to allow ClipBoard and other media usage :
  550.         To preserve compatibility, this has been done by using the
  551.         "future" parameter as a pointer to a structure (defined in
  552.         "include:spobjects/spobjects.h"), which contains media
  553.         information.
  554.  
  555.         This pointer may be NULL, so that you have to assume default
  556.         settings, if there's not such a structure.
  557.         For disk-access, this pointer will not be set at all, anyway.
  558.  
  559.         Also be prepared, to handle NULL pointers to filename :
  560.         if ClipBoard usage is forced, there will no filename be needed.
  561.         If you don't support any filename-less medias, just do a silent
  562.         exit.
  563.         Currently - for compatibility reasons - superplay.library will
  564.         supply a dummy filename and a dummy file for those SPObjects,
  565.         which may not handle a NULL pointer correctly.
  566.  
  567.         So handle SPOCheckFile structures with a HIGHER priority, because
  568.         currently there's always a dummy-file (mostly empty) available.
  569.  
  570.    INPUT(S)
  571.  
  572.         handle    - a valid handle
  573.         name      - a valid AmigaDOS FileName
  574.         spo_check - a pointer to a SPOCheckFile structure or NULL
  575.                     for disk-access (default)
  576.  
  577.    RESULT
  578.  
  579.         NULL or an adequate SVERR-Errorcode.
  580.  
  581.    SINCE
  582.  
  583.         ... Version 1 SPObjects.
  584.  
  585.    SEE ALSO
  586.  
  587.         -
  588.  
  589. -----------------------------------------------------------------------------
  590.  
  591.    NAME
  592.         SPO_SetReqIOWindow
  593.  
  594.    SYNOPSIS
  595.  
  596.         ULONG SPO_SetReqIOWindow(APTR handle, struct Window *window)
  597.         D0    -$6c               A1           A2
  598.  
  599.    FUNCTION
  600.  
  601.         Sets a new Default-Window (default : IntuitionBase->FirstWindow)
  602.         for any Requester IO.
  603.  
  604.    INPUT(S)
  605.  
  606.         handle - a valid handle
  607.         window - a valid Window Pointer or NULL
  608.  
  609.    RESULT
  610.  
  611.         NULL or an adequate SPERR-Errorcode.
  612.  
  613.    BUGS
  614.  
  615.         -
  616.  
  617.    SINCE
  618.  
  619.         ... version 1 of the superplay.library.
  620.  
  621.    SEE ALSO
  622.  
  623.         SPO_FileInfoReq
  624.  
  625. -----------------------------------------------------------------------------
  626.  
  627.    NAME
  628.         SPO_ContinueReplay
  629.  
  630.    SYNOPSIS
  631.  
  632.         ULONG SPO_ContinueReplay(APTR handle)
  633.         D0    -$72               A1
  634.  
  635.    FUNCTION
  636.  
  637.         Some SPObjects support to continue a Sample/Module which
  638.         has been stopped by calling SPO_StopReplay.
  639.  
  640.    INPUT(S)
  641.  
  642.         handle - a valid handle
  643.  
  644.    RESULT
  645.  
  646.         NULL or an adequate SPERR-Errorcode.
  647.  
  648.    BUGS
  649.  
  650.         -
  651.  
  652.    SINCE
  653.  
  654.         ... version 1 of the superplay.library.
  655.  
  656.    SEE ALSO
  657.  
  658.         SPO_SuperPlay, SPO_StopReplay
  659.  
  660. -----------------------------------------------------------------------------
  661.  
  662.    NAME
  663.         SPO_FastForward
  664.  
  665.    SYNOPSIS
  666.  
  667.         ULONG SPO_FastForward(APTR handle)
  668.         D0    -$78            A1
  669.  
  670.    FUNCTION
  671.  
  672.         Some SPObjects might support a "cassette recorder"-like way
  673.         to browse trough a Sample/Module via FastForward and Rewind.
  674.  
  675.    INPUT(S)
  676.  
  677.         handle - a valid handle
  678.  
  679.    RESULT
  680.  
  681.         NULL or an adequate SPERR-Errorcode.
  682.  
  683.    BUGS
  684.  
  685.         -
  686.  
  687.    SINCE
  688.  
  689.         ... version 1 of the superplay.library.
  690.  
  691.    SEE ALSO
  692.  
  693.         SPO_FastBackward
  694.  
  695. -----------------------------------------------------------------------------
  696.  
  697.    NAME
  698.         SPO_FastBackward
  699.  
  700.    SYNOPSIS
  701.  
  702.         ULONG SPO_FastBackward(APTR handle)
  703.         D0    -$7e            A1
  704.  
  705.    FUNCTION
  706.  
  707.         Some SPObjects might support a "cassette recorder"-like way
  708.         to browse trough a Sample/Module via FastForward and Rewind.
  709.  
  710.    INPUT(S)
  711.  
  712.         handle - a valid handle
  713.  
  714.    RESULT
  715.  
  716.         NULL or an adequate SPERR-Errorcode.
  717.  
  718.    BUGS
  719.  
  720.         -
  721.  
  722.    SINCE
  723.  
  724.         ... version 1 of the superplay.library.
  725.  
  726.    SEE ALSO
  727.  
  728.         SPO_FastForward
  729.  
  730. -----------------------------------------------------------------------------
  731.  
  732.    NAME
  733.         SPO_GetSampleBuffer         *** OBSOLETE : Use SPO_GetSampleList()
  734.  
  735.    SYNOPSIS
  736.  
  737.         ULONG SPO_GetSampleBuffer(APTR handle, UBYTE **buffer,
  738.         D0    -$84                A1           A2
  739.  
  740.                                   ULONG *buffersize)
  741.                                   A3
  742.  
  743.    FUNCTION
  744.  
  745.         With Version 1 SPObjects, this is the only possibility to get
  746.         a pointer to SampleBuffers.
  747.  
  748.         This function only works with SampleType-SPObjects and is used
  749.         always, when Samples are converted from from FileFormat into
  750.         an other.
  751.  
  752.         This function should not be used for any other purposes, since it
  753.         is OBSOLETE since Version 2 of the SPObject specification.
  754.         There's no direct pass-through from this function to superplay.library,
  755.         but it would not suffice, anyway, since some FileFormats may
  756.         contain MORE THAN ONE Sample.
  757.  
  758.         Use SPO_GetSampleList instead, which can handle more than one
  759.         Sample and also returns the information related to them.
  760.  
  761.    INPUT(S)
  762.  
  763.         handle     - a valid handle
  764.         buffer     - a pointer to a buffer pointer
  765.         buffersize - a pointer to a buffersize pointer
  766.  
  767.    RESULT
  768.  
  769.         NULL or an adequate SPERR-Errorcode.
  770.  
  771.    BUGS
  772.  
  773.         -
  774.  
  775.    SINCE
  776.  
  777.         ... version 1 of the superplay.library.
  778.  
  779.    SEE ALSO
  780.  
  781.         SPO_GetSampleList
  782.  
  783. -----------------------------------------------------------------------------
  784.  
  785.    NAME
  786.         SPO_GetSampleInfo           *** OBSOLETE : Use SPO_GetSampleList()
  787.  
  788.    SYNOPSIS
  789.  
  790.         ULONG SPO_GetSampleBuffer(APTR handle, ULONG *samplesPerSec,
  791.         D0    -$8a                A1           A2
  792.  
  793.                                   ULONG *volume, APTR future)
  794.                                   A3             D1
  795.  
  796.    FUNCTION
  797.  
  798.         With Version 1 SPObjects, this is the only possibility to get
  799.         a pointer to Sample information.
  800.  
  801.         This function only works with SampleType-SPObjects and is used
  802.         always, when Samples are converted from from FileFormat into
  803.         an other.
  804.  
  805.         This function should not be used for any other purposes, since it
  806.         is OBSOLETE since Version 2 of the SPObject specification.
  807.         There's no direct pass-through from this function to superplay.library,
  808.         but it would not suffice, anyway, since some FileFormats may
  809.         contain MORE THAN ONE Sample.
  810.  
  811.         Use SPO_GetSampleList instead, which can handle more than one
  812.         Sample and also returns the information related to them.
  813.  
  814.         This function only returns info on 8 Bit Samples.
  815.  
  816.    INPUT(S)
  817.  
  818.         handle        - a valid handle
  819.         samplesPerSec - a pointer to a buffer pointer
  820.         volume        - a pointer to a buffersize pointer
  821.         future        - always NULL yet
  822.  
  823.    RESULT
  824.  
  825.         NULL or an adequate SPERR-Errorcode.
  826.  
  827.    BUGS
  828.  
  829.         -
  830.  
  831.    SINCE
  832.  
  833.         ... version 1 of the superplay.library.
  834.  
  835.    SEE ALSO
  836.  
  837.         SPO_GetSampleList
  838.  
  839. -----------------------------------------------------------------------------
  840.    Functions added with Version 2 :
  841. -----------------------------------------------------------------------------
  842.  
  843.    NAME
  844.         SPO_GetSampleList
  845.  
  846.    SYNOPSIS
  847.  
  848.         ULONG SPO_GetSampleList(APTR handle, struct SPO_SampleList **list)
  849.         D0    -$90              A1           A2
  850.  
  851.    FUNCTION
  852.  
  853.         While/after loading a Sample-File Version 2 SPObjects might create
  854.         a special list of all Samples, which appear in the File.
  855.         This will usually be one one Sample for SampleFiles, but many more
  856.         for ModuleFiles.
  857.  
  858.         Not all SPObjects, especially not all ModuleType-SPObjects,
  859.         may support this and will return an error value or an empty list.
  860.  
  861.    INPUT(S)
  862.  
  863.         handle - a valid handle
  864.         list   - a pointer to a SPO_SampleList pointer
  865.  
  866.    RESULT
  867.  
  868.         NULL or an adequate SPERR-Errorcode.
  869.  
  870.    BUGS
  871.  
  872.         -
  873.  
  874.    SINCE
  875.  
  876.         ... version 2 of the superplay.library.
  877.  
  878.    SEE ALSO
  879.  
  880.         SPO_SetSampleList
  881.  
  882. -----------------------------------------------------------------------------
  883.  
  884.    NAME
  885.         SPO_SetSampleList
  886.  
  887.    SYNOPSIS
  888.  
  889.         ULONG SPO_SetSampleList(APTR handle, struct SPO_SampleList *list)
  890.         D0    -$96              A1           A2
  891.  
  892.    FUNCTION
  893.  
  894.         For saving Sample-Files with Version 2 SPObjects, there may be used
  895.         a special list of all Samples, which should appear in the File.
  896.  
  897.         This will usually be one one Sample for SampleFiles, but many more
  898.         for ModuleFiles.
  899.  
  900.         Not all SPObjects, especially not all ModuleType-SPObjects,
  901.         may support this and will return SPERR_ACTION_NOT_SUPPORTED.
  902.  
  903.    INPUT(S)
  904.  
  905.         handle - a valid handle
  906.         list   - a pointer to a SPO_SampleList
  907.  
  908.    RESULT
  909.  
  910.         NULL or an adequate SPERR-Errorcode.
  911.  
  912.    BUGS
  913.  
  914.         -
  915.  
  916.    SINCE
  917.  
  918.         ... version 2 of the superplay.library.
  919.  
  920.    SEE ALSO
  921.  
  922.         SPO_GetSampleList
  923.  
  924. -----------------------------------------------------------------------------
  925.