mirror of
https://github.com/ZDoom/fluidsynth.git
synced 2024-12-03 17:42:21 +00:00
update api doc
fluid_player_seek returns FLUID_FAILED if ticks is negative
This commit is contained in:
parent
64eda30cf4
commit
58ec452054
1 changed files with 4 additions and 4 deletions
|
@ -1734,18 +1734,18 @@ fluid_player_get_status(fluid_player_t *player)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Seek in the current playing file.
|
* Seek in the currently playing file.
|
||||||
* @param player MIDI player instance
|
* @param player MIDI player instance
|
||||||
* @param ticks the position to seek to in the current file
|
* @param ticks the position to seek to in the current file
|
||||||
* @return #FLUID_FAILED if ticks is after the latest tick of the file,
|
* @return #FLUID_FAILED if ticks is negative of after the latest tick of the file,
|
||||||
* #FLUID_OK otherwise
|
* #FLUID_OK otherwise
|
||||||
* @since 1.1.8
|
* @since 1.1.9
|
||||||
*
|
*
|
||||||
* The actual seek is performed during the player_callback.
|
* The actual seek is performed during the player_callback.
|
||||||
*/
|
*/
|
||||||
int fluid_player_seek(fluid_player_t *player, int ticks)
|
int fluid_player_seek(fluid_player_t *player, int ticks)
|
||||||
{
|
{
|
||||||
if (ticks > fluid_player_get_total_ticks(player)) {
|
if (ticks < 0 || ticks > fluid_player_get_total_ticks(player)) {
|
||||||
return FLUID_FAILED;
|
return FLUID_FAILED;
|
||||||
}
|
}
|
||||||
player->seek_ticks = ticks;
|
player->seek_ticks = ticks;
|
||||||
|
|
Loading…
Reference in a new issue