mirror of
https://github.com/ZDoom/fluidsynth.git
synced 2024-12-11 05:11:33 +00:00
add documentation to new fluid_player getters
This commit is contained in:
parent
da1b95cb19
commit
27c347a28d
1 changed files with 30 additions and 8 deletions
|
@ -1785,12 +1785,23 @@ fluid_player_join(fluid_player_t *player)
|
|||
return FLUID_OK;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get the number of tempo ticks passed.
|
||||
* @param player MIDI player instance
|
||||
* @return The number of tempo ticks passed
|
||||
* @since 1.1.7
|
||||
*/
|
||||
int fluid_player_get_current_tick(fluid_player_t * player)
|
||||
{
|
||||
return player->cur_ticks;
|
||||
}
|
||||
|
||||
/**
|
||||
* Looks through all available MIDI tracks and gets the absolute tick of the very last event to play.
|
||||
* @param player MIDI player instance
|
||||
* @return Total tick count of the sequence
|
||||
* @since 1.1.7
|
||||
*/
|
||||
int fluid_player_get_total_ticks(fluid_player_t * player)
|
||||
{
|
||||
int i;
|
||||
|
@ -1803,14 +1814,25 @@ int fluid_player_get_total_ticks( fluid_player_t * player )
|
|||
}
|
||||
}
|
||||
return maxTicks;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tempo of a MIDI player in beats per minute.
|
||||
* @param player MIDI player instance
|
||||
* @return MIDI player tempo in BPM
|
||||
* @since 1.1.7
|
||||
*/
|
||||
int fluid_player_get_bpm(fluid_player_t * player)
|
||||
{
|
||||
return (int)(60e6 / player->miditempo);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tempo of a MIDI player.
|
||||
* @param player MIDI player instance
|
||||
* @return Tempo of the MIDI player (in microseconds per quarter note, as per MIDI file spec)
|
||||
* @since 1.1.7
|
||||
*/
|
||||
int fluid_player_get_midi_tempo(fluid_player_t * player)
|
||||
{
|
||||
return player->miditempo;
|
||||
|
|
Loading…
Reference in a new issue