Changeset 0b96b7ca02af144cbd93dea9f9393ffb7d1b3a15

Show
Ignore:
Timestamp:
04/23/08 19:32:48 (5 months ago)
Author:
Olivier Aubert <olivier.aubert@liris.cnrs.fr>
git-committer:
Olivier Aubert <olivier.aubert@liris.cnrs.fr> 1208971968 +0200
git-parent:

[122a7d863270ca265144610276b5198396a66708]

git-author:
Olivier Aubert <olivier.aubert@liris.cnrs.fr> 1208184717 +0200
Message:

Some documentation fixes (following the mediainstance->mediaplayer renaming)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • include/vlc/libvlc.h

    r449fd28 r0b96b7c  
    176176 
    177177/***************************************************************************** 
    178  * Media descriptor 
     178 * media 
    179179 *****************************************************************************/ 
    180180/** \defgroup libvlc_media libvlc_media 
    181181 * \ingroup libvlc 
    182  * LibVLC Media Descriptor 
    183  * @{ 
    184  */ 
    185  
    186 /** 
    187  * Create a media descriptor with the given MRL. 
     182 * LibVLC Media 
     183 * @{ 
     184 */ 
     185 
     186/** 
     187 * Create a media with the given MRL. 
    188188 * 
    189189 * \param p_instance the instance 
    190190 * \param psz_mrl the MRL to read 
    191191 * \param p_e an initialized exception pointer 
    192  * \return the newly created media descriptor 
     192 * \return the newly created media 
    193193 */ 
    194194VLC_PUBLIC_API libvlc_media_t * libvlc_media_new( 
    …… 
    198198 
    199199/** 
    200  * Create a media descriptor as an empty node with the passed name. 
     200 * Create a media as an empty node with the passed name. 
    201201 * 
    202202 * \param p_instance the instance 
    203203 * \param psz_name the name of the node 
    204204 * \param p_e an initialized exception pointer 
    205  * \return the new empty media descriptor 
     205 * \return the new empty media 
    206206 */ 
    207207VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( 
    …… 
    211211 
    212212/** 
    213  * Add an option to the media descriptor. 
     213 * Add an option to the media. 
    214214 * 
    215215 * This option will be used to determine how the media_player will 
    …… 
    240240 
    241241/** 
    242  * Read the meta of the media descriptor. 
    243  * 
    244  * \param p_meta_desc the media descriptor to read 
     242 * Read the meta of the media. 
     243 * 
     244 * \param p_meta_desc the media to read 
    245245 * \param p_meta_desc the meta to read 
    246246 * \param p_e an initialized exception pointer 
    247  * \return the media descriptor's meta 
     247 * \return the media's meta 
    248248 */ 
    249249VLC_PUBLIC_API char * libvlc_media_get_meta( 
    …… 
    283283 
    284284/***************************************************************************** 
    285  * Media Instance 
     285 * Media Player 
    286286 *****************************************************************************/ 
    287287/** \defgroup libvlc_media_player libvlc_media_player 
    288288 * \ingroup libvlc 
    289  * LibVLC Media Instance, object that let you play a media descriptor 
     289 * LibVLC Media Player, object that let you play a media 
    290290 * in a libvlc_drawable_t 
    291291 * @{ 
    …… 
    293293 
    294294/**  
    295  * Create an empty Media Instance object 
    296  * 
    297  * \param p_libvlc_instance the libvlc instance in which the Media Instance 
     295 * Create an empty Media Player object 
     296 * 
     297 * \param p_libvlc_instance the libvlc instance in which the Media Player 
    298298 *        should be created. 
    299299 * \param p_e an initialized exception pointer 
    …… 
    302302 
    303303/** 
    304  * Create a Media Instance object from a Media Descriptor 
    305  * 
    306  * \param p_md the media descriptor. Afterwards the p_md can be safely 
     304 * Create a Media Player object from a Media 
     305 * 
     306 * \param p_md the media. Afterwards the p_md can be safely 
    307307 *        destroyed. 
    308308 * \param p_e an initialized exception pointer 
    …… 
    313313 * Release a media_player after use 
    314314 * 
    315  * \param p_mi the Media Instance to free 
     315 * \param p_mi the Media Player to free 
    316316 */ 
    317317VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * ); 
    318318VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * ); 
    319319 
    320 /** Set the media descriptor that will be used by the media_player. If any, 
     320/** Set the media that will be used by the media_player. If any, 
    321321 * previous md will be released. 
    322322 * 
    323  * \param p_mi the Media Instance 
    324  * \param p_md the Media Descriptor. Afterwards the p_md can be safely 
     323 * \param p_mi the Media Player 
     324 * \param p_md the Media. Afterwards the p_md can be safely 
    325325 *        destroyed. 
    326326 * \param p_e an initialized exception pointer 
    …… 
    329329 
    330330/** 
    331  * Get the media descriptor used by the media_player.  
    332  * 
    333  * \param p_mi the Media Instance 
    334  * \param p_e an initialized exception pointer 
    335  * \return the media descriptor associated with p_mi, or NULL if no 
    336  *         media descriptor is associated 
     331 * Get the media used by the media_player.  
     332 * 
     333 * \param p_mi the Media Player 
     334 * \param p_e an initialized exception pointer 
     335 * \return the media associated with p_mi, or NULL if no 
     336 *         media is associated 
    337337 */ 
    338338VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * ); 
    339339 
    340340/** 
    341  * Get the Event Manager from which the media instance send event. 
    342  * 
    343  * \param p_mi the Media Instance 
     341 * Get the Event Manager from which the media player send event. 
     342 * 
     343 * \param p_mi the Media Player 
    344344 * \param p_e an initialized exception pointer 
    345345 * \return the event manager associated with p_mi 
    …… 
    350350 * Play  
    351351 * 
    352  * \param p_mi the Media Instance 
     352 * \param p_mi the Media Player 
    353353 * \param p_e an initialized exception pointer 
    354354 */ 
    …… 
    358358 * Pause  
    359359 * 
    360  * \param p_mi the Media Instance 
     360 * \param p_mi the Media Player 
    361361 * \param p_e an initialized exception pointer 
    362362 */ 
    …… 
    366366 * Stop  
    367367 * 
    368  * \param p_mi the Media Instance 
     368 * \param p_mi the Media Player 
    369369 * \param p_e an initialized exception pointer 
    370370 */ 
    …… 
    372372 
    373373/** 
    374  * Set the drawable where the media instance should render its video output 
    375  * 
    376  * \param p_mi the Media Instance 
    377  * \param drawable the libvlc_drawable_t where the media instance 
     374 * Set the drawable where the media player should render its video output 
     375 * 
     376 * \param p_mi the Media Player 
     377 * \param drawable the libvlc_drawable_t where the media player 
    378378 *        should render its video 
    379379 * \param p_e an initialized exception pointer 
    …… 
    382382 
    383383/** 
    384  * Get the drawable where the media instance should render its video output 
    385  * 
    386  * \param p_mi the Media Instance 
    387  * \param p_e an initialized exception pointer 
    388  * \return the libvlc_drawable_t where the media instance 
     384 * Get the drawable where the media player should render its video output 
     385 * 
     386 * \param p_mi the Media Player 
     387 * \param p_e an initialized exception pointer 
     388 * \return the libvlc_drawable_t where the media player 
    389389 *         should render its video 
    390390 */ 
    …… 
    408408 
    409409/** 
    410  * Does this media instance have a video output? 
    411  * 
    412  * \param p_md the media instance 
     410 * Does this media player have a video output? 
     411 * 
     412 * \param p_md the media player 
    413413 * \param p_e an initialized exception pointer 
    414414 */ 
    …… 
    416416 
    417417/** 
    418  * Is this media instance seekable? 
     418 * Is this media player seekable? 
    419419 * 
    420420 * \param p_input the input 
    …… 
    424424 
    425425/** 
    426  * Can this media instance be paused? 
     426 * Can this media player be paused? 
    427427 * 
    428428 * \param p_input the input 
    …… 
    709709 * Get number of available audio tracks. 
    710710 * 
    711  * \param p_mi media instance 
     711 * \param p_mi media player 
    712712 * \param p_e an initialized exception 
    713713 * \return the number of available audio tracks (int) 
    …… 
    718718 * Get current audio track. 
    719719 * 
    720  * \param p_input input instance 
     720 * \param p_mi media player 
    721721 * \param p_e an initialized exception pointer 
    722722 * \return the audio track (int) 
    …… 
    727727 * Set current audio track. 
    728728 * 
    729  * \param p_input input instance 
     729 * \param p_mi media player 
    730730 * \param i_track the track (int) 
    731731 * \param p_e an initialized exception pointer 
    …… 
    736736 * Get current audio channel. 
    737737 * 
    738  * \param p_instance input instance 
     738 * \param p_instance vlc instance 
    739739 * \param p_e an initialized exception pointer 
    740740 * \return the audio channel (int) 
    …… 
    745745 * Set current audio channel. 
    746746 * 
    747  * \param p_instance input instance 
     747 * \param p_instance vlc instance 
    748748 * \param i_channel the audio channel (int) 
    749749 * \param p_e an initialized exception pointer