Skip to content

V
vlc-2-2
Commit 3c0ce0d3 authored by Olivier Aubert's avatar Olivier Aubert
Browse files
Options

libvlc: document the get_/set_position value range

parent 24f8bc8d
Hide whitespace changes
Inline Side-by-side
Showing with 3 additions and 2 deletions
include/vlc/libvlc_media_player.h
View file @ 3c0ce0d3
...@@ -640,7 +640,7 @@ LIBVLC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *p_ ...@@ -640,7 +640,7 @@ LIBVLC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *p_
LIBVLC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvlc_time_t i_time ); LIBVLC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvlc_time_t i_time );
/** /**
* Get movie position. * Get movie position as percentage between 0.0 and 1.0.
* *
* \param p_mi the Media Player * \param p_mi the Media Player
* \return movie position, or -1. in case of error * \return movie position, or -1. in case of error
...@@ -648,7 +648,8 @@ LIBVLC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvl ...@@ -648,7 +648,8 @@ LIBVLC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvl
LIBVLC_API float libvlc_media_player_get_position( libvlc_media_player_t *p_mi ); LIBVLC_API float libvlc_media_player_get_position( libvlc_media_player_t *p_mi );
/** /**
* Set movie position. This has no effect if playback is not enabled. * Set movie position as percentage between 0.0 and 1.0.
* This has no effect if playback is not enabled.
* This might not work depending on the underlying input format and protocol. * This might not work depending on the underlying input format and protocol.
* *
* \param p_mi the Media Player * \param p_mi the Media Player
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment