player: improve documentation

This commit is contained in:
Thomas Guillem 2019-06-19 13:31:51 +02:00
parent cb1b9717d0
commit 713f6e51c8
1 changed files with 9 additions and 0 deletions

View File

@ -100,6 +100,12 @@ struct vlc_player_program
/**
* Player track structure.
*
* A track is a representation of an ES identifier at a given time. Once the
* player is unlocked, all content except the es_id pointer can be updated.
*
* @see vlc_player_cbs.on_track_list_changed
* @see vlc_player_GetTrack
*/
struct vlc_player_track
{
@ -938,6 +944,9 @@ struct vlc_player_aout_cbs
* This function can be used to pass a track from a callback to an other
* context. The es_id will be held by the duplicated track.
*
* @warning The returned track won't be updated if the original one is modified
* by the player.
*
* @see vlc_player_cbs.on_track_list_changed
*
* @return a duplicated track or NULL on allocation error