Libvlc

Modules
	Variable types
Classes
union	vlc_value_t
struct	vlc_list_t
Functions
char const *	VLC_Version (void)
char const *	VLC_CompileTime (void)
char const *	VLC_CompileBy (void)
char const *	VLC_CompileHost (void)
char const *	VLC_CompileDomain (void)
char const *	VLC_Compiler (void)
char const *	VLC_Changeset (void)
char const *	VLC_Error (int i_err)
int	VLC_Create (void)
int	VLC_Init (int, int, char *[])
int	VLC_AddIntf (int, char const *, vlc_bool_t, vlc_bool_t)
int	VLC_Die (int)
int	VLC_CleanUp (int)
int	VLC_Destroy (int)
int	VLC_VariableSet (int, char const *, vlc_value_t)
int	VLC_VariableGet (int, char const *, vlc_value_t *)
int	VLC_VariableType (int, char const *, int *)
int	VLC_AddTarget (int, char const *, const char **, int, int, int)
int	VLC_Play (int)
int	VLC_Pause (int)
int	VLC_Stop (int)
vlc_bool_t	VLC_IsPlaying (int)
float	VLC_PositionGet (int)
float	VLC_PositionSet (int, float)
int	VLC_TimeGet (int)
int	VLC_TimeSet (int, int, vlc_bool_t)
int	VLC_LengthGet (int)
float	VLC_SpeedFaster (int)
float	VLC_SpeedSlower (int)
int	VLC_PlaylistIndex (int)
int	VLC_PlaylistNumberOfItems (int)
int	VLC_PlaylistNext (int)
int	VLC_PlaylistPrev (int)
int	VLC_PlaylistClear (int)
int	VLC_VolumeSet (int, int)
int	VLC_VolumeGet (int)
int	VLC_VolumeMute (int)
int	VLC_FullScreen (int)

---

Detailed Description

This is libvlc, the base library of the VLC program.

---

Function Documentation

int VLC_AddIntf (  int  , char const *  , vlc_bool_t  , vlc_bool_t  )

Add an interface This function opens an interface plugin and runs it. If b_block is set to 0, VLC_AddIntf will return immediately and let the interface run in a separate thread. If b_block is set to 1, VLC_AddIntf will continue until user requests to quit. Parameters: i_object  a vlc object id psz_module  a vlc module name of an interface b_block  make this interface blocking b_play  start playing when the interface is done loading Returns: VLC_SUCCESS on success Definition at line 815 of file libvlc.c. References intf_Destroy(), intf_RunThread(), and VLC_Play(). Referenced by VLC_Init().

int VLC_AddTarget (  int  , char const *  , const char **  , int  , int  , int  )

Add a target to the current playlist This funtion will add a target to the current playlist. If a playlist does not exist, it will be created. Parameters: i_object  a vlc object id psz_target  the URI of the target to play ppsz_options  an array of strings with input options (ie. :input-repeat) i_options  the amount of options in the ppsz_options array i_mode  the insert mode to insert the target into the playlist (PLAYLIST_* defines) i_pos  the position at which to add the new target (PLAYLIST_END for end) Returns: VLC_SUCCESS on success Definition at line 1183 of file libvlc.c. Referenced by VLC_Init().

char const* VLC_Changeset (  void   )

Retrieve libvlc changeset Returns: a string containing the libvlc subversion changeset Definition at line 157 of file libvlc.c.

int VLC_CleanUp (  int   )

Clean up all the intf, playlist, vout and aout This function requests all intf, playlist, vout and aout objects to finish and CleanUp. Only a blank VLC object should remain after this. Note: This function was previously called VLC_Stop Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 891 of file libvlc.c. References intf_Destroy(), intf_StopThread(), and playlist_Destroy().

char const* VLC_CompileBy (  void   )

Retrieve the username of the libvlc builder Returns: a string containing the username of the libvlc builder

char const* VLC_CompileDomain (  void   )

Retrieve the domain name of the host of the libvlc builder Returns: a string containing the domain name of the host of the libvlc builder

char const* VLC_CompileHost (  void   )

Retrieve the host of the libvlc builder Returns: a string containing the host of the libvlc builder

char const* VLC_Compiler (  void   )

Retrieve libvlc compiler version Returns: a string containing the libvlc compiler version

char const* VLC_CompileTime (  void   )

Retrieve libvlc compile time Returns: a string containing the libvlc compile time

int VLC_Create (  void   )

Initialize libvlc This function allocates a vlc_t structure and returns a negative value in case of failure. Also, the thread system is initialized Returns: vlc object id or an error code Definition at line 178 of file libvlc.c. References vlc_value_t::p_address, var_Create, var_Destroy, and var_Get.

int VLC_Destroy (  int   )

Destroy all threads and the VLC object This function requests the running threads to finish, waits for their termination, and destroys their structure. Then it will de-init all VLC object initializations. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 974 of file libvlc.c.

int VLC_Die (  int   )

Ask vlc to die This function sets p_vlc->b_die to VLC_TRUE, but does not do any other task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 873 of file libvlc.c.

char const* VLC_Error (  int  i_err  )

Return an error string Parameters: i_err  an error code Returns: an error string Definition at line 167 of file libvlc.c.

int VLC_FullScreen (  int   )

Toggle Fullscreen mode Switch between normal and fullscreen video Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1871 of file libvlc.c. References vout_thread_t::i_changes, and VOUT_FULLSCREEN_CHANGE.

int VLC_Init (  int  , int  , char *  [] )

Initialize a vlc_t structure This function initializes a previously allocated vlc_t structure: CPU detection gettext initialization message queue, module bank and playlist initialization configuration and commandline parsing Parameters: i_object  a vlc object id i_argc  the number of arguments ppsz_argv  an array of arguments Returns: VLC_SUCCESS on success Definition at line 270 of file libvlc.c. References vlc_value_t::i_int, vlc_value_t::psz_string, var_AddCallback, var_Change, var_Create, var_Get, var_Set, VLC_AddIntf(), VLC_AddTarget(), and VLC_VAR_DOINHERIT.

vlc_bool_t VLC_IsPlaying (  int   )

Tell if VLC is playing If an item is currently playing, it returns VLC_TRUE, else VLC_FALSE Parameters: i_object  a vlc object id Returns: VLC_TRUE or VLC_FALSE Definition at line 1312 of file libvlc.c. References vlc_value_t::i_int, playlist_t::p_input, and var_Get.

int VLC_LengthGet (  int  i_object  )

Get the total length of a input Return the total length in seconds from the current input. Note: For some inputs, this will be unknown. Parameters: i_object  a vlc object id Returns: the length in seconds Definition at line 1521 of file libvlc.c. References vlc_value_t::i_time, and var_Get.

int VLC_Pause (  int   )

Pause the currently playing item. Resume it if already paused If an item is currently playing then pause it. If the item is already paused, then resume playback. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1253 of file libvlc.c.

int VLC_Play (  int   )

Start the playlist and play the currently selected playlist item If there is something in the playlist, and the playlist is not running, then start the playlist and play the currently selected playlist item. If an item is currently paused, then resume it. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1224 of file libvlc.c. Referenced by VLC_AddIntf().

int VLC_PlaylistClear (  int   )

Clear the contents of the playlist Completly empty the entire playlist. Note: Was previously called VLC_ClearPlaylist Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1765 of file libvlc.c.

int VLC_PlaylistIndex (  int  i_object  )

Return the current playlist item Returns the index of the playlistitem that is currently selected for play. This is valid even if nothing is currently playing. Parameters: i_object  a vlc object id Returns: the current index Definition at line 1633 of file libvlc.c. References playlist_t::i_index.

int VLC_PlaylistNext (  int  i_object  )

Next playlist item Skip to the next playlistitem and play it. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1701 of file libvlc.c.

int VLC_PlaylistNumberOfItems (  int  i_object  )

Total amount of items in the playlist Parameters: i_object  a vlc object id Returns: amount of playlist items Definition at line 1666 of file libvlc.c. References playlist_t::i_size.

int VLC_PlaylistPrev (  int  i_object  )

Previous playlist item Skip to the previous playlistitem and play it. Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1735 of file libvlc.c.

float VLC_PositionGet (  int  i_object  )

Get the current position in a input Return the current position as a float Note: For some inputs, this will be unknown. Parameters: i_object  a vlc object id Returns: a float in the range of 0.0 - 1.0 Definition at line 1358 of file libvlc.c. References vlc_value_t::f_float, and var_Get.

float VLC_PositionSet (  int  i_object, float  i_position )

Set the current position in a input Set the current position in a input and then return the current position as a float. Note: For some inputs, this will be unknown. Parameters: i_object  a vlc object id i_position  a float in the range of 0.0 - 1.0 Returns: a float in the range of 0.0 - 1.0 Definition at line 1396 of file libvlc.c. References vlc_value_t::f_float, var_Get, and var_Set.

float VLC_SpeedFaster (  int  i_object  )

Play the input faster than realtime 2x, 4x, 8x faster than realtime Note: For some inputs, this will be impossible. Parameters: i_object  a vlc object id Returns: the current speedrate Definition at line 1557 of file libvlc.c. References vlc_value_t::b_bool, vlc_value_t::f_float, var_Get, and var_Set.

float VLC_SpeedSlower (  int  i_object  )

Play the input slower than realtime 1/2x, 1/4x, 1/8x slower than realtime Note: For some inputs, this will be impossible. Parameters: i_object  a vlc object id Returns: the current speedrate Definition at line 1595 of file libvlc.c. References vlc_value_t::b_bool, vlc_value_t::f_float, var_Get, and var_Set.

int VLC_Stop (  int   )

Stop the playlist If an item is currently playing then stop it. Set the playlist to a stopped state. Note: This function is new. The old VLC_Stop is now called VLC_CleanUp Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1282 of file libvlc.c.

int VLC_TimeGet (  int  i_object  )

Get the current position in a input Return the current position in seconds from the start. Note: For some inputs, this will be unknown. Parameters: i_object  a vlc object id Returns: the offset from 0:00 in seconds Definition at line 1434 of file libvlc.c. References vlc_value_t::i_time, and var_Get.

int VLC_TimeSet (  int  i_object, int  i_seconds, vlc_bool_t  b_relative )

Seek to a position in the current input Seek i_seconds in the current input. If b_relative is set, then the seek will be relative to the current position, otherwise it will seek to i_seconds from the beginning of the input. Note: For some inputs, this will be unknown. Parameters: i_object  a vlc object id i_seconds  seconds from current position or from beginning of input b_relative  seek relative from current position Returns: VLC_SUCCESS on success Definition at line 1474 of file libvlc.c. References vlc_value_t::i_time, and var_Set.

int VLC_VariableGet (  int  , char const *  , vlc_value_t *  )

Get a VLC variable This function gets the value of a variable of VLC It stores it in the p_value argument Note: Was previously called VLC_Get Parameters: i_object  a vlc object id psz_var  a vlc variable name p_value  a pointer to a vlc_value_t structure Returns: VLC_SUCCESS on success Definition at line 1105 of file libvlc.c. References var_Get.

int VLC_VariableSet (  int  , char const *  , vlc_value_t  )

Set a VLC variable This function sets a variable of VLC Note: Was previously called VLC_Set Parameters: i_object  a vlc object id psz_var  a vlc variable name value  a vlc_value_t structure Returns: VLC_SUCCESS on success Definition at line 1055 of file libvlc.c. References vlc_value_t::b_bool, vlc_value_t::f_float, vlc_value_t::i_int, vlc_value_t::psz_string, and var_Set.

int VLC_VariableType (  int  , char const *  , int *  )

Get a VLC variable type This function gets the type of a variable of VLC It stores it in the p_type argument Parameters: i_object  a vlc object id psz_var  a vlc variable name pi_type  a pointer to an integer Returns: VLC_SUCCESS on success Definition at line 1124 of file libvlc.c. References var_Type.

char const* VLC_Version (  void   )

Retrieve libvlc version Returns: a string containing the libvlc version Definition at line 136 of file libvlc.c.

int VLC_VolumeGet (  int  i_object  )

Get the current volume Retrieve the current volume. Parameters: i_object  a vlc object id Returns: the current volume (range 0-200 %) Definition at line 1829 of file libvlc.c.

int VLC_VolumeMute (  int  i_object  )

Mute/Unmute the volume Parameters: i_object  a vlc object id Returns: VLC_SUCCESS on success Definition at line 1852 of file libvlc.c.

int VLC_VolumeSet (  int  i_object, int  i_volume )

Change the volume Parameters: i_object  a vlc object id i_volume  something in a range from 0-200 Returns: the new volume (range 0-200 %) Definition at line 1800 of file libvlc.c.

---