HGE::Music_Play

Starts playing a music.

HCHANNEL Music_Play(
  HMUSIC music,
  bool loop,
  int volume = 100,
  int order = -1,
  int row = -1
);

Parameters

music

Handle of a music to be played.

loop

If true, the music is looped until the audio channel is stopped manually.
If false the music is played once.

volume

Starting volume, 0..100. Optional.

order

Starting order. -1 = use current. Optional.

row

Starting row. -1 = use current. Optional.

Return value

Returns the audio channel handle through which the music is played. Use this handle with audio channel control functions.

Remarks

Only one instance of a music can be played at the same time. If the music is already playing, it is restarted with default parameters.

Requirements

Header: hge.h
Import library: hge.lib

See also

Music_Load, Music_Free