Libvlc Old

Collaboration diagram for Libvlc Old:

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


Modules

 Variable types (shouldn't be exposed)
 These are the different types a vlc variable can have.

Data Structures

union  vlc_value_t
 VLC value structure (shouldn't be exposed). More...
struct  vlc_list_t
 VLC list structure (shouldn't be exposed). More...

Defines

#define _VLC_COMMON_H   1
#define VLC_SUCCESS   -0
#define VLC_ENOMEM   -1
#define VLC_ETHREAD   -2
#define VLC_ETIMEOUT   -3
#define VLC_ENOMOD   -10
#define VLC_ENOOBJ   -20
#define VLC_EBADOBJ   -21
#define VLC_ENOVAR   -30
#define VLC_EBADVAR   -31
#define VLC_ENOITEM   -40
 Item not found.
#define VLC_EEXIT   -255
#define VLC_EEXITSUCCESS   -999
#define VLC_EGENERIC   -666
#define VLC_PUBLIC_API   extern
#define VLC_DEPRECATED_API   VLC_PUBLIC_API
#define PLAYLIST_INSERT   0x0001
#define PLAYLIST_APPEND   0x0002
#define PLAYLIST_GO   0x0004
#define PLAYLIST_PREPARSE   0x0008
#define PLAYLIST_SPREPARSE   0x0010
#define PLAYLIST_NO_REBUILD   0x0020
#define PLAYLIST_END   -666
#define VLC_SUCCESS   -0
#define VLC_ENOMEM   -1
#define VLC_ETHREAD   -2
#define VLC_ETIMEOUT   -3
#define VLC_ENOMOD   -10
#define VLC_ENOOBJ   -20
#define VLC_EBADOBJ   -21
#define VLC_ENOVAR   -30
#define VLC_EBADVAR   -31
#define VLC_ENOITEM   -40
 Item not found.
#define VLC_EEXIT   -255
#define VLC_EEXITSUCCESS   -999
#define VLC_EGENERIC   -666

Typedefs

typedef vlc_list_t vlc_list_t
typedef vlc_object_t vlc_object_t
typedef signed long long vlc_int64_t

Functions

VLC_DEPRECATED_API char const * VLC_Version (void)
 Retrieve libvlc version.
VLC_DEPRECATED_API char const * VLC_CompileBy (void)
 Retrieve the username of the libvlc builder.
VLC_DEPRECATED_API char const * VLC_CompileHost (void)
 Retrieve the host of the libvlc builder.
VLC_DEPRECATED_API char const * VLC_CompileDomain (void)
 Retrieve the domain name of the host of the libvlc builder.
VLC_DEPRECATED_API char const * VLC_Compiler (void)
 Retrieve libvlc compiler version.
VLC_DEPRECATED_API char const * VLC_Changeset (void)
 Retrieve libvlc changeset.
VLC_DEPRECATED_API int VLC_VariableSet (int, char const *, vlc_value_t)
 Set a VLC variable.
VLC_DEPRECATED_API int VLC_VariableGet (int, char const *, vlc_value_t *)
 Get a VLC variable.
VLC_DEPRECATED_API int VLC_VariableType (int, char const *, int *)
 Get a VLC variable type.
VLC_DEPRECATED_API int VLC_AddTarget (int, char const *, const char **, int, int, int)
 Add a target to the current playlist.
VLC_DEPRECATED_API int VLC_Play (int)
 Start the playlist and play the currently selected playlist item.
VLC_DEPRECATED_API int VLC_Pause (int)
 Pause the currently playing item.
VLC_DEPRECATED_API int VLC_Stop (int)
 Stop the playlist.
VLC_DEPRECATED_API bool VLC_IsPlaying (int)
 Tell if VLC is playing.
VLC_DEPRECATED_API float VLC_PositionGet (int)
 Get the current position in a input.
VLC_DEPRECATED_API float VLC_PositionSet (int, float)
 Set the current position in a input.
VLC_DEPRECATED_API int VLC_TimeGet (int)
 Get the current position in a input.
VLC_DEPRECATED_API int VLC_TimeSet (int, int, bool)
 Seek to a position in the current input.
VLC_DEPRECATED_API int VLC_LengthGet (int)
 Get the total length of a input.
VLC_DEPRECATED_API float VLC_SpeedFaster (int)
 Play the input faster than realtime.
VLC_DEPRECATED_API float VLC_SpeedSlower (int)
 Play the input slower than realtime.
VLC_DEPRECATED_API int VLC_PlaylistIndex (int)
 Return the current playlist item.
VLC_DEPRECATED_API int VLC_PlaylistNumberOfItems (int)
 Total amount of items in the playlist.
VLC_DEPRECATED_API int VLC_PlaylistNext (int)
 Next playlist item.
VLC_DEPRECATED_API int VLC_PlaylistPrev (int)
 Previous playlist item.
VLC_DEPRECATED_API int VLC_PlaylistClear (int)
 Clear the contents of the playlist.
VLC_DEPRECATED_API int VLC_VolumeSet (int, int)
 Change the volume.
VLC_DEPRECATED_API int VLC_VolumeGet (int)
 Get the current volume.
VLC_DEPRECATED_API int VLC_VolumeMute (int)
 Mute/Unmute the volume.
VLC_DEPRECATED_API int VLC_FullScreen (int)
 Toggle Fullscreen mode.

Variables

bool vlc_value_t::b_bool
float vlc_value_t::f_float
char * vlc_value_t::psz_string
void * vlc_value_t::p_address
vlc_object_t * vlc_value_t::p_object
vlc_list_t * vlc_value_t::p_list
vlc_int64_t vlc_value_t::i_time
int   vlc_value_t::i_object_id
struct {
   char *   psz_name
   int   vlc_value_t::i_object_id
} vlc_value_t::var
struct {
   char   a
   char   b
   char   c
   char   d
   char   e
   char   f
   char   g
   char   h
} vlc_value_t::padding
vlc_value_t * vlc_list_t::p_values
int * vlc_list_t::pi_types

Detailed Description

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

This is the legacy API. Please consider using the new libvlc API

Define Documentation

#define _VLC_COMMON_H   1

#define PLAYLIST_APPEND   0x0002

#define PLAYLIST_END   -666

#define PLAYLIST_GO   0x0004

#define PLAYLIST_INSERT   0x0001

#define PLAYLIST_NO_REBUILD   0x0020

#define PLAYLIST_PREPARSE   0x0008

#define PLAYLIST_SPREPARSE   0x0010

#define VLC_DEPRECATED_API   VLC_PUBLIC_API

#define VLC_EBADOBJ   -21

#define VLC_EBADOBJ   -21

#define VLC_EBADVAR   -31

#define VLC_EBADVAR   -31

#define VLC_EEXIT   -255

#define VLC_EEXIT   -255

#define VLC_EEXITSUCCESS   -999

#define VLC_EEXITSUCCESS   -999

#define VLC_EGENERIC   -666

#define VLC_EGENERIC   -666

#define VLC_ENOITEM   -40

Item not found.

#define VLC_ENOITEM   -40

Item not found.

#define VLC_ENOMEM   -1

#define VLC_ENOMEM   -1

#define VLC_ENOMOD   -10

#define VLC_ENOMOD   -10

#define VLC_ENOOBJ   -20

#define VLC_ENOOBJ   -20

#define VLC_ENOVAR   -30

#define VLC_ENOVAR   -30

#define VLC_ETHREAD   -2

#define VLC_ETHREAD   -2

#define VLC_ETIMEOUT   -3

#define VLC_ETIMEOUT   -3

#define VLC_PUBLIC_API   extern

#define VLC_SUCCESS   -0

#define VLC_SUCCESS   -0

Typedef Documentation

typedef signed long long vlc_int64_t

typedef struct vlc_list_t vlc_list_t

typedef struct vlc_object_t vlc_object_t

Function Documentation

VLC_DEPRECATED_API 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:
the item id on success and -1 on error

VLC_DEPRECATED_API char const* VLC_Changeset ( void   ) 

Retrieve libvlc changeset.

Returns:
a string containing the libvlc subversion changeset

VLC_DEPRECATED_API char const* VLC_CompileBy ( void   ) 

Retrieve the username of the libvlc builder.

Returns:
a string containing the username of the libvlc builder

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API char const* VLC_CompileHost ( void   ) 

Retrieve the host of the libvlc builder.

Returns:
a string containing the host of the libvlc builder

VLC_DEPRECATED_API char const* VLC_Compiler ( void   ) 

Retrieve libvlc compiler version.

Returns:
a string containing the libvlc compiler version

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API bool VLC_IsPlaying ( int   ) 

Tell if VLC is playing.

If an item is currently playing, it returns true, else false

Parameters:
i_object a vlc object id
Returns:
true or false

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API int VLC_PlaylistNext ( int  i_object  ) 

Next playlist item.

Parameters:
i_object a vlc object id
Returns:
VLC_SUCCESS on success

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API int VLC_PlaylistPrev ( int  i_object  ) 

Previous playlist item.

Parameters:
i_object a vlc object id
Returns:
VLC_SUCCESS on success

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API int VLC_TimeSet ( int  i_object,
int  i_seconds,
bool  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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API 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

VLC_DEPRECATED_API char const* VLC_Version ( void   ) 

Retrieve libvlc version.

Returns:
a string containing the libvlc version

VLC_DEPRECATED_API 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 %)

VLC_DEPRECATED_API int VLC_VolumeMute ( int  i_object  ) 

Mute/Unmute the volume.

Parameters:
i_object a vlc object id
Returns:
VLC_SUCCESS on success

VLC_DEPRECATED_API 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 %)

Variable Documentation

char { ... } ::a [inherited]

char { ... } ::b [inherited]

bool vlc_value_t::b_bool [inherited]

char { ... } ::c [inherited]

char { ... } ::d [inherited]

char { ... } ::e [inherited]

char { ... } ::f [inherited]

float vlc_value_t::f_float [inherited]

char { ... } ::g [inherited]

char { ... } ::h [inherited]

int { ... } ::i_object_id [inherited]

int vlc_value_t::i_object_id [inherited]

vlc_int64_t vlc_value_t::i_time [inherited]

void* vlc_value_t::p_address [inherited]

vlc_list_t* vlc_value_t::p_list [inherited]

vlc_object_t* vlc_value_t::p_object [inherited]

vlc_value_t* vlc_list_t::p_values [inherited]

struct { ... } vlc_value_t::padding [inherited]

int* vlc_list_t::pi_types [inherited]

char* { ... } ::psz_name [inherited]

char* vlc_value_t::psz_string [inherited]

struct { ... } vlc_value_t::var [inherited]

Generated on Sat May 31 08:20:54 2008 for VLC by  doxygen 1.5.1