MusFxBankNumberOfEffects()

Syntax

int MusFxBankNumberOfEffects(void *ifxbank);

Arguments

ifxbank
the address of an initialized sound effect bank

Description

It gets the number of sound effects stored in the specified initialized sound effect bank. When starting sound effects using a sound effect bank, the valid range is 0 to MusFxBankNumberOfEffects()-1 inclusive.

The ifxbank must contain the address of a sound effect bank initialized with the MusFxBankInitialize() function.

Return Value

Number of sound effects in the specified sound effect bank.

Example

musHandle AudioStartEffect(void *fxbank, int number)
{
  musHandle handle;

  if (number>=MusFxBankNumberOfEffects(fxbank))
    return (0); /* failure! */
  MusFxBankSetSingle(fxbank);
  handle = MusStartEffect(number);
  return (handle);
}

See Also

MusFxBankInitialize()