git.sesse.net Git - vlc/blob - include/vlc/libvlc_media_player.h

   1 /*****************************************************************************
   2  * libvlc_media_player.h:  libvlc_media_player external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /**
  27  * \file
  28  * This file defines libvlc_media_player external API
  29  */
  30
  31 #ifndef VLC_LIBVLC_MEDIA_PLAYER_H
  32 #define VLC_LIBVLC_MEDIA_PLAYER_H 1
  33
  34 /*****************************************************************************
  35  * Media Player
  36  *****************************************************************************/
  37 /** \defgroup libvlc_media_player libvlc_media_player
  38  * \ingroup libvlc
  39  * LibVLC Media Player, object that let you play a media
  40  * in a custom drawable
  41  * @{
  42  */
  43
  44 typedef struct libvlc_media_player_t libvlc_media_player_t;
  45
  46 /**
  47  * Description for video, audio tracks and subtitles. It contains
  48  * id, name (description string) and pointer to next record.
  49  */
  50 typedef struct libvlc_track_description_t
  51 {
  52     int   i_id;
  53     char *psz_name;
  54     struct libvlc_track_description_t *p_next;
  55
  56 } libvlc_track_description_t;
  57
  58 /**
  59  * Description for audio output. It contains
  60  * name, description and pointer to next record.
  61  */
  62 typedef struct libvlc_audio_output_t
  63 {
  64     char *psz_name;
  65     char *psz_description;
  66     struct libvlc_audio_output_t *p_next;
  67
  68 } libvlc_audio_output_t;
  69
  70 /**
  71  * Rectangle type for video geometry
  72  */
  73 typedef struct libvlc_rectangle_t
  74 {
  75     int top, left;
  76     int bottom, right;
  77 } libvlc_rectangle_t;
  78
  79 /**
  80  * Marq int options definition
  81  */
  82 typedef enum libvlc_video_marquee_int_option_t {
  83     libvlc_marquee_Enabled = 0,
  84     libvlc_marquee_Color,
  85     libvlc_marquee_Opacity,
  86     libvlc_marquee_Position,
  87     libvlc_marquee_Refresh,
  88     libvlc_marquee_Size,
  89     libvlc_marquee_Timeout,
  90     libvlc_marquee_X,
  91     libvlc_marquee_Y
  92 } libvlc_video_marquee_int_option_t;
  93
  94 /**
  95  * Marq string options definition
  96  */
  97 typedef enum libvlc_video_marquee_string_option_t {
  98     libvlc_marquee_Text = 0
  99 } libvlc_video_marquee_string_option_t;
 100
 101
 102 /**
 103  * Create an empty Media Player object
 104  *
 105  * \param p_libvlc_instance the libvlc instance in which the Media Player
 106  *        should be created.
 107  * \param p_e an initialized exception pointer
 108  */
 109 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
 110
 111 /**
 112  * Create a Media Player object from a Media
 113  *
 114  * \param p_md the media. Afterwards the p_md can be safely
 115  *        destroyed.
 116  * \param p_e an initialized exception pointer
 117  */
 118 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
 119
 120 /**
 121  * Release a media_player after use
 122  * Decrement the reference count of a media player object. If the
 123  * reference count is 0, then libvlc_media_player_release() will
 124  * release the media player object. If the media player object
 125  * has been released, then it should not be used again.
 126  *
 127  * \param p_mi the Media Player to free
 128  */
 129 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
 130
 131 /**
 132  * Retain a reference to a media player object. Use
 133  * libvlc_media_player_release() to decrement reference count.
 134  *
 135  * \param p_mi media player object
 136  */
 137 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
 138
 139 /**
 140  * Set the media that will be used by the media_player. If any,
 141  * previous md will be released.
 142  *
 143  * \param p_mi the Media Player
 144  * \param p_md the Media. Afterwards the p_md can be safely
 145  *        destroyed.
 146  * \param p_e an initialized exception pointer
 147  */
 148 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
 149
 150 /**
 151  * Get the media used by the media_player.
 152  *
 153  * \param p_mi the Media Player
 154  * \param p_e an initialized exception pointer
 155  * \return the media associated with p_mi, or NULL if no
 156  *         media is associated
 157  */
 158 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
 159
 160 /**
 161  * Get the Event Manager from which the media player send event.
 162  *
 163  * \param p_mi the Media Player
 164  * \param p_e an initialized exception pointer
 165  * \return the event manager associated with p_mi
 166  */
 167 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
 168
 169 /**
 170  * is_playing
 171  *
 172  * \param p_mi the Media Player
 173  * \param p_e an initialized exception pointer
 174  * \return 1 if the media player is playing, 0 otherwise
 175  */
 176 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
 177
 178 /**
 179  * Play
 180  *
 181  * \param p_mi the Media Player
 182  * \param p_e an initialized exception pointer
 183  */
 184 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
 185
 186 /**
 187  * Pause
 188  *
 189  * \param p_mi the Media Player
 190  * \param p_e an initialized exception pointer
 191  */
 192 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
 193
 194 /**
 195  * Stop
 196  *
 197  * \param p_mi the Media Player
 198  * \param p_e an initialized exception pointer
 199  */
 200 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
 201
 202 /**
 203  * Set the agl handler where the media player should render its video output.
 204  *
 205  * \param p_mi the Media Player
 206  * \param drawable the agl handler
 207  * \param p_e an initialized exception pointer
 208  */
 209 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable, libvlc_exception_t *p_e );
 210
 211 /**
 212  * Get the agl handler previously set with libvlc_media_player_set_agl().
 213  *
 214  * \return the agl handler or 0 if none where set
 215  */
 216 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
 217
 218 /**
 219  * Set the agl handler where the media player should render its video output.
 220  *
 221  * \param p_mi the Media Player
 222  * \param drawable the agl handler
 223  * \param p_e an initialized exception pointer
 224  */
 225 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
 226
 227 /**
 228  * Get the agl handler previously set with libvlc_media_player_set_agl().
 229  *
 230  * \return the agl handler or 0 if none where set
 231  */
 232 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
 233
 234 /**
 235  * Set an X Window System drawable where the media player should render its
 236  * video output. If LibVLC was built without X11 output support, then this has
 237  * no effects.
 238  *
 239  * The specified identifier must correspond to an existing Input/Output class
 240  * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
 241  * the X11 server is the same as the one the VLC instance has been configured
 242  * with.
 243  * If XVideo is <b>not</b> used, it is assumed that the drawable has the
 244  * following properties in common with the default X11 screen: depth, scan line
 245  * pad, black pixel. This is a bug.
 246  *
 247  * \param p_mi the Media Player
 248  * \param drawable the ID of the X window
 249  * \param p_e an initialized exception pointer
 250  */
 251 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
 252
 253 /**
 254  * Get the X Window System window identifier previously set with
 255  * libvlc_media_player_set_xwindow(). Note that this will return the identifier
 256  * even if VLC is not currently using it (for instance if it is playing an
 257  * audio-only input).
 258  *
 259  * \return an X window ID, or 0 if none where set.
 260  */
 261 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
 262
 263 /**
 264  * Set a Win32/Win64 API window handle (HWND) where the media player should
 265  * render its video output. If LibVLC was built without Win32/Win64 API output
 266  * support, then this has no effects.
 267  *
 268  * \param p_mi the Media Player
 269  * \param drawable windows handle of the drawable
 270  * \param p_e an initialized exception pointer
 271  */
 272 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
 273
 274 /**
 275  * Get the Windows API window handle (HWND) previously set with
 276  * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
 277  * is not currently outputting any video to it.
 278  *
 279  * \return a window handle or NULL if there are none.
 280  */
 281 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
 282
 283
 284
 285 /** \bug This might go away ... to be replaced by a broader system */
 286
 287 /**
 288  * Get the current movie length (in ms).
 289  *
 290  * \param p_mi the Media Player
 291  * \param p_e an initialized exception pointer
 292  * \return the movie length (in ms).
 293  */
 294 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
 295
 296 /**
 297  * Get the current movie time (in ms).
 298  *
 299  * \param p_mi the Media Player
 300  * \param p_e an initialized exception pointer
 301  * \return the movie time (in ms).
 302  */
 303 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
 304
 305 /**
 306  * Set the movie time (in ms).
 307  *
 308  * \param p_mi the Media Player
 309  * \param the movie time (in ms).
 310  * \param p_e an initialized exception pointer
 311  */
 312 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
 313
 314 /**
 315  * Get movie position.
 316  *
 317  * \param p_mi the Media Player
 318  * \param p_e an initialized exception pointer
 319  * \return movie position
 320  */
 321 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
 322
 323 /**
 324  * Set movie position.
 325  *
 326  * \param p_mi the Media Player
 327  * \param p_e an initialized exception pointer
 328  * \return movie position
 329  */
 330 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
 331
 332 /**
 333  * Set movie chapter
 334  *
 335  * \param p_mi the Media Player
 336  * \param i_chapter chapter number to play
 337  * \param p_e an initialized exception pointer
 338  */
 339 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
 340
 341 /**
 342  * Get movie chapter
 343  *
 344  * \param p_mi the Media Player
 345  * \param p_e an initialized exception pointer
 346  * \return chapter number currently playing
 347  */
 348 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
 349
 350 /**
 351  * Get movie chapter count
 352  *
 353  * \param p_mi the Media Player
 354  * \param p_e an initialized exception pointer
 355  * \return number of chapters in movie
 356  */
 357 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
 358 VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
 359
 360 /**
 361  * Get title chapter count
 362  *
 363  * \param p_mi the Media Player
 364  * \param i_title title
 365  * \param p_e an initialized exception pointer
 366  * \return number of chapters in title
 367  */
 368 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
 369                        libvlc_media_player_t *, int, libvlc_exception_t *);
 370
 371 /**
 372  * Set movie title
 373  *
 374  * \param p_mi the Media Player
 375  * \param i_title title number to play
 376  * \param p_e an initialized exception pointer
 377  */
 378 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
 379
 380 /**
 381  * Get movie title
 382  *
 383  * \param p_mi the Media Player
 384  * \param p_e an initialized exception pointer
 385  * \return title number currently playing
 386  */
 387 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
 388
 389 /**
 390  * Get movie title count
 391  *
 392  * \param p_mi the Media Player
 393  * \param p_e an initialized exception pointer
 394  * \return title number count
 395  */
 396 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
 397
 398 /**
 399  * Set previous chapter
 400  *
 401  * \param p_mi the Media Player
 402  * \param p_e an initialized exception pointer
 403  */
 404 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 405
 406 /**
 407  * Set next chapter
 408  *
 409  * \param p_mi the Media Player
 410  * \param p_e an initialized exception pointer
 411  */
 412 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 413
 414 /**
 415  * Get movie play rate
 416  *
 417  * \param p_mi the Media Player
 418  * \param p_e an initialized exception pointer
 419  * \return movie play rate
 420  */
 421 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
 422
 423 /**
 424  * Set movie play rate
 425  *
 426  * \param p_mi the Media Player
 427  * \param movie play rate to set
 428  * \param p_e an initialized exception pointer
 429  */
 430 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
 431
 432 /**
 433  * Get current movie state
 434  *
 435  * \param p_mi the Media Player
 436  * \param p_e an initialized exception pointer
 437  * \return current movie state as libvlc_state_t
 438  */
 439 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
 440
 441 /**
 442  * Get movie fps rate
 443  *
 444  * \param p_mi the Media Player
 445  * \param p_e an initialized exception pointer
 446  * \return frames per second (fps) for this playing movie
 447  */
 448 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
 449
 450 /** end bug */
 451
 452 /**
 453  * Does this media player have a video output?
 454  *
 455  * \param p_md the media player
 456  * \param p_e an initialized exception pointer
 457  */
 458 VLC_PUBLIC_API int  libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
 459
 460 /**
 461  * Is this media player seekable?
 462  *
 463  * \param p_input the input
 464  * \param p_e an initialized exception pointer
 465  */
 466 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 467
 468 /**
 469  * Can this media player be paused?
 470  *
 471  * \param p_input the input
 472  * \param p_e an initialized exception pointer
 473  */
 474 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 475
 476 /**
 477  * Release (free) libvlc_track_description_t
 478  *
 479  * \param p_track_description the structure to release
 480  */
 481 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
 482
 483 /** \defgroup libvlc_video libvlc_video
 484  * \ingroup libvlc_media_player
 485  * LibVLC Video handling
 486  * @{
 487  */
 488
 489 /**
 490  * Toggle fullscreen status on video output.
 491  *
 492  * \param p_mediaplayer the media player
 493  * \param p_e an initialized exception pointer
 494  */
 495 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 496
 497 /**
 498  * Enable or disable fullscreen on a video output.
 499  *
 500  * \param p_mediaplayer the media player
 501  * \param b_fullscreen boolean for fullscreen status
 502  * \param p_e an initialized exception pointer
 503  */
 504 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
 505
 506 /**
 507  * Get current fullscreen status.
 508  *
 509  * \param p_mediaplayer the media player
 510  * \param p_e an initialized exception pointer
 511  * \return the fullscreen status (boolean)
 512  */
 513 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 514
 515 /**
 516  * Get current video height.
 517  *
 518  * \param p_mediaplayer the media player
 519  * \param p_e an initialized exception pointer
 520  * \return the video height
 521  */
 522 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
 523
 524 /**
 525  * Get current video width.
 526  *
 527  * \param p_mediaplayer the media player
 528  * \param p_e an initialized exception pointer
 529  * \return the video width
 530  */
 531 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
 532
 533 /**
 534  * Get the current video scaling factor.
 535  * See also libvlc_video_set_scale().
 536  *
 537  * \param p_mediaplayer the media player
 538  * \return the currently configured zoom factor, or 0. if the video is set
 539  * to fit to the output window/drawable automatically.
 540  */
 541 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *,
 542                                              libvlc_exception_t *p_e );
 543
 544 /**
 545  * Set the video scaling factor. That is the ratio of the number of pixels on
 546  * screen to the number of pixels in the original decoded video in each
 547  * dimension. Zero is a special value; it will adjust the video to the output
 548  * window/drawable (in windowed mode) or the entire screen.
 549  *
 550  * Note that not all video outputs support scaling.
 551  *
 552  * \param p_mediaplayer the media player
 553  * \param i_factor the scaling factor, or zero
 554  */
 555 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float,
 556                                             libvlc_exception_t *p_e );
 557
 558 /**
 559  * Get current video aspect ratio.
 560  *
 561  * \param p_mediaplayer the media player
 562  * \param p_e an initialized exception pointer
 563  * \return the video aspect ratio
 564  */
 565 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
 566
 567 /**
 568  * Set new video aspect ratio.
 569  *
 570  * \param p_mediaplayer the media player
 571  * \param psz_aspect new video aspect-ratio
 572  * \param p_e an initialized exception pointer
 573  */
 574 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
 575
 576 /**
 577  * Get current video subtitle.
 578  *
 579  * \param p_mediaplayer the media player
 580  * \param p_e an initialized exception pointer
 581  * \return the video subtitle selected
 582  */
 583 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
 584
 585 /**
 586  * Get the number of available video subtitles.
 587  *
 588  * \param p_mediaplayer the media player
 589  * \param p_e an initialized exception pointer
 590  * \return the number of available video subtitles
 591  */
 592 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
 593
 594 /**
 595  * Get the description of available video subtitles.
 596  *
 597  * \param p_mediaplayer the media player
 598  * \param p_e an initialized exception pointer
 599  * \return list containing description of available video subtitles
 600  */
 601 VLC_PUBLIC_API libvlc_track_description_t *
 602         libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
 603
 604 /**
 605  * Set new video subtitle.
 606  *
 607  * \param p_mediaplayer the media player
 608  * \param i_spu new video subtitle to select
 609  * \param p_e an initialized exception pointer
 610  */
 611 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
 612
 613 /**
 614  * Set new video subtitle file.
 615  *
 616  * \param p_mediaplayer the media player
 617  * \param psz_subtitle new video subtitle file
 618  * \param p_e an initialized exception pointer
 619  * \return the success status (boolean)
 620  */
 621 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
 622
 623 /**
 624  * Get the description of available titles.
 625  *
 626  * \param p_mediaplayer the media player
 627  * \param p_e an initialized exception pointer
 628  * \return list containing description of available titles
 629  */
 630 VLC_PUBLIC_API libvlc_track_description_t *
 631         libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
 632
 633 /**
 634  * Get the description of available chapters for specific title.
 635  *
 636  * \param p_mediaplayer the media player
 637  * \param i_title selected title
 638  * \param p_e an initialized exception pointer
 639  * \return list containing description of available chapter for title i_title
 640  */
 641 VLC_PUBLIC_API libvlc_track_description_t *
 642         libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
 643
 644 /**
 645  * Get current crop filter geometry.
 646  *
 647  * \param p_mediaplayer the media player
 648  * \param p_e an initialized exception pointer
 649  * \return the crop filter geometry
 650  */
 651 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
 652
 653 /**
 654  * Set new crop filter geometry.
 655  *
 656  * \param p_mediaplayer the media player
 657  * \param psz_geometry new crop filter geometry
 658  * \param p_e an initialized exception pointer
 659  */
 660 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
 661
 662 /**
 663  * Toggle teletext transparent status on video output.
 664  *
 665  * \param p_mediaplayer the media player
 666  * \param p_e an initialized exception pointer
 667  */
 668 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 669
 670 /**
 671  * Get current teletext page requested.
 672  *
 673  * \param p_mediaplayer the media player
 674  * \param p_e an initialized exception pointer
 675  * \return the current teletext page requested.
 676  */
 677 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 678
 679 /**
 680  * Set new teletext page to retrieve.
 681  *
 682  * \param p_mediaplayer the media player
 683  * \param i_page teletex page number requested
 684  * \param p_e an initialized exception pointer
 685  */
 686 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
 687
 688 /**
 689  * Get number of available video tracks.
 690  *
 691  * \param p_mi media player
 692  * \param p_e an initialized exception
 693  * \return the number of available video tracks (int)
 694  */
 695 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
 696
 697 /**
 698  * Get the description of available video tracks.
 699  *
 700  * \param p_mi media player
 701  * \param p_e an initialized exception
 702  * \return list with description of available video tracks
 703  */
 704 VLC_PUBLIC_API libvlc_track_description_t *
 705         libvlc_video_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
 706
 707 /**
 708  * Get current video track.
 709  *
 710  * \param p_mi media player
 711  * \param p_e an initialized exception pointer
 712  * \return the video track (int)
 713  */
 714 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
 715
 716 /**
 717  * Set video track.
 718  *
 719  * \param p_mi media player
 720  * \param i_track the track (int)
 721  * \param p_e an initialized exception pointer
 722  */
 723 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
 724
 725 /**
 726  * Take a snapshot of the current video window.
 727  *
 728  * If i_width AND i_height is 0, original size is used.
 729  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 730  *
 731  * \param p_mi media player instance
 732  * \param psz_filepath the path where to save the screenshot to
 733  * \param i_width the snapshot's width
 734  * \param i_height the snapshot's height
 735  * \param p_e an initialized exception pointer
 736  */
 737 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * );
 738
 739 /**
 740  * Enable or disable deinterlace filter
 741  *
 742  * \param p_mi libvlc media player
 743  * \param b_enable boolean to enable or disable deinterlace filter
 744  * \param psz_mode type of deinterlace filter to use
 745  * \param p_e an initialized exception pointer
 746  */
 747 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
 748                                                   int , const char *,
 749                                                   libvlc_exception_t *);
 750
 751 /**
 752  * Get an option value (option which return an int)
 753  *
 754  * \param p_mi libvlc media player
 755  * \param option marq option to get
 756  * \param p_e an initialized exception pointer
 757  */
 758 VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *,
 759                                                         libvlc_video_marquee_int_option_t,
 760                                                         libvlc_exception_t * );
 761
 762 /**
 763  * Get an option value (option which return a string)
 764  *
 765  * \param p_mi libvlc media player
 766  * \param option marq option to get
 767  * \param p_e an initialized exception pointer
 768  */
 769 VLC_PUBLIC_API char *libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *,
 770                                                              libvlc_video_marquee_string_option_t,
 771                                                              libvlc_exception_t * );
 772
 773 /**
 774  * Enable, disable or set a marq option (only int)
 775  *
 776  * \param p_mi libvlc media player
 777  * \param option marq option to set
 778  * \param i_val marq option value
 779  * \param p_e an initialized exception pointer
 780  */
 781 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *,
 782                                                          libvlc_video_marquee_int_option_t,
 783                                                          int, libvlc_exception_t * );
 784
 785 /**
 786  * Set a marq option (only string)
 787  *
 788  * \param p_mi libvlc media player
 789  * \param option marq option to set
 790  * \param psz_text marq option value
 791  * \param p_e an initialized exception pointer
 792  */
 793 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *,
 794                                                             libvlc_video_marquee_string_option_t,
 795                                                             const char *,
 796                                                             libvlc_exception_t * );
 797
 798 /** @} video */
 799
 800 /** \defgroup libvlc_audio libvlc_audio
 801  * \ingroup libvlc_media_player
 802  * LibVLC Audio handling
 803  * @{
 804  */
 805
 806 /**
 807  * Audio device types
 808  */
 809 typedef enum libvlc_audio_output_device_types_t {
 810     libvlc_AudioOutputDevice_Error  = -1,
 811     libvlc_AudioOutputDevice_Mono   =  1,
 812     libvlc_AudioOutputDevice_Stereo =  2,
 813     libvlc_AudioOutputDevice_2F2R   =  4,
 814     libvlc_AudioOutputDevice_3F2R   =  5,
 815     libvlc_AudioOutputDevice_5_1    =  6,
 816     libvlc_AudioOutputDevice_6_1    =  7,
 817     libvlc_AudioOutputDevice_7_1    =  8,
 818     libvlc_AudioOutputDevice_SPDIF  = 10
 819 } libvlc_audio_output_device_types_t;
 820
 821 /**
 822  * Audio channels
 823  */
 824 typedef enum libvlc_audio_output_channel_t {
 825     libvlc_AudioChannel_Error   = -1,
 826     libvlc_AudioChannel_Stereo  =  1,
 827     libvlc_AudioChannel_RStereo =  2,
 828     libvlc_AudioChannel_Left    =  3,
 829     libvlc_AudioChannel_Right   =  4,
 830     libvlc_AudioChannel_Dolbys  =  5
 831 } libvlc_audio_output_channel_t;
 832
 833
 834 /**
 835  * Get the list of available audio outputs
 836  *
 837  * \param p_instance libvlc instance
 838  * \param p_e an initialized exception pointer
 839  * \return list of available audio outputs, at the end free it with
 840 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t
 841  */
 842 VLC_PUBLIC_API libvlc_audio_output_t *
 843         libvlc_audio_output_list_get( libvlc_instance_t *,
 844                                       libvlc_exception_t * );
 845
 846 /**
 847  * Free the list of available audio outputs
 848  *
 849  * \param p_list list with audio outputs for release
 850  */
 851 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
 852
 853 /**
 854  * Set the audio output.
 855  * Change will be applied after stop and play.
 856  *
 857  * \param p_instance libvlc instance
 858  * \param psz_name name of audio output,
 859  *               use psz_name of \see libvlc_audio_output_t
 860  * \return true if function succeded
 861  */
 862 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
 863                                             const char * );
 864
 865 /**
 866  * Get count of devices for audio output, these devices are hardware oriented
 867  * like analor or digital output of sound card
 868  *
 869  * \param p_instance libvlc instance
 870  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 871  * \return number of devices
 872  */
 873 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
 874                                                      const char * );
 875
 876 /**
 877  * Get long name of device, if not available short name given
 878  *
 879  * \param p_instance libvlc instance
 880  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 881  * \param i_device device index
 882  * \return long name of device
 883  */
 884 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
 885                                                            const char *,
 886                                                            int );
 887
 888 /**
 889  * Get id name of device
 890  *
 891  * \param p_instance libvlc instance
 892  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 893  * \param i_device device index
 894  * \return id name of device, use for setting device, need to be free after use
 895  */
 896 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
 897                                                      const char *,
 898                                                      int );
 899
 900 /**
 901  * Set device for using
 902  *
 903  * \param p_instance libvlc instance
 904  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
 905  * \param psz_device_id device
 906  */
 907 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
 908                                                     const char *,
 909                                                     const char * );
 910
 911 /**
 912  * Get current audio device type. Device type describes something like
 913  * character of output sound - stereo sound, 2.1, 5.1 etc
 914  *
 915  * \param p_instance vlc instance
 916  * \param p_e an initialized exception pointer
 917  * \return the audio devices type \see libvlc_audio_output_device_types_t
 918  */
 919 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
 920         libvlc_instance_t *, libvlc_exception_t * );
 921
 922 /**
 923  * Set current audio device type.
 924  *
 925  * \param p_instance vlc instance
 926  * \param device_type the audio device type,
 927           according to \see libvlc_audio_output_device_types_t
 928  * \param p_e an initialized exception pointer
 929  */
 930 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
 931                                                          int,
 932                                                          libvlc_exception_t * );
 933
 934
 935 /**
 936  * Toggle mute status.
 937  *
 938  * \param p_instance libvlc instance
 939  * \param p_e an initialized exception pointer
 940  */
 941 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 942
 943 /**
 944  * Get current mute status.
 945  *
 946  * \param p_instance libvlc instance
 947  * \param p_e an initialized exception pointer
 948  * \return the mute status (boolean)
 949  */
 950 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 951
 952 /**
 953  * Set mute status.
 954  *
 955  * \param p_instance libvlc instance
 956  * \param status If status is true then mute, otherwise unmute
 957  * \param p_e an initialized exception pointer
 958  */
 959 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
 960
 961 /**
 962  * Get current audio level.
 963  *
 964  * \param p_instance libvlc instance
 965  * \param p_e an initialized exception pointer
 966  * \return the audio level (int)
 967  */
 968 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 969
 970 /**
 971  * Set current audio level.
 972  *
 973  * \param p_instance libvlc instance
 974  * \param i_volume the volume (int)
 975  * \param p_e an initialized exception pointer
 976  */
 977 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
 978
 979 /**
 980  * Get number of available audio tracks.
 981  *
 982  * \param p_mi media player
 983  * \param p_e an initialized exception
 984  * \return the number of available audio tracks (int)
 985  */
 986 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
 987
 988  /**
 989  * Get the description of available audio tracks.
 990  *
 991  * \param p_mi media player
 992  * \param p_e an initialized exception
 993  * \return list with description of available audio tracks
 994  */
 995 VLC_PUBLIC_API libvlc_track_description_t *
 996         libvlc_audio_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
 997
 998 /**
 999  * Get current audio track.
1000  *
1001  * \param p_mi media player
1002  * \param p_e an initialized exception pointer
1003  * \return the audio track (int)
1004  */
1005 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1006
1007 /**
1008  * Set current audio track.
1009  *
1010  * \param p_mi media player
1011  * \param i_track the track (int)
1012  * \param p_e an initialized exception pointer
1013  */
1014 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1015
1016 /**
1017  * Get current audio channel.
1018  *
1019  * \param p_instance vlc instance
1020  * \param p_e an initialized exception pointer
1021  * \return the audio channel \see libvlc_audio_output_channel_t
1022  */
1023 VLC_PUBLIC_API int
1024     libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1025
1026 /**
1027  * Set current audio channel.
1028  *
1029  * \param p_instance vlc instance
1030  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1031  * \param p_e an initialized exception pointer
1032  */
1033 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1034                                               int,
1035                                               libvlc_exception_t * );
1036
1037 /** @} audio */
1038
1039 /** @} media_player */
1040
1041 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */