@database Sounds.guide
@remark ENGLISH VERSION
@author Eddie Churchill
@(c) "Copyright © 1993 Inovatronics, Inc."
@$VER: Sounds.guide 2.5 (06/01/93)
@wordwrap
@font topaz.font 8
@index "CanDo_LexiconIndex"

@node "CanDo_Sounds_Index" "Sounds Commands, Functions and Variables"
@toc "CanDo_LexiconMain"
@{fg highlight}Available Topics...@{fg text}

  Command  @{" AdjustVolume                   " link "CanDo_AdjustVolume"}
  Command  @{" AdjustPeriod                   " link "CanDo_AdjustPeriod"}
  Command  @{" Audio                          " link "CanDo_Audio"}
  Variable @{" =CurrentSongName               " link "CanDo_CurrentSongName"}
  Variable @{" =CurrentSongTempo              " link "CanDo_CurrentSongTempo"}
  Variable @{" =CurrentSongVolume             " link "CanDo_CurrentSongVolume"}
  Command  @{" LoadSound                      " link "CanDo_LoadSound"}
  Command  @{" PlaySong                       " link "CanDo_PlaySong"}
  Command  @{" PlaySound                      " link "CanDo_PlaySound"}
  Command  @{" PlaySoundSequence              " link "CanDo_PlaySoundSequence"}
  Command  @{" SetChannel                     " link "CanDo_SetChannel"}
  Command  @{" SetSongTempo                   " link "CanDo_SetSongTempo"}
  Command  @{" SetSongVolume                  " link "CanDo_SetSongVolume"}
  Command  @{" SetVolume                      " link "CanDo_SetVolume"}
  Command  @{" Song                           " link "CanDo_Song"}
  Function @{" =TimeLeftOnChannel()           " link "CanDo_TimeLeftOnChannel"}

@endnode

@node "CanDo_adjustvolume" "AdjustVolume {volume},{channel}"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  AdjustVolume {volume},{channel}

@{fg highlight}Parameters...@{fg text}

   {volume} = the new volume
  {channel} = the channel to adjust 

@{fg highlight}Description...@{fg text}

  Adjusts the volume of the currently playing sound, or sound sequence, on
the designated channel.  The effects of this command occur immediately.

  SEE ALSO: @{" AdjustPeriod " link "CanDo_AdjustPeriod"}.

@endnode

@node "CanDo_adjustperiod" "AdjustPeriod {period},{channel}"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  AdjustPeriod {period},{channel}

@{fg highlight}Parameters...@{fg text}

   {period} = the new period
  {channel} = the channel to adjust 

@{fg highlight}Description...@{fg text}

  Adjusts the period of the currently playing sound or sound sequence, on
the designated channel.  For sound sequences, each sound in the sequence is
adjusted to the new period.  The effects of this command occur
immediately.

  SEE ALSO: @{" AdjustVolume " link "CanDo_AdjustVolume"}.

@endnode

@node "CanDo_audio" "Audio {Logical} [,{Channel}]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Audio {Logical} [,{Channel}]

@{fg highlight}Description...@{fg text}

  This will turn @{" On " link "CanDo_On"} or @{" Off " link "CanDo_Off"} the audio channels.  Optionally, you can give
a specific channel to change.

@endnode

@node "CanDo_CurrentSongName" "Let {string} = CurrentSongName"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Let {string} = CurrentSongName

@{fg highlight}Description...@{fg text}

  Returns the name of the currently playing (or selected) song.

  SEE ALSO: @{" Song               " link "CanDo_Song"}
            @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongVolume      " link "CanDo_SetSongVolume"}
            @{" SetSongTempo       " link "CanDo_SetSongTempo"}
            @{" =CurrentSongVolume " link "CanDo_CurrentSongVolume"}
            @{" =CurrentSongTempo  " link "CanDo_CurrentSongTempo"}

@endnode

@node "CanDo_CurrentSongTempo" "Let {integer} = CurrentSongTempo" 
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Let {integer} = CurrentSongTempo

@{fg highlight}Description...@{fg text}

  Returns the tempo of the currently playing (or selected) song.

  SEE ALSO: @{" Song               " link "CanDo_Song"}
            @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongVolume      " link "CanDo_SetSongVolume"}
            @{" SetSongTempo       " link "CanDo_SetSongTempo"}
            @{" =CurrentSongName   " link "CanDo_CurrentSongName"}
            @{" =CurrentSongVolume " link "CanDo_CurrentSongVolume"}

@endnode

@node "CanDo_CurrentSongVolume" "Let {integer} = CurrentSongVolume"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Let {integer} = CurrentSongVolume

@{fg highlight}Description...@{fg text}

  Returns the volume of the currently playing (or selected) song.

  SEE ALSO: @{" Song               " link "CanDo_Song"}
            @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongVolume      " link "CanDo_SetSongVolume"}
            @{" SetSongTempo       " link "CanDo_SetSongTempo"}
            @{" =CurrentSongName   " link "CanDo_CurrentSongName"}
            @{" =CurrentSongTempo  " link "CanDo_CurrentSongTempo"}

@endnode

@node "CanDo_loadsound" "LoadSound {FilePath} [,{SoundBufferName} [,<loadflags>]]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  LoadSound {FilePath} [,{SoundBufferName} [,<loadflags>]]

@{fg highlight}Description...@{fg text}

  Preloads an 8SVX digitized sound.  See the manual for a full description
of this command.
  
  SEE ALSO: @{" PlaySound " link "CanDo_PlaySound"} and @{" PlaySoundSequence " link "CanDo_PlaySoundSequence"}.

@endnode

@node "CanDo_PlaySong" "PlaySong {filename or filepattern} [, WAIT CONTINUOUS]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  PlaySong {filename or filepattern} [, WAIT CONTINUOUS]

@{fg highlight}Parameters...@{fg text}

  {filename or filepattern} = the name of a song file, or a dos
                              pattern for a list of song patterns
       WAIT = Only loads the song(s) but doesn't play them
  CONTINOUS = Loops through the Songs.

@{fg highlight}Description...@{fg text}

  Loads and/or plays song files through the InovaMusic.library
  
  SEE ALSO: @{" Song              " link "CanDo_Song"}
            @{" SetSongVolume     " link "CanDo_SetSongVolume"}
            @{" SetSongTempo      " link "CanDo_SetSongTempo"}
            @{" =CurrentSongName  " link "CanDo_CurrentSongName"}

@endnode

@node "CanDo_playsound" "PlaySound {SoundBufferName} [,<audioflags> [,{PeriodRate}]]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  PlaySound {SoundBufferName} [,<audioflags> [,{PeriodRate}]]

@{fg highlight}Description...@{fg text}

  Plays an 8SVX digitized sound.
  
  SEE ALSO: @{" LoadSound " link "CanDo_LoadSound"} and @{" PlaySoundSequence " link "CanDo_PlaySoundSequence"}.

@endnode

@node "CanDo_playsoundsequence" "PlaySoundSequence {DocumentBufferName} [,<audioflags> [,PeriodRate}]]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  PlaySoundSequence {DocumentBufferName} [,<audioflags> [,PeriodRate}]]

@{fg highlight}Description...@{fg text}

  This will play the sounds listed in the given document, in sequence.
  
  SEE ALSO: @{" LoadSound " link "CanDo_LoadSound"} and @{" PlaySound " link "CanDo_PlaySound"}.

@endnode

@node "CanDo_setchannel" "SetChannel {ChannelNumber}"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  SetChannel {ChannelNumber}

@{fg highlight}Description...@{fg text}

  Specifies the channel that is used for the next @{" PlaySound " link "CanDo_PlaySound"} or
@{" PlaySoundSequence " link "CanDo_PlaySoundSequence"} command.  Normally these commands use any available
channel.  NOTE:  if any other application is using the {ChannelNumber}, the
sound will not be played.

@endnode

@node "CanDo_SetSongTempo" "SetSongTempo {tempo}"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  SetSongTempo {tempo}

@{fg highlight}Description...@{fg text}

  Adjusts the tempo of the currently playing song.  The values can range
from 10-60.

  SEE ALSO: @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongVolume      " link "CanDo_SetSongVolume"}
            @{" Song               " link "CanDo_Song"}
            @{" =CurrentSongVolume " link "CanDo_CurrentSongVolume"}
            @{" =CurrentSongTempo  " link "CanDo_CurrentSongTempo"}

@endnode

@node "CanDo_SetSongVolume" "SetSongVolume {volume}"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  SetSongVolume {volume}

@{fg highlight}Description...@{fg text}

  Adjusts the volume of the currently playing song.  The values can range
from 0-64.

  SEE ALSO: @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongTempo       " link "CanDo_SetSongTempo"}
            @{" Song               " link "CanDo_Song"}
            @{" =CurrentSongVolume " link "CanDo_CurrentSongVolume"}
            @{" =CurrentSongTempo  " link "CanDo_CurrentSongTempo"}
@endnode

@node "CanDo_setvolume" "SetVolume {Integer} [,{ChannelNumber}]"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  SetVolume {Integer} [,{ChannelNumber}]

@{fg highlight}Description...@{fg text}

  Sets the volume for subsequently played sounds, but not of the currently
playing sound.  The volume is between 0 and 64.  If channel is not
specified then all channels will be affected.

  SEE ALSO: @{" SetChannel " link "CanDo_SetChannel"}.

@endnode

@node "CanDo_Song" "Song <Options>"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Song Pause|Continue|Next|Previous|PlayFaster|PlaySlower|PlayNormally

@{fg highlight}Options...@{fg text}
  Pause        =  Pause a song.
  Continue     =  Continue playing a paused (or recently loaded) song.
  Next         =  Switch to next song in song list.
  Previous     =  Switch to previous song in song list.
  PlayFaster   =  Increase the Tempo of the song.
  PlaySlower   =  Decrease the Tempo of the song.
  PlayNormally =  Reset the Tempo back to its loaded tempo.

@{fg highlight}Description...@{fg text}

  Adjusts the currently playing (or selected) song.

  SEE ALSO: @{" PlaySong           " link "CanDo_PlaySong"}
            @{" SetSongVolume      " link "CanDo_SetSongVolume"}
            @{" SetSongTempo       " link "CanDo_SetSongTempo"}
            @{" =CurrentSongVolume " link "CanDo_CurrentSongVolume"}
            @{" =CurrentSongTempo  " link "CanDo_CurrentSongTempo"}

@endnode

@node "CanDo_timeleftonchannel" "Let {Integer}=TimeLeftOnChannel({ChannelNumber})"
@toc "CanDo_Sounds_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=TimeLeftOnChannel({ChannelNumber})

@{fg highlight}Description...@{fg text}

  Returns the number of seconds remaining for a sound playing on the
specified channel.

@endnode