CatchMusic()

Syntax

Result = CatchMusic(#Music, *Buffer, Size)

Loads the specified music from the specified memory buffer. PlayMusic() can be used to start playing the music. ModPlug supports a lot of music formats, which includes: Protracker (4 channels), FastTracker (up to 32 channels, 16-bit quality), Impulse Tracker, etc.

Parameters

#Music	A number to identify the new music module. #PB_Any can be used to auto-generate this number.
*Buffer	The memory buffer to load the music module from.
Size	The buffer size.

Return value

Nonzero if the music module has been successfully loaded, zero otherwise.

Remarks

This function is useful when using the 'IncludeBinary' PureBasic keyword. Then music modules can be packed inside the executable. Nevertheless, use this option with care, as it will take more memory than storing the music in an external file (the music is both in executable memory and load in physical memory).

Example

  CatchMusic(0, ?Music, ?MusicEnd-?Music)
  End

  DataSection
    Music:
      IncludeBinary "Music.xm"
    MusicEnd:
  EndDataSection

See Also

LoadMusic(), PlayMusic()

Supported OS

All