uk.co.caprica.vlcj.binding
Interface LibVlc

All Superinterfaces:
com.sun.jna.Library

public interface LibVlc
extends com.sun.jna.Library

JNA interface to the libvlc native library.

This is not a complete interface to libvlc.

This interface specifies the exposed methods only, the types and structures are all factored out separately in the "internal" sub-package.

This code and that in the internal sub-package is structured out of necessity to interoperate with the libvlc native library. This code was derived from the original JVLC source code, the copyright of which belongs to the VideoLAN team, which was distributed under GPL version 2 or later.

This binding is for version 1.1 of vlc. Earlier versions of vlc are radically different and will not work with these bindings.

Some functions are only available after version 1.1.0 of libvlc.

This flag may be useful:

 -Djna.dump_memory=true
 


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.sun.jna.Library
com.sun.jna.Library.Handler
 
Field Summary
static uk.co.caprica.vlcj.binding.Info info
          Application information.
static LibVlc INSTANCE
          Native library instance.
static LibVlc SYNC_INSTANCE
          Synchronised native library instance.
 
Fields inherited from interface com.sun.jna.Library
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER
 
Method Summary
 int libvlc_add_intf(libvlc_instance_t p_instance, java.lang.String name)
          Try to start a user interface for the libvlc instance.
 libvlc_module_description_t libvlc_audio_filter_list_get(libvlc_instance_t p_instance)
          Returns a list of audio filters that are available.
 int libvlc_audio_get_channel(libvlc_media_player_t p_mi)
          Get current audio channel.
 long libvlc_audio_get_delay(libvlc_media_player_t p_mi)
          Get current audio delay.
 int libvlc_audio_get_mute(libvlc_media_player_t p_mi)
          Get current mute status.
 int libvlc_audio_get_track_count(libvlc_media_player_t p_mi)
          Get number of available audio tracks.
 libvlc_track_description_t libvlc_audio_get_track_description(libvlc_media_player_t p_mi)
          Get the description of available audio tracks.
 int libvlc_audio_get_track(libvlc_media_player_t p_mi)
          Get current audio track.
 int libvlc_audio_get_volume(libvlc_media_player_t p_mi)
          Get current audio level.
 int libvlc_audio_output_device_count(libvlc_instance_t p_instance, java.lang.String psz_audio_output)
          Get count of devices for audio output, these devices are hardware oriented like analor or digital output of sound card
 java.lang.String libvlc_audio_output_device_id(libvlc_instance_t p_instance, java.lang.String psz_audio_output, int i_device)
          Get id name of device
 java.lang.String libvlc_audio_output_device_longname(libvlc_instance_t p_instance, java.lang.String psz_audio_output, int i_device)
          Get long name of device, if not available short name given
 void libvlc_audio_output_device_set(libvlc_media_player_t p_mi, java.lang.String psz_audio_output, java.lang.String psz_device_id)
          Set audio output device.
 int libvlc_audio_output_get_device_type(libvlc_media_player_t p_mi)
          Get current audio device type.
 libvlc_audio_output_t libvlc_audio_output_list_get(libvlc_instance_t p_instance)
          Get the list of available audio outputs
 void libvlc_audio_output_list_release(libvlc_audio_output_t p_list)
          Free the list of available audio outputs
 void libvlc_audio_output_set_device_type(libvlc_media_player_t p_mi, int device_type)
          Set current audio device type.
 int libvlc_audio_output_set(libvlc_media_player_t p_mi, java.lang.String psz_name)
          Set the audio output.
 int libvlc_audio_set_channel(libvlc_media_player_t p_mi, int channel)
          Set current audio channel.
 int libvlc_audio_set_delay(libvlc_media_player_t p_mi, long i_delay)
          Set current audio delay.
 void libvlc_audio_set_mute(libvlc_media_player_t p_mi, int status)
          Set mute status.
 int libvlc_audio_set_track(libvlc_media_player_t p_mi, int i_track)
          Set current audio track.
 int libvlc_audio_set_volume(libvlc_media_player_t p_mi, int i_volume)
          Set current audio level.
 void libvlc_audio_toggle_mute(libvlc_media_player_t p_mi)
          Toggle mute status.
 void libvlc_clearerr()
          Clears the LibVLC error status for the current thread.
 java.lang.String libvlc_errmsg()
          A human-readable error message for the last LibVLC error in the calling thread.
 int libvlc_event_attach(libvlc_event_manager_t p_event_manager, int i_event_type, libvlc_callback_t f_callback, com.sun.jna.Pointer user_data)
          Register for an event notification.
 void libvlc_event_detach(libvlc_event_manager_t p_event_manager, int i_event_type, libvlc_callback_t f_callback, com.sun.jna.Pointer p_user_data)
          Unregister an event notification.
 java.lang.String libvlc_event_type_name(int event_type)
          Get an event's type name.
 void libvlc_free(com.sun.jna.Pointer ptr)
          Frees an heap allocation returned by a LibVLC function.
 java.lang.String libvlc_get_changeset()
          Retrieve libvlc changeset.
 java.lang.String libvlc_get_compiler()
          Retrieve libvlc compiler version.
 int libvlc_get_fullscreen(libvlc_media_player_t p_mi)
          Get current fullscreen status.
 int libvlc_get_log_verbosity(libvlc_instance_t p_instance)
          Return the VLC messaging verbosity level.
 java.lang.String libvlc_get_version()
          Retrieve libvlc version.
 void libvlc_log_clear(libvlc_log_t p_log)
          Clear a log instance.
 void libvlc_log_close(libvlc_log_t p_log)
          Close a VLC message log instance.
 int libvlc_log_count(libvlc_log_t p_log)
          Returns the number of messages in a log instance.
 libvlc_log_iterator_t libvlc_log_get_iterator(libvlc_log_t p_log)
          Allocate and returns a new iterator to messages in log.
 void libvlc_log_iterator_free(libvlc_log_iterator_t p_iter)
          Release a previoulsy allocated iterator.
 int libvlc_log_iterator_has_next(libvlc_log_iterator_t p_iter)
          Return whether log iterator has more messages.
 libvlc_log_message_t libvlc_log_iterator_next(libvlc_log_iterator_t p_iter, libvlc_log_message_t p_buffer)
          Return the next log message.
 libvlc_log_t libvlc_log_open(libvlc_instance_t p_instance)
          Open a VLC message log instance.
 void libvlc_media_add_option_flag(libvlc_media_t p_md, java.lang.String ppsz_options, int i_flags)
          Add an option to the media with configurable flags.
 void libvlc_media_add_option(libvlc_media_t p_md, java.lang.String ppsz_options)
          Add an option to the media.
 libvlc_media_t libvlc_media_duplicate(libvlc_media_t p_md)
          Duplicate a media descriptor object.
 libvlc_event_manager_t libvlc_media_event_manager(libvlc_media_t p_md)
          Get event manager from media descriptor object.
 long libvlc_media_get_duration(libvlc_media_t p_md)
          Get duration (in ms) of media descriptor object item.
 java.lang.String libvlc_media_get_meta(libvlc_media_t p_md, int e_meta)
          Read the meta of the media.
 java.lang.String libvlc_media_get_mrl(libvlc_media_t p_md)
          Get the media resource locator (mrl) from a media descriptor object
 int libvlc_media_get_state(libvlc_media_t p_meta_desc)
          Get current state of media descriptor object.
 int libvlc_media_get_stats(libvlc_media_t p_md, libvlc_media_stats_t p_stats)
          get the current statistics about the media
 int libvlc_media_get_tracks_info(libvlc_media_t media, libvlc_media_track_info_t[] tracks)
          Get media descriptor's elementary streams description Note, you need to play the media _one_ time with --sout="#description" Not doing this will result in an empty array, and doing it more than once will duplicate the entries in the array each time.
 com.sun.jna.Pointer libvlc_media_get_user_data(libvlc_media_t p_md)
          Get media descriptor's user_data.
 int libvlc_media_is_parsed(libvlc_media_t p_md)
          Get Parsed status for media descriptor object.
 int libvlc_media_list_add_media(libvlc_media_list_t p_ml, libvlc_media_t p_md)
          Add media instance to media list The libvlc_media_list_lock should be held upon entering this function.
 int libvlc_media_list_count(libvlc_media_list_t p_ml)
          Get count on media list items The libvlc_media_list_lock should be held upon entering this function.
 libvlc_event_manager_t libvlc_media_list_event_manager(libvlc_media_list_t p_ml)
          Get libvlc_event_manager from this media list instance.
 int libvlc_media_list_index_of_item(libvlc_media_list_t p_ml, libvlc_media_t p_md)
          Find index position of List media instance in media list.
 int libvlc_media_list_insert_media(libvlc_media_list_t p_ml, libvlc_media_t p_md, int i_pos)
          Insert media instance in media list on a position The libvlc_media_list_lock should be held upon entering this function.
 int libvlc_media_list_is_readonly(libvlc_media_list_t p_ml)
          This indicates if this media list is read-only from a user point of view
 libvlc_media_t libvlc_media_list_item_at_index(libvlc_media_list_t p_ml, int i_pos)
          List media instance in media list at a position The libvlc_media_list_lock should be held upon entering this function.
 void libvlc_media_list_lock(libvlc_media_list_t p_ml)
          Get lock on media list items
 libvlc_media_t libvlc_media_list_media(libvlc_media_list_t p_ml)
          Get media instance from this media list instance.
 libvlc_media_list_t libvlc_media_list_new(libvlc_instance_t p_instance)
          Create an empty media list.
 libvlc_event_manager_t libvlc_media_list_player_event_manager(libvlc_media_list_player_t p_mlp)
          Return the event manager of this media_list_player.
 libvlc_state_t libvlc_media_list_player_get_state(libvlc_media_list_player_t p_mlp)
          Get current libvlc_state of media list player
 int libvlc_media_list_player_is_playing(libvlc_media_list_player_t p_mlp)
          Is media list playing?
 libvlc_media_list_player_t libvlc_media_list_player_new(libvlc_instance_t p_instance)
          Create new media_list_player.
 int libvlc_media_list_player_next(libvlc_media_list_player_t p_mlp)
          Play next item from media list
 void libvlc_media_list_player_pause(libvlc_media_list_player_t p_mlp)
          Pause media list
 int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t p_mlp, int i_index)
          Play media list item at position index
 int libvlc_media_list_player_play_item(libvlc_media_list_player_t p_mlp, libvlc_media_t p_md)
          Play the given media item
 void libvlc_media_list_player_play(libvlc_media_list_player_t p_mlp)
          Play media list
 int libvlc_media_list_player_previous(libvlc_media_list_player_t p_mlp)
          Play previous item from media list
 void libvlc_media_list_player_release(libvlc_media_list_player_t p_mlp)
          Release media_list_player.
 void libvlc_media_list_player_set_media_list(libvlc_media_list_player_t p_mlp, libvlc_media_list_t p_mlist)
          Set the media list associated with the player
 void libvlc_media_list_player_set_media_player(libvlc_media_list_player_t p_mlp, libvlc_media_player_t p_mi)
          Replace media player in media_list_player with this instance.
 void libvlc_media_list_player_set_playback_mode(libvlc_media_list_player_t p_mlp, int e_mode)
          Sets the playback mode for the playlist
 void libvlc_media_list_player_stop(libvlc_media_list_player_t p_mlp)
          Stop playing media list
 void libvlc_media_list_release(libvlc_media_list_t p_ml)
          Release media list created with libvlc_media_list_new().
 int libvlc_media_list_remove_index(libvlc_media_list_t p_ml, int i_pos)
          Remove media instance from media list on a position The libvlc_media_list_lock should be held upon entering this function.
 void libvlc_media_list_retain(libvlc_media_list_t p_ml)
          Retain reference to a media list
 void libvlc_media_list_set_media(libvlc_media_list_t p_ml, libvlc_media_t p_md)
          Associate media instance with this media list instance.
 void libvlc_media_list_unlock(libvlc_media_list_t p_ml)
          Release lock on media list items The libvlc_media_list_lock should be held upon entering this function.
 libvlc_media_t libvlc_media_new_as_node(libvlc_instance_t p_instance, java.lang.String psz_name)
          Create a media as an empty node with a given name.
 libvlc_media_t libvlc_media_new_location(libvlc_instance_t p_instance, java.lang.String psz_mrl)
          Create a media with a certain given media resource location.
 libvlc_media_t libvlc_media_new_path(libvlc_instance_t p_instance, java.lang.String path)
          Create a media with a certain file path.
 void libvlc_media_parse_async(libvlc_media_t media)
          Parse a media.
 void libvlc_media_parse(libvlc_media_t media)
          Parse a media.
 int libvlc_media_player_can_pause(libvlc_media_player_t p_mi)
          Can this media player be paused?
 libvlc_event_manager_t libvlc_media_player_event_manager(libvlc_media_player_t p_mi)
          Get the Event Manager from which the media player send event.
 int libvlc_media_player_get_agl(libvlc_media_player_t p_mi)
          Get the agl handler previously set with libvlc_media_player_set_agl().
 int libvlc_media_player_get_chapter_count_for_title(libvlc_media_player_t p_mi, int i_title)
          Get title chapter count
 int libvlc_media_player_get_chapter_count(libvlc_media_player_t p_mi)
          Get movie chapter count
 int libvlc_media_player_get_chapter(libvlc_media_player_t p_mi)
          Get movie chapter.
 float libvlc_media_player_get_fps(libvlc_media_player_t p_mi)
          Get movie fps rate
 com.sun.jna.Pointer libvlc_media_player_get_hwnd(libvlc_media_player_t p_mi)
          Get the Windows API window handle (HWND) previously set with libvlc_media_player_set_hwnd().
 long libvlc_media_player_get_length(libvlc_media_player_t p_mi)
          Get the current movie length (in ms).
 libvlc_media_t libvlc_media_player_get_media(libvlc_media_player_t p_mi)
          Get the media used by the media_player.
 com.sun.jna.Pointer libvlc_media_player_get_nsobject(libvlc_media_player_t p_mi)
          Get the NSView handler previously set with libvlc_media_player_set_nsobject().
 float libvlc_media_player_get_position(libvlc_media_player_t p_mi)
          Get movie position.
 float libvlc_media_player_get_rate(libvlc_media_player_t p_mi)
          Get the requested movie play rate.
 int libvlc_media_player_get_state(libvlc_media_player_t p_mi)
          Get current movie state
 long libvlc_media_player_get_time(libvlc_media_player_t p_mi)
          Get the current movie time (in ms).
 int libvlc_media_player_get_title_count(libvlc_media_player_t p_mi)
          Get movie title count
 int libvlc_media_player_get_title(libvlc_media_player_t p_mi)
          Get movie title
 int libvlc_media_player_get_xwindow(libvlc_media_player_t p_mi)
          Get the X Window System window identifier previously set with libvlc_media_player_set_xwindow().
 int libvlc_media_player_has_vout(libvlc_media_player_t p_mi)
          How many video outputs does this media player have?
 int libvlc_media_player_is_playing(libvlc_media_player_t p_mi)
          is_playing
 int libvlc_media_player_is_seekable(libvlc_media_player_t p_mi)
          Is this media player seekable?
 void libvlc_media_player_navigate(libvlc_media_player_t p_mi, int navigate)
          Navigate through DVD Menu
 libvlc_media_player_t libvlc_media_player_new_from_media(libvlc_media_t p_md)
          Create a Media Player object from a Media
 libvlc_media_player_t libvlc_media_player_new(libvlc_instance_t p_libvlc_instance)
          Create an empty Media Player object
 void libvlc_media_player_next_chapter(libvlc_media_player_t p_mi)
          Set next chapter (if applicable)
 void libvlc_media_player_next_frame(libvlc_media_player_t p_mi)
          Display the next frame (if supported)
 void libvlc_media_player_pause(libvlc_media_player_t p_mi)
          Toggle pause (no effect if there is no media)
 int libvlc_media_player_play(libvlc_media_player_t p_mi)
          Play
 void libvlc_media_player_previous_chapter(libvlc_media_player_t p_mi)
          Set previous chapter (if applicable)
 void libvlc_media_player_release(libvlc_media_player_t p_mi)
          Release a media_player after use Decrement the reference count of a media player object.
 void libvlc_media_player_retain(libvlc_media_player_t p_mi)
          Retain a reference to a media player object.
 void libvlc_media_player_set_agl(libvlc_media_player_t p_mi, int drawable)
          Set the agl handler where the media player should render its video output.
 void libvlc_media_player_set_chapter(libvlc_media_player_t p_mi, int i_chapter)
          Set movie chapter (if applicable).
 void libvlc_media_player_set_hwnd(libvlc_media_player_t p_mi, com.sun.jna.Pointer drawable)
          Set a Win32/Win64 API window handle (HWND) where the media player should render its video output.
 void libvlc_media_player_set_media(libvlc_media_player_t p_mi, libvlc_media_t p_md)
          Set the media that will be used by the media_player.
 void libvlc_media_player_set_nsobject(libvlc_media_player_t p_mi, com.sun.jna.Pointer drawable)
          Set the NSView handler where the media player should render its video output.
 void libvlc_media_player_set_pause(libvlc_media_player_t mp, int do_pause)
          Pause or resume (no effect if there is no media)
 void libvlc_media_player_set_position(libvlc_media_player_t p_mi, float f_pos)
          Set movie position.
 int libvlc_media_player_set_rate(libvlc_media_player_t p_mi, float rate)
          Set movie play rate
 void libvlc_media_player_set_time(libvlc_media_player_t p_mi, long i_time)
          Set the movie time (in ms).
 void libvlc_media_player_set_title(libvlc_media_player_t p_mi, int i_title)
          Set movie title
 void libvlc_media_player_set_xwindow(libvlc_media_player_t p_mi, int drawable)
          Set an X Window System drawable where the media player should render its video output.
 void libvlc_media_player_stop(libvlc_media_player_t p_mi)
          Stop (no effect if there is no media)
 int libvlc_media_player_will_play(libvlc_media_player_t p_mi)
          Is the player able to play
 void libvlc_media_release(libvlc_media_t p_md)
          Decrement the reference count of a media descriptor object.
 void libvlc_media_retain(libvlc_media_t p_md)
          Retain a reference to a media descriptor object (libvlc_media_t).
 int libvlc_media_save_meta(libvlc_media_t p_md)
          Save the meta previously set
 void libvlc_media_set_meta(libvlc_media_t p_md, int e_meta, java.lang.String psz_value)
          Set the meta of the media (this function will not save the meta, call libvlc_media_save_meta in order to save the meta)
 void libvlc_media_set_user_data(libvlc_media_t p_md, com.sun.jna.Pointer p_new_user_data)
          Sets media descriptor's user_data.
 libvlc_media_list_t libvlc_media_subitems(libvlc_media_t p_md)
          Get subitems of media descriptor object.
 void libvlc_module_description_list_release(libvlc_module_description_t p_list)
          Release a list of module descriptions.
 libvlc_instance_t libvlc_new_with_builtins(int argc, java.lang.String[] argv, com.sun.jna.Pointer[] builtins)
          Create and initialize a libvlc instance.
 libvlc_instance_t libvlc_new(int argc, java.lang.String[] argv)
          Create and initialize a libvlc instance.
 void libvlc_release(libvlc_instance_t p_instance)
          Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.
 void libvlc_retain(libvlc_instance_t p_instance)
          Increments the reference count of a libvlc instance.
 void libvlc_set_fullscreen(libvlc_media_player_t p_mi, int b_fullscreen)
          Enable or disable fullscreen.
 void libvlc_set_log_verbosity(libvlc_instance_t p_instance, int level)
          Set the VLC messaging verbosity level.
 void libvlc_set_user_agent(libvlc_instance_t p_instance, java.lang.String name, java.lang.String http)
          Sets the application name.
 void libvlc_toggle_fullscreen(libvlc_media_player_t p_mi)
          Toggle fullscreen status on non-embedded video outputs.
 void libvlc_toggle_teletext(libvlc_media_player_t p_mi)
          Toggle teletext transparent status on video output.
 void libvlc_track_description_release(com.sun.jna.Pointer p_track_description)
          Release (free) libvlc_track_description_t
 libvlc_module_description_t libvlc_video_filter_list_get(libvlc_instance_t p_instance)
          Returns a list of video filters that are available.
 float libvlc_video_get_adjust_float(libvlc_media_player_t p_mi, int option)
          Get float adjust option.
 int libvlc_video_get_adjust_int(libvlc_media_player_t p_mi, int option)
          Get integer adjust option.
 java.lang.String libvlc_video_get_aspect_ratio(libvlc_media_player_t p_mi)
          Get current video aspect ratio.
 libvlc_track_description_t libvlc_video_get_chapter_description(libvlc_media_player_t p_mi, int i_title)
          Get the description of available chapters for specific title.
 java.lang.String libvlc_video_get_crop_geometry(libvlc_media_player_t p_mi)
          Get current crop filter geometry.
 int libvlc_video_get_cursor(libvlc_media_player_t p_mi, int num, com.sun.jna.Pointer px, com.sun.jna.Pointer py)
          Get the mouse pointer coordinates over a video.
 int libvlc_video_get_height(libvlc_media_player_t p_mi)
          Deprecated.  
 int libvlc_video_get_logo_int(libvlc_media_player_t p_mi, int option)
          Get integer logo option.
 int libvlc_video_get_marquee_int(libvlc_media_player_t p_mi, int option)
          Get an integer marquee option value
 java.lang.String libvlc_video_get_marquee_string(libvlc_media_player_t p_mi, int option)
          Get a string marquee option value
 float libvlc_video_get_scale(libvlc_media_player_t p_mi)
          Get the current video scaling factor.
 int libvlc_video_get_size(libvlc_media_player_t p_mi, int num, com.sun.jna.ptr.IntByReference px, com.sun.jna.ptr.IntByReference py)
          Get the pixel dimensions of a video.
 int libvlc_video_get_spu_count(libvlc_media_player_t p_mi)
          Get the number of available video subtitles.
 libvlc_track_description_t libvlc_video_get_spu_description(libvlc_media_player_t p_mi)
          Get the description of available video subtitles.
 int libvlc_video_get_spu(libvlc_media_player_t p_mi)
          Get current video subtitle.
 int libvlc_video_get_teletext(libvlc_media_player_t p_mi)
          Get current teletext page requested.
 libvlc_track_description_t libvlc_video_get_title_description(libvlc_media_player_t p_mi)
          Get the description of available titles.
 int libvlc_video_get_track_count(libvlc_media_player_t p_mi)
          Get number of available video tracks.
 libvlc_track_description_t libvlc_video_get_track_description(libvlc_media_player_t p_mi)
          Get the description of available video tracks.
 int libvlc_video_get_track(libvlc_media_player_t p_mi)
          Get current video track.
 int libvlc_video_get_width(libvlc_media_player_t p_mi)
          Deprecated.  
 void libvlc_video_set_adjust_float(libvlc_media_player_t p_mi, int option, float value)
          Set adjust option as float.
 void libvlc_video_set_adjust_int(libvlc_media_player_t p_mi, int option, int value)
          Set adjust option as integer.
 void libvlc_video_set_aspect_ratio(libvlc_media_player_t p_mi, java.lang.String psz_aspect)
          Set new video aspect ratio.
 void libvlc_video_set_callbacks(libvlc_media_player_t mp, libvlc_lock_callback_t lock, libvlc_unlock_callback_t unlock, libvlc_display_callback_t display, com.sun.jna.Pointer opaque)
          Set callbacks and private data to render decoded video to a custom area in memory.
 void libvlc_video_set_crop_geometry(libvlc_media_player_t p_mi, java.lang.String psz_geometry)
          Set new crop filter geometry.
 void libvlc_video_set_deinterlace(libvlc_media_player_t p_mi, java.lang.String psz_mode)
          Enable or disable deinterlace filter
 void libvlc_video_set_format_callbacks(libvlc_media_player_t mp, libvlc_video_format_cb setup, libvlc_video_cleanup_cb cleanup)
          Set decoded video chroma and dimensions.
 void libvlc_video_set_format(libvlc_media_player_t mp, java.lang.String chroma, int width, int height, int pitch)
          Set decoded video chroma and dimensions.
 void libvlc_video_set_key_input(libvlc_media_player_t p_mi, int on)
          Enable or disable key press events handling, according to the LibVLC hotkeys configuration.
 void libvlc_video_set_logo_int(libvlc_media_player_t p_mi, int option, int value)
          Set logo option as integer.
 void libvlc_video_set_logo_string(libvlc_media_player_t p_mi, int option, java.lang.String psz_value)
          Set logo option as string.
 void libvlc_video_set_marquee_int(libvlc_media_player_t p_mi, int option, int i_val)
          Enable, disable or set an integer marquee option Setting libvlc_marquee_Enable has the side effect of enabling (arg !0) or disabling (arg 0) the marq filter.
 void libvlc_video_set_marquee_string(libvlc_media_player_t p_mi, int option, java.lang.String psz_text)
          Set a marquee string option
 void libvlc_video_set_mouse_input(libvlc_media_player_t p_mi, int on)
          Enable or disable mouse click events handling.
 void libvlc_video_set_scale(libvlc_media_player_t p_mi, float f_factor)
          Set the video scaling factor.
 int libvlc_video_set_spu(libvlc_media_player_t p_mi, int i_spu)
          Set new video subtitle.
 int libvlc_video_set_subtitle_file(libvlc_media_player_t p_mi, java.lang.String psz_subtitle)
          Set new video subtitle file.
 void libvlc_video_set_teletext(libvlc_media_player_t p_mi, int i_page)
          Set new teletext page to retrieve.
 int libvlc_video_set_track(libvlc_media_player_t p_mi, int i_track)
          Set video track.
 int libvlc_video_take_snapshot(libvlc_media_player_t p_mi, int num, java.lang.String psz_filepath, int i_width, int i_height)
          Take a snapshot of the current video window.
 void libvlc_wait(libvlc_instance_t p_instance)
          Waits until an interface causes the instance to exit.
 

Field Detail

info

static final uk.co.caprica.vlcj.binding.Info info
Application information.


INSTANCE

static final LibVlc INSTANCE
Native library instance.


SYNC_INSTANCE

static final LibVlc SYNC_INSTANCE
Synchronised native library instance.

Method Detail

libvlc_errmsg

java.lang.String libvlc_errmsg()
A human-readable error message for the last LibVLC error in the calling thread. The resulting string is valid until another error occurs (at least until the next LibVLC call).


libvlc_clearerr

void libvlc_clearerr()
Clears the LibVLC error status for the current thread. This is optional. By default, the error status is automatically overriden when a new error occurs, and destroyed when the thread exits.


libvlc_new

libvlc_instance_t libvlc_new(int argc,
                             java.lang.String[] argv)
Create and initialize a libvlc instance.

Parameters:
argc - the number of arguments
argv - command-line-type arguments
Returns:
the libvlc instance or NULL in case of error

libvlc_new_with_builtins

libvlc_instance_t libvlc_new_with_builtins(int argc,
                                           java.lang.String[] argv,
                                           com.sun.jna.Pointer[] builtins)
Create and initialize a libvlc instance. \param argc the number of arguments \param argv command-line-type arguments \param builtins a NULL terminated array of \see vlc_plugin. \return the libvlc instance or NULL in case of error


libvlc_release

void libvlc_release(libvlc_instance_t p_instance)
Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.

Parameters:
p_instance - the instance to destroy

libvlc_retain

void libvlc_retain(libvlc_instance_t p_instance)
Increments the reference count of a libvlc instance. The initial reference count is 1 after libvlc_new() returns.

Parameters:
p_instance - the instance to reference

libvlc_add_intf

int libvlc_add_intf(libvlc_instance_t p_instance,
                    java.lang.String name)
Try to start a user interface for the libvlc instance.

Parameters:
p_instance - the instance
name - interface name, or NULL for default
Returns:
0 on success, -1 on error.

libvlc_wait

void libvlc_wait(libvlc_instance_t p_instance)
Waits until an interface causes the instance to exit. You should start at least one interface first, using libvlc_add_intf().

Parameters:
p_instance - the instance

libvlc_set_user_agent

void libvlc_set_user_agent(libvlc_instance_t p_instance,
                           java.lang.String name,
                           java.lang.String http)
Sets the application name. LibVLC passes this as the user agent string when a protocol requires it.

Parameters:
p_instance - LibVLC instance
name - human-readable application name, e.g. "FooBar player 1.2.3"
http - HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"
Since:
LibVLC 1.1.1

libvlc_get_version

java.lang.String libvlc_get_version()
Retrieve libvlc version. Example: "1.1.0-git The Luggage"

Returns:
a string containing the libvlc version

libvlc_get_compiler

java.lang.String libvlc_get_compiler()
Retrieve libvlc compiler version. Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"

Returns:
a string containing the libvlc compiler version

libvlc_get_changeset

java.lang.String libvlc_get_changeset()
Retrieve libvlc changeset. Example: "aa9bce0bc4"

Returns:
a string containing the libvlc changeset

libvlc_free

void libvlc_free(com.sun.jna.Pointer ptr)
Frees an heap allocation returned by a LibVLC function. If you know you're using the same underlying C run-time as the LibVLC implementation, then you can call ANSI C free() directly instead.

Parameters:
ptr - the pointer

libvlc_event_attach

int libvlc_event_attach(libvlc_event_manager_t p_event_manager,
                        int i_event_type,
                        libvlc_callback_t f_callback,
                        com.sun.jna.Pointer user_data)
Register for an event notification.

Parameters:
p_event_manager - the event manager to which you want to attach to. Generally it is obtained by vlc_my_object_event_manager() where my_object is the object you want to listen to.
i_event_type - the desired event to which we want to listen
f_callback - the function to call when i_event_type occurs
user_data - user provided data to carry with the event
Returns:
0 on success, ENOMEM on error

libvlc_event_detach

void libvlc_event_detach(libvlc_event_manager_t p_event_manager,
                         int i_event_type,
                         libvlc_callback_t f_callback,
                         com.sun.jna.Pointer p_user_data)
Unregister an event notification.

Parameters:
p_event_manager - the event manager
i_event_type - the desired event to which we want to unregister
f_callback - the function to call when i_event_type occurs
p_user_data - user provided data to carry with the event

libvlc_event_type_name

java.lang.String libvlc_event_type_name(int event_type)
Get an event's type name.

Parameters:
event_type - the desired event

libvlc_get_log_verbosity

int libvlc_get_log_verbosity(libvlc_instance_t p_instance)
Return the VLC messaging verbosity level.

Parameters:
p_instance - libvlc instance
Returns:
verbosity level for messages

libvlc_set_log_verbosity

void libvlc_set_log_verbosity(libvlc_instance_t p_instance,
                              int level)
Set the VLC messaging verbosity level.

Parameters:
p_instance - libvlc log instance
level - log level

libvlc_log_open

libvlc_log_t libvlc_log_open(libvlc_instance_t p_instance)
Open a VLC message log instance.

Parameters:
p_instance - libvlc instance
Returns:
log message instance or NULL on error

libvlc_log_close

void libvlc_log_close(libvlc_log_t p_log)
Close a VLC message log instance.

Parameters:
p_log - libvlc log instance or NULL

libvlc_log_count

int libvlc_log_count(libvlc_log_t p_log)
Returns the number of messages in a log instance.

Parameters:
p_log - libvlc log instance or NULL
Returns:
number of log messages, 0 if p_log is NULL

libvlc_log_clear

void libvlc_log_clear(libvlc_log_t p_log)
Clear a log instance. All messages in the log are removed. The log should be cleared on a regular basis to avoid clogging.

Parameters:
p_log - libvlc log instance or NULL

libvlc_log_get_iterator

libvlc_log_iterator_t libvlc_log_get_iterator(libvlc_log_t p_log)
Allocate and returns a new iterator to messages in log.

Parameters:
p_log - libvlc log instance
Returns:
log iterator object or NULL on error

libvlc_log_iterator_free

void libvlc_log_iterator_free(libvlc_log_iterator_t p_iter)
Release a previoulsy allocated iterator.

Parameters:
p_iter - libvlc log iterator or NULL

libvlc_log_iterator_has_next

int libvlc_log_iterator_has_next(libvlc_log_iterator_t p_iter)
Return whether log iterator has more messages.

Parameters:
p_iter - libvlc log iterator or NULL
Returns:
true if iterator has more message objects, else false

libvlc_log_iterator_next

libvlc_log_message_t libvlc_log_iterator_next(libvlc_log_iterator_t p_iter,
                                              libvlc_log_message_t p_buffer)
Return the next log message. The message contents must not be freed

Parameters:
p_iter - libvlc log iterator or NULL
p_buffer - log buffer
Returns:
log message object or NULL if none left

libvlc_module_description_list_release

void libvlc_module_description_list_release(libvlc_module_description_t p_list)
Release a list of module descriptions.

Parameters:
p_list - the list to be released

libvlc_audio_filter_list_get

libvlc_module_description_t libvlc_audio_filter_list_get(libvlc_instance_t p_instance)
Returns a list of audio filters that are available.

Parameters:
p_instance - libvlc instance
Returns:
a list of module descriptions. It should be freed with libvlc_module_description_list_release(). In case of an error, NULL is returned.
See Also:
libvlc_module_description_t, libvlc_module_description_list_release

libvlc_video_filter_list_get

libvlc_module_description_t libvlc_video_filter_list_get(libvlc_instance_t p_instance)
Returns a list of video filters that are available.

Parameters:
p_instance - libvlc instance
Returns:
a list of module descriptions. It should be freed with libvlc_module_description_list_release(). In case of an error, NULL is returned.
See Also:
libvlc_module_description_t, libvlc_module_description_list_release

libvlc_media_new_location

libvlc_media_t libvlc_media_new_location(libvlc_instance_t p_instance,
                                         java.lang.String psz_mrl)
Create a media with a certain given media resource location.

Parameters:
p_instance - the instance
psz_mrl - the MRL to read
Returns:
the newly created media or NULL on error
See Also:
libvlc_media_release

libvlc_media_new_path

libvlc_media_t libvlc_media_new_path(libvlc_instance_t p_instance,
                                     java.lang.String path)
Create a media with a certain file path.

Parameters:
p_instance - the instance
path - local filesystem path
Returns:
the newly created media or NULL on error
See Also:
libvlc_media_release

libvlc_media_new_as_node

libvlc_media_t libvlc_media_new_as_node(libvlc_instance_t p_instance,
                                        java.lang.String psz_name)
Create a media as an empty node with a given name.

Parameters:
p_instance - the instance
psz_name - the name of the node
Returns:
the new empty media or NULL on error
See Also:
libvlc_media_release

libvlc_media_add_option

void libvlc_media_add_option(libvlc_media_t p_md,
                             java.lang.String ppsz_options)
Add an option to the media. This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis. The options are detailed in vlc --long-help, for instance "--sout-all"

Parameters:
p_md - the media descriptor
ppsz_options - the options (as a string)

libvlc_media_add_option_flag

void libvlc_media_add_option_flag(libvlc_media_t p_md,
                                  java.lang.String ppsz_options,
                                  int i_flags)
Add an option to the media with configurable flags. This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis. The options are detailed in vlc --long-help, for instance "--sout-all"

Parameters:
p_md - the media descriptor
ppsz_options - the options (as a string)
i_flags - the flags for this option

libvlc_media_retain

void libvlc_media_retain(libvlc_media_t p_md)
Retain a reference to a media descriptor object (libvlc_media_t). Use libvlc_media_release() to decrement the reference count of a media descriptor object.

Parameters:
p_md - the media descriptor

libvlc_media_release

void libvlc_media_release(libvlc_media_t p_md)
Decrement the reference count of a media descriptor object. If the reference count is 0, then libvlc_media_release() will release the media descriptor object. It will send out an libvlc_MediaFreed event to all listeners. If the media descriptor object has been released it should not be used again.

Parameters:
p_md - the media descriptor

libvlc_media_get_mrl

java.lang.String libvlc_media_get_mrl(libvlc_media_t p_md)
Get the media resource locator (mrl) from a media descriptor object

Parameters:
p_md - a media descriptor object
Returns:
string with mrl of media descriptor object

libvlc_media_duplicate

libvlc_media_t libvlc_media_duplicate(libvlc_media_t p_md)
Duplicate a media descriptor object.

Parameters:
p_md - a media descriptor object.

libvlc_media_get_meta

java.lang.String libvlc_media_get_meta(libvlc_media_t p_md,
                                       int e_meta)
Read the meta of the media. If the media has not yet been parsed this will return NULL. This methods automatically calls libvlc_media_parse_async(), so after calling it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous version ensure that you call libvlc_media_parse() before get_meta().

Parameters:
p_md - the media descriptor
e_meta - the meta to read
Returns:
the media's meta
See Also:
libvlc_media_parse, libvlc_media_parse_async, libvlc_MediaMetaChanged

libvlc_media_set_meta

void libvlc_media_set_meta(libvlc_media_t p_md,
                           int e_meta,
                           java.lang.String psz_value)
Set the meta of the media (this function will not save the meta, call libvlc_media_save_meta in order to save the meta)

Parameters:
p_md - the media descriptor
e_meta - the meta to write
psz_value - the media's meta

libvlc_media_save_meta

int libvlc_media_save_meta(libvlc_media_t p_md)
Save the meta previously set

Parameters:
p_md - the media desriptor
Returns:
true if the write operation was successfull

libvlc_media_get_state

int libvlc_media_get_state(libvlc_media_t p_meta_desc)
Get current state of media descriptor object. Possible media states are defined in libvlc_structures.c (libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused, libvlc_Stopped, libvlc_Ended, libvlc_Error).

Parameters:
p_meta_desc - a media descriptor object
Returns:
state of media descriptor object
See Also:
libvlc_state_t

libvlc_media_get_stats

int libvlc_media_get_stats(libvlc_media_t p_md,
                           libvlc_media_stats_t p_stats)
get the current statistics about the media

Parameters:
p_md - media descriptor object
p_stats - structure that contain the statistics about the media (this structure must be allocated by the caller)
Returns:
true if the statistics are available, false otherwise

libvlc_media_subitems

libvlc_media_list_t libvlc_media_subitems(libvlc_media_t p_md)
Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use libvlc_media_list_release() to decrement the reference counting.

Parameters:
p_md - media descriptor object
Returns:
list of media descriptor subitems or NULL This method uses libvlc_media_list_t, however, media_list usage is optional and this is here for convenience

libvlc_media_event_manager

libvlc_event_manager_t libvlc_media_event_manager(libvlc_media_t p_md)
Get event manager from media descriptor object. NOTE: this function doesn't increment reference counting.

Parameters:
p_md - a media descriptor object
Returns:
event manager object

libvlc_media_get_duration

long libvlc_media_get_duration(libvlc_media_t p_md)
Get duration (in ms) of media descriptor object item.

Parameters:
p_md - media descriptor object
Returns:
duration of media item or -1 on error

libvlc_media_parse

void libvlc_media_parse(libvlc_media_t media)
Parse a media. This fetches (local) meta data and tracks information. The method is synchronous.

Parameters:
media - media descriptor object
See Also:
libvlc_media_parse_async, libvlc_media_get_meta, libvlc_media_get_tracks_info

libvlc_media_parse_async

void libvlc_media_parse_async(libvlc_media_t media)
Parse a media. This fetches (local) meta data and tracks information. The method is the asynchronous of libvlc_media_parse(). To track when this is over you can listen to libvlc_MediaParsedChanged event. However if the media was already parsed you will not receive this event.

Parameters:
media - media descriptor object
See Also:
libvlc_media_parse, libvlc_MediaParsedChanged, libvlc_media_get_meta, libvlc_media_get_tracks_info

libvlc_media_is_parsed

int libvlc_media_is_parsed(libvlc_media_t p_md)
Get Parsed status for media descriptor object.

Parameters:
p_md - media descriptor object
Returns:
true if media object has been parsed otherwise it returns false
See Also:
libvlc_MediaParsedChanged

libvlc_media_set_user_data

void libvlc_media_set_user_data(libvlc_media_t p_md,
                                com.sun.jna.Pointer p_new_user_data)
Sets media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a libvlc_media_t pointer

Parameters:
p_md - media descriptor object
p_new_user_data - pointer to user data

libvlc_media_get_user_data

com.sun.jna.Pointer libvlc_media_get_user_data(libvlc_media_t p_md)
Get media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a libvlc_media_t pointer

Parameters:
p_md - media descriptor object

libvlc_media_get_tracks_info

int libvlc_media_get_tracks_info(libvlc_media_t media,
                                 libvlc_media_track_info_t[] tracks)
Get media descriptor's elementary streams description Note, you need to play the media _one_ time with --sout="#description" Not doing this will result in an empty array, and doing it more than once will duplicate the entries in the array each time. Something like this:

Parameters:
media - media descriptor object
tracks - address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) return the number of Elementary Streams

libvlc_media_player_new

libvlc_media_player_t libvlc_media_player_new(libvlc_instance_t p_libvlc_instance)
Create an empty Media Player object

Parameters:
p_libvlc_instance - the libvlc instance in which the Media Player should be created.
Returns:
a new media player object, or NULL on error.

libvlc_media_player_new_from_media

libvlc_media_player_t libvlc_media_player_new_from_media(libvlc_media_t p_md)
Create a Media Player object from a Media

Parameters:
p_md - the media. Afterwards the p_md can be safely destroyed.
Returns:
a new media player object, or NULL on error.

libvlc_media_player_release

void libvlc_media_player_release(libvlc_media_player_t p_mi)
Release a media_player after use Decrement the reference count of a media player object. If the reference count is 0, then libvlc_media_player_release() will release the media player object. If the media player object has been released, then it should not be used again.

Parameters:
p_mi - the Media Player to free

libvlc_media_player_retain

void libvlc_media_player_retain(libvlc_media_player_t p_mi)
Retain a reference to a media player object. Use libvlc_media_player_release() to decrement reference count.

Parameters:
p_mi - media player object

libvlc_media_player_set_media

void libvlc_media_player_set_media(libvlc_media_player_t p_mi,
                                   libvlc_media_t p_md)
Set the media that will be used by the media_player. If any, previous md will be released.

Parameters:
p_mi - the Media Player
p_md - the Media. Afterwards the p_md can be safely destroyed.

libvlc_media_player_get_media

libvlc_media_t libvlc_media_player_get_media(libvlc_media_player_t p_mi)
Get the media used by the media_player.

Parameters:
p_mi - the Media Player
Returns:
the media associated with p_mi, or NULL if no media is associated

libvlc_media_player_event_manager

libvlc_event_manager_t libvlc_media_player_event_manager(libvlc_media_player_t p_mi)
Get the Event Manager from which the media player send event.

Parameters:
p_mi - the Media Player
Returns:
the event manager associated with p_mi

libvlc_media_player_is_playing

int libvlc_media_player_is_playing(libvlc_media_player_t p_mi)
is_playing

Parameters:
p_mi - the Media Player
Returns:
1 if the media player is playing, 0 otherwise

libvlc_media_player_play

int libvlc_media_player_play(libvlc_media_player_t p_mi)
Play

Parameters:
p_mi - the Media Player
Returns:
0 if playback started (and was already started), or -1 on error.

libvlc_media_player_set_pause

void libvlc_media_player_set_pause(libvlc_media_player_t mp,
                                   int do_pause)
Pause or resume (no effect if there is no media)

Parameters:
mp - the Media Player
do_pause - play/resume if zero, pause if non-zero
Since:
LibVLC 1.1.1

libvlc_media_player_pause

void libvlc_media_player_pause(libvlc_media_player_t p_mi)
Toggle pause (no effect if there is no media)

Parameters:
p_mi - the Media Player

libvlc_media_player_stop

void libvlc_media_player_stop(libvlc_media_player_t p_mi)
Stop (no effect if there is no media)

Parameters:
p_mi - the Media Player

libvlc_video_set_callbacks

void libvlc_video_set_callbacks(libvlc_media_player_t mp,
                                libvlc_lock_callback_t lock,
                                libvlc_unlock_callback_t unlock,
                                libvlc_display_callback_t display,
                                com.sun.jna.Pointer opaque)
Set callbacks and private data to render decoded video to a custom area in memory. Use libvlc_video_set_format() or libvlc_video_set_format_callbacks() to configure the decoded format.

Parameters:
mp - the media player
lock - callback to allocate video memory
unlock - callback to release video memory
display - callback when ready to display a video frame
opaque - private pointer for the three callbacks (as first parameter)
Since:
LibVLC 1.1.1

libvlc_video_set_format

void libvlc_video_set_format(libvlc_media_player_t mp,
                             java.lang.String chroma,
                             int width,
                             int height,
                             int pitch)
Set decoded video chroma and dimensions. This only works in combination with libvlc_video_set_callbacks(), and is mutually exclusive with libvlc_video_set_format_callbacks().

Parameters:
mp - the media player
chroma - a four-characters string identifying the chroma (e.g. "RV32" or "YUYV")
width - pixel width
height - pixel height
pitch - line pitch (in bytes)
Since:
LibVLC 1.1.1

libvlc_video_set_format_callbacks

void libvlc_video_set_format_callbacks(libvlc_media_player_t mp,
                                       libvlc_video_format_cb setup,
                                       libvlc_video_cleanup_cb cleanup)
Set decoded video chroma and dimensions. This only works in combination with libvlc_video_set_callbacks().

Parameters:
mp - the media player
setup - callback to select the video format (cannot be NULL)
cleanup - callback to release any allocated resources (or NULL)
Since:
LibVLC 1.2.0 or later

libvlc_media_player_set_nsobject

void libvlc_media_player_set_nsobject(libvlc_media_player_t p_mi,
                                      com.sun.jna.Pointer drawable)
Set the NSView handler where the media player should render its video output. Use the vout called "macosx". The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding protocol:

Parameters:
p_mi - the Media Player
drawable - the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol.

libvlc_media_player_get_nsobject

com.sun.jna.Pointer libvlc_media_player_get_nsobject(libvlc_media_player_t p_mi)
Get the NSView handler previously set with libvlc_media_player_set_nsobject().

Parameters:
p_mi - the Media Player
Returns:
the NSView handler or 0 if none where set

libvlc_media_player_set_agl

void libvlc_media_player_set_agl(libvlc_media_player_t p_mi,
                                 int drawable)
Set the agl handler where the media player should render its video output.

Parameters:
p_mi - the Media Player
drawable - the agl handler

libvlc_media_player_get_agl

int libvlc_media_player_get_agl(libvlc_media_player_t p_mi)
Get the agl handler previously set with libvlc_media_player_set_agl().

Parameters:
p_mi - the Media Player
Returns:
the agl handler or 0 if none where set

libvlc_media_player_set_xwindow

void libvlc_media_player_set_xwindow(libvlc_media_player_t p_mi,
                                     int drawable)
Set an X Window System drawable where the media player should render its video output. If LibVLC was built without X11 output support, then this has no effects. The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are not supported. The caller shall ensure that the X11 server is the same as the one the VLC instance has been configured with.

Parameters:
p_mi - the Media Player
drawable - the ID of the X window

libvlc_media_player_get_xwindow

int libvlc_media_player_get_xwindow(libvlc_media_player_t p_mi)
Get the X Window System window identifier previously set with libvlc_media_player_set_xwindow(). Note that this will return the identifier even if VLC is not currently using it (for instance if it is playing an audio-only input).

Parameters:
p_mi - the Media Player
Returns:
an X window ID, or 0 if none where set.

libvlc_media_player_set_hwnd

void libvlc_media_player_set_hwnd(libvlc_media_player_t p_mi,
                                  com.sun.jna.Pointer drawable)
Set a Win32/Win64 API window handle (HWND) where the media player should render its video output. If LibVLC was built without Win32/Win64 API output support, then this has no effects.

Parameters:
p_mi - the Media Player
drawable - windows handle of the drawable

libvlc_media_player_get_hwnd

com.sun.jna.Pointer libvlc_media_player_get_hwnd(libvlc_media_player_t p_mi)
Get the Windows API window handle (HWND) previously set with libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC is not currently outputting any video to it.

Parameters:
p_mi - the Media Player
Returns:
a window handle or NULL if there are none.

libvlc_media_player_get_length

long libvlc_media_player_get_length(libvlc_media_player_t p_mi)
Get the current movie length (in ms).

Parameters:
p_mi - the Media Player
Returns:
the movie length (in ms), or -1 if there is no media.

libvlc_media_player_get_time

long libvlc_media_player_get_time(libvlc_media_player_t p_mi)
Get the current movie time (in ms).

Parameters:
p_mi - the Media Player
Returns:
the movie time (in ms), or -1 if there is no media.

libvlc_media_player_set_time

void libvlc_media_player_set_time(libvlc_media_player_t p_mi,
                                  long i_time)
Set the movie time (in ms). This has no effect if no media is being played. Not all formats and protocols support this.

Parameters:
p_mi - the Media Player
i_time - the movie time (in ms).

libvlc_media_player_get_position

float libvlc_media_player_get_position(libvlc_media_player_t p_mi)
Get movie position.

Parameters:
p_mi - the Media Player
Returns:
movie position, or -1. in case of error

libvlc_media_player_set_position

void libvlc_media_player_set_position(libvlc_media_player_t p_mi,
                                      float f_pos)
Set movie position. This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol.

Parameters:
p_mi - the Media Player
f_pos - the position

libvlc_media_player_set_chapter

void libvlc_media_player_set_chapter(libvlc_media_player_t p_mi,
                                     int i_chapter)
Set movie chapter (if applicable).

Parameters:
p_mi - the Media Player
i_chapter - chapter number to play

libvlc_media_player_get_chapter

int libvlc_media_player_get_chapter(libvlc_media_player_t p_mi)
Get movie chapter.

Parameters:
p_mi - the Media Player
Returns:
chapter number currently playing, or -1 if there is no media.

libvlc_media_player_get_chapter_count

int libvlc_media_player_get_chapter_count(libvlc_media_player_t p_mi)
Get movie chapter count

Parameters:
p_mi - the Media Player
Returns:
number of chapters in movie, or -1.

libvlc_media_player_will_play

int libvlc_media_player_will_play(libvlc_media_player_t p_mi)
Is the player able to play

Parameters:
p_mi - the Media Player
Returns:
boolean

libvlc_media_player_get_chapter_count_for_title

int libvlc_media_player_get_chapter_count_for_title(libvlc_media_player_t p_mi,
                                                    int i_title)
Get title chapter count

Parameters:
p_mi - the Media Player
i_title - title
Returns:
number of chapters in title, or -1

libvlc_media_player_set_title

void libvlc_media_player_set_title(libvlc_media_player_t p_mi,
                                   int i_title)
Set movie title

Parameters:
p_mi - the Media Player
i_title - title number to play

libvlc_media_player_get_title

int libvlc_media_player_get_title(libvlc_media_player_t p_mi)
Get movie title

Parameters:
p_mi - the Media Player
Returns:
title number currently playing, or -1

libvlc_media_player_get_title_count

int libvlc_media_player_get_title_count(libvlc_media_player_t p_mi)
Get movie title count

Parameters:
p_mi - the Media Player
Returns:
title number count, or -1

libvlc_media_player_previous_chapter

void libvlc_media_player_previous_chapter(libvlc_media_player_t p_mi)
Set previous chapter (if applicable)

Parameters:
p_mi - the Media Player

libvlc_media_player_next_chapter

void libvlc_media_player_next_chapter(libvlc_media_player_t p_mi)
Set next chapter (if applicable)

Parameters:
p_mi - the Media Player

libvlc_media_player_get_rate

float libvlc_media_player_get_rate(libvlc_media_player_t p_mi)
Get the requested movie play rate.

Parameters:
p_mi - the Media Player
Returns:
movie play rate

libvlc_media_player_set_rate

int libvlc_media_player_set_rate(libvlc_media_player_t p_mi,
                                 float rate)
Set movie play rate

Parameters:
p_mi - the Media Player
rate - movie play rate to set
Returns:
-1 if an error was detected, 0 otherwise (but even then, it might not actually work depending on the underlying media protocol)

libvlc_media_player_get_state

int libvlc_media_player_get_state(libvlc_media_player_t p_mi)
Get current movie state

Parameters:
p_mi - the Media Player
Returns:
the current state of the media player (playing, paused, ...) @see libvlc_state_t

libvlc_media_player_get_fps

float libvlc_media_player_get_fps(libvlc_media_player_t p_mi)
Get movie fps rate

Parameters:
p_mi - the Media Player
Returns:
frames per second (fps) for this playing movie, or 0 if unspecified

libvlc_media_player_has_vout

int libvlc_media_player_has_vout(libvlc_media_player_t p_mi)
How many video outputs does this media player have?

Parameters:
p_mi - the media player
Returns:
the number of video outputs

libvlc_media_player_is_seekable

int libvlc_media_player_is_seekable(libvlc_media_player_t p_mi)
Is this media player seekable?

Parameters:
p_mi - the media player
Returns:
true if the media player can seek

libvlc_media_player_can_pause

int libvlc_media_player_can_pause(libvlc_media_player_t p_mi)
Can this media player be paused?

Parameters:
p_mi - the media player
Returns:
true if the media player can pause

libvlc_media_player_next_frame

void libvlc_media_player_next_frame(libvlc_media_player_t p_mi)
Display the next frame (if supported)

Parameters:
p_mi - the media player

libvlc_media_player_navigate

void libvlc_media_player_navigate(libvlc_media_player_t p_mi,
                                  int navigate)
Navigate through DVD Menu

Parameters:
p_mi - the Media Player
navigate - the Navigation mode since libVLC 1.2.0

libvlc_track_description_release

void libvlc_track_description_release(com.sun.jna.Pointer p_track_description)
Release (free) libvlc_track_description_t

Parameters:
p_track_description - the structure to release

libvlc_toggle_fullscreen

void libvlc_toggle_fullscreen(libvlc_media_player_t p_mi)
Toggle fullscreen status on non-embedded video outputs.

Parameters:
p_mi - the media player

libvlc_set_fullscreen

void libvlc_set_fullscreen(libvlc_media_player_t p_mi,
                           int b_fullscreen)
Enable or disable fullscreen.

Parameters:
p_mi - the media player
b_fullscreen - boolean for fullscreen status

libvlc_get_fullscreen

int libvlc_get_fullscreen(libvlc_media_player_t p_mi)
Get current fullscreen status.

Parameters:
p_mi - the media player
Returns:
the fullscreen status (boolean)

libvlc_video_set_key_input

void libvlc_video_set_key_input(libvlc_media_player_t p_mi,
                                int on)
Enable or disable key press events handling, according to the LibVLC hotkeys configuration. By default and for historical reasons, keyboard events are handled by the LibVLC video widget. \note On X11, there can be only one subscriber for key press and mouse click events per window. If your application has subscribed to those events for the X window ID of the video widget, then LibVLC will not be able to handle key presses and mouse clicks in any case. \warning This function is only implemented for X11 and Win32 at the moment.

Parameters:
p_mi - the media player
on - true to handle key press events, false to ignore them.

libvlc_video_set_mouse_input

void libvlc_video_set_mouse_input(libvlc_media_player_t p_mi,
                                  int on)
Enable or disable mouse click events handling. By default, those events are handled. This is needed for DVD menus to work, as well as a few video filters such as "puzzle". \note See also libvlc_video_set_key_input(). \warning This function is only implemented for X11 and Win32 at the moment.

Parameters:
p_mi - the media player
on - true to handle mouse click events, false to ignore them.

libvlc_video_get_size

int libvlc_video_get_size(libvlc_media_player_t p_mi,
                          int num,
                          com.sun.jna.ptr.IntByReference px,
                          com.sun.jna.ptr.IntByReference py)
Get the pixel dimensions of a video.

Parameters:
p_mi - media player
num - number of the video (starting from, and most commonly 0)
px - pointer to get the pixel width [OUT]
py - pointer to get the pixel height [OUT]
Returns:
0 on success, -1 if the specified video does not exist

libvlc_video_get_height

int libvlc_video_get_height(libvlc_media_player_t p_mi)
Deprecated. 

Get current video height. You should use libvlc_video_get_size() instead.

Parameters:
p_mi - the media player
Returns:
the video pixel height or 0 if not applicable

libvlc_video_get_width

int libvlc_video_get_width(libvlc_media_player_t p_mi)
Deprecated. 

Get current video width. You should use libvlc_video_get_size() instead.

Parameters:
p_mi - the media player
Returns:
the video pixel width or 0 if not applicable

libvlc_video_get_cursor

int libvlc_video_get_cursor(libvlc_media_player_t p_mi,
                            int num,
                            com.sun.jna.Pointer px,
                            com.sun.jna.Pointer py)
Get the mouse pointer coordinates over a video. Coordinates are expressed in terms of the decoded video resolution, not in terms of pixels on the screen/viewport (to get the latter, you can query your windowing system directly). Either of the coordinates may be negative or larger than the corresponding dimension of the video, if the cursor is outside the rendering area.

Parameters:
p_mi - media player
num - number of the video (starting from, and most commonly 0)
px - pointer to get the abscissa [OUT]
py - pointer to get the ordinate [OUT]
Returns:
0 on success, -1 if the specified video does not exist

libvlc_video_get_scale

float libvlc_video_get_scale(libvlc_media_player_t p_mi)
Get the current video scaling factor. See also libvlc_video_set_scale().

Parameters:
p_mi - the media player
Returns:
the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically.

libvlc_video_set_scale

void libvlc_video_set_scale(libvlc_media_player_t p_mi,
                            float f_factor)
Set the video scaling factor. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window/drawable (in windowed mode) or the entire screen. Note that not all video outputs support scaling.

Parameters:
p_mi - the media player
f_factor - the scaling factor, or zero

libvlc_video_get_aspect_ratio

java.lang.String libvlc_video_get_aspect_ratio(libvlc_media_player_t p_mi)
Get current video aspect ratio.

Parameters:
p_mi - the media player
Returns:
the video aspect ratio or NULL if unspecified (the result must be released with free()).

libvlc_video_set_aspect_ratio

void libvlc_video_set_aspect_ratio(libvlc_media_player_t p_mi,
                                   java.lang.String psz_aspect)
Set new video aspect ratio.

Parameters:
p_mi - the media player
psz_aspect - new video aspect-ratio or NULL to reset to default \note Invalid aspect ratios are ignored.

libvlc_video_get_spu

int libvlc_video_get_spu(libvlc_media_player_t p_mi)
Get current video subtitle.

Parameters:
p_mi - the media player
Returns:
the video subtitle selected, or -1 if none

libvlc_video_get_spu_count

int libvlc_video_get_spu_count(libvlc_media_player_t p_mi)
Get the number of available video subtitles.

Parameters:
p_mi - the media player
Returns:
the number of available video subtitles

libvlc_video_get_spu_description

libvlc_track_description_t libvlc_video_get_spu_description(libvlc_media_player_t p_mi)
Get the description of available video subtitles.

Parameters:
p_mi - the media player
Returns:
list containing description of available video subtitles

libvlc_video_set_spu

int libvlc_video_set_spu(libvlc_media_player_t p_mi,
                         int i_spu)
Set new video subtitle.

Parameters:
p_mi - the media player
i_spu - new video subtitle to select
Returns:
0 on success, -1 if out of range

libvlc_video_set_subtitle_file

int libvlc_video_set_subtitle_file(libvlc_media_player_t p_mi,
                                   java.lang.String psz_subtitle)
Set new video subtitle file.

Parameters:
p_mi - the media player
psz_subtitle - new video subtitle file
Returns:
the success status (boolean)

libvlc_video_get_title_description

libvlc_track_description_t libvlc_video_get_title_description(libvlc_media_player_t p_mi)
Get the description of available titles.

Parameters:
p_mi - the media player
Returns:
list containing description of available titles

libvlc_video_get_chapter_description

libvlc_track_description_t libvlc_video_get_chapter_description(libvlc_media_player_t p_mi,
                                                                int i_title)
Get the description of available chapters for specific title.

Parameters:
p_mi - the media player
i_title - selected title
Returns:
list containing description of available chapter for title i_title

libvlc_video_get_crop_geometry

java.lang.String libvlc_video_get_crop_geometry(libvlc_media_player_t p_mi)
Get current crop filter geometry.

Parameters:
p_mi - the media player
Returns:
the crop filter geometry or NULL if unset

libvlc_video_set_crop_geometry

void libvlc_video_set_crop_geometry(libvlc_media_player_t p_mi,
                                    java.lang.String psz_geometry)
Set new crop filter geometry.

Parameters:
p_mi - the media player
psz_geometry - new crop filter geometry (NULL to unset)

libvlc_video_get_teletext

int libvlc_video_get_teletext(libvlc_media_player_t p_mi)
Get current teletext page requested.

Parameters:
p_mi - the media player
Returns:
the current teletext page requested.

libvlc_video_set_teletext

void libvlc_video_set_teletext(libvlc_media_player_t p_mi,
                               int i_page)
Set new teletext page to retrieve.

Parameters:
p_mi - the media player
i_page - teletex page number requested

libvlc_toggle_teletext

void libvlc_toggle_teletext(libvlc_media_player_t p_mi)
Toggle teletext transparent status on video output.

Parameters:
p_mi - the media player

libvlc_video_get_track_count

int libvlc_video_get_track_count(libvlc_media_player_t p_mi)
Get number of available video tracks.

Parameters:
p_mi - media player
Returns:
the number of available video tracks (int)

libvlc_video_get_track_description

libvlc_track_description_t libvlc_video_get_track_description(libvlc_media_player_t p_mi)
Get the description of available video tracks.

Parameters:
p_mi - media player
Returns:
list with description of available video tracks, or NULL on error

libvlc_video_get_track

int libvlc_video_get_track(libvlc_media_player_t p_mi)
Get current video track.

Parameters:
p_mi - media player
Returns:
the video track (int) or -1 if none

libvlc_video_set_track

int libvlc_video_set_track(libvlc_media_player_t p_mi,
                           int i_track)
Set video track.

Parameters:
p_mi - media player
i_track - the track (int)
Returns:
0 on success, -1 if out of range

libvlc_video_take_snapshot

int libvlc_video_take_snapshot(libvlc_media_player_t p_mi,
                               int num,
                               java.lang.String psz_filepath,
                               int i_width,
                               int i_height)
Take a snapshot of the current video window. If i_width AND i_height is 0, original size is used. If i_width XOR i_height is 0, original aspect-ratio is preserved.

Parameters:
p_mi - media player instance
num - number of video output (typically 0 for the first/only one)
psz_filepath - the path where to save the screenshot to
i_width - the snapshot's width
i_height - the snapshot's height
Returns:
0 on success, -1 if the video was not found

libvlc_video_set_deinterlace

void libvlc_video_set_deinterlace(libvlc_media_player_t p_mi,
                                  java.lang.String psz_mode)
Enable or disable deinterlace filter

Parameters:
p_mi - libvlc media player
psz_mode - type of deinterlace filter, NULL to disable

libvlc_video_get_marquee_int

int libvlc_video_get_marquee_int(libvlc_media_player_t p_mi,
                                 int option)
Get an integer marquee option value

Parameters:
p_mi - libvlc media player
option - marq option to get @see libvlc_video_marquee_int_option_t

libvlc_video_get_marquee_string

java.lang.String libvlc_video_get_marquee_string(libvlc_media_player_t p_mi,
                                                 int option)
Get a string marquee option value

Parameters:
p_mi - libvlc media player
option - marq option to get @see libvlc_video_marquee_string_option_t

libvlc_video_set_marquee_int

void libvlc_video_set_marquee_int(libvlc_media_player_t p_mi,
                                  int option,
                                  int i_val)
Enable, disable or set an integer marquee option Setting libvlc_marquee_Enable has the side effect of enabling (arg !0) or disabling (arg 0) the marq filter.

Parameters:
p_mi - libvlc media player
option - marq option to set @see libvlc_video_marquee_int_option_t
i_val - marq option value

libvlc_video_set_marquee_string

void libvlc_video_set_marquee_string(libvlc_media_player_t p_mi,
                                     int option,
                                     java.lang.String psz_text)
Set a marquee string option

Parameters:
p_mi - libvlc media player
option - marq option to set @see libvlc_video_marquee_string_option_t
psz_text - marq option value

libvlc_video_get_logo_int

int libvlc_video_get_logo_int(libvlc_media_player_t p_mi,
                              int option)
Get integer logo option.

Parameters:
p_mi - libvlc media player instance
option - logo option to get, values of libvlc_video_logo_option_t

libvlc_video_set_logo_int

void libvlc_video_set_logo_int(libvlc_media_player_t p_mi,
                               int option,
                               int value)
Set logo option as integer. Options that take a different type value are ignored. Passing libvlc_logo_enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the logo filter.

Parameters:
p_mi - libvlc media player instance
option - logo option to set, values of libvlc_video_logo_option_t
value - logo option value

libvlc_video_set_logo_string

void libvlc_video_set_logo_string(libvlc_media_player_t p_mi,
                                  int option,
                                  java.lang.String psz_value)
Set logo option as string. Options that take a different type value are ignored.

Parameters:
p_mi - libvlc media player instance
option - logo option to set, values of libvlc_video_logo_option_t
psz_value - logo option value

libvlc_video_get_adjust_int

int libvlc_video_get_adjust_int(libvlc_media_player_t p_mi,
                                int option)
Get integer adjust option.

Parameters:
p_mi - libvlc media player instance
option - adjust option to get, values of libvlc_video_adjust_option_t
Returns:
value
Since:
LibVLC 1.1.1

libvlc_video_set_adjust_int

void libvlc_video_set_adjust_int(libvlc_media_player_t p_mi,
                                 int option,
                                 int value)
Set adjust option as integer. Options that take a different type value are ignored. Passing libvlc_adjust_enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the adjust filter.

Parameters:
p_mi - libvlc media player instance
option - adust option to set, values of libvlc_video_adjust_option_t
value - adjust option value
Since:
LibVLC 1.1.1

libvlc_video_get_adjust_float

float libvlc_video_get_adjust_float(libvlc_media_player_t p_mi,
                                    int option)
Get float adjust option.

Parameters:
p_mi - libvlc media player instance
option - adjust option to get, values of libvlc_video_adjust_option_t
Returns:
value
Since:
LibVLC 1.1.1

libvlc_video_set_adjust_float

void libvlc_video_set_adjust_float(libvlc_media_player_t p_mi,
                                   int option,
                                   float value)
Set adjust option as float. Options that take a different type value are ignored.

Parameters:
p_mi - libvlc media player instance
option - adust option to set, values of libvlc_video_adjust_option_t
value - adjust option value
Since:
LibVLC 1.1.1

libvlc_audio_output_list_get

libvlc_audio_output_t libvlc_audio_output_list_get(libvlc_instance_t p_instance)
Get the list of available audio outputs

Parameters:
p_instance - libvlc instance
Returns:
list of available audio outputs. It must be freed it with
See Also:
@see libvlc_audio_output_t . In case of error, NULL is returned.

libvlc_audio_output_list_release

void libvlc_audio_output_list_release(libvlc_audio_output_t p_list)
Free the list of available audio outputs

Parameters:
p_list - list with audio outputs for release

libvlc_audio_output_set

int libvlc_audio_output_set(libvlc_media_player_t p_mi,
                            java.lang.String psz_name)
Set the audio output. Change will be applied after stop and play.

Parameters:
p_mi - media player
psz_name - name of audio output, use psz_name of @see libvlc_audio_output_t
Returns:
true if function succeded

libvlc_audio_output_device_count

int libvlc_audio_output_device_count(libvlc_instance_t p_instance,
                                     java.lang.String psz_audio_output)
Get count of devices for audio output, these devices are hardware oriented like analor or digital output of sound card

Parameters:
p_instance - libvlc instance
psz_audio_output - - name of audio output, @see libvlc_audio_output_t
Returns:
number of devices

libvlc_audio_output_device_longname

java.lang.String libvlc_audio_output_device_longname(libvlc_instance_t p_instance,
                                                     java.lang.String psz_audio_output,
                                                     int i_device)
Get long name of device, if not available short name given

Parameters:
p_instance - libvlc instance
psz_audio_output - - name of audio output, @see libvlc_audio_output_t
i_device - device index
Returns:
long name of device

libvlc_audio_output_device_id

java.lang.String libvlc_audio_output_device_id(libvlc_instance_t p_instance,
                                               java.lang.String psz_audio_output,
                                               int i_device)
Get id name of device

Parameters:
p_instance - libvlc instance
psz_audio_output - - name of audio output, @see libvlc_audio_output_t
i_device - device index
Returns:
id name of device, use for setting device, need to be free after use

libvlc_audio_output_device_set

void libvlc_audio_output_device_set(libvlc_media_player_t p_mi,
                                    java.lang.String psz_audio_output,
                                    java.lang.String psz_device_id)
Set audio output device. Changes are only effective after stop and play.

Parameters:
p_mi - media player
psz_audio_output - - name of audio output, @see libvlc_audio_output_t
psz_device_id - device

libvlc_audio_output_get_device_type

int libvlc_audio_output_get_device_type(libvlc_media_player_t p_mi)
Get current audio device type. Device type describes something like character of output sound - stereo sound, 2.1, 5.1 etc

Parameters:
p_mi - media player
Returns:
the audio devices type @see libvlc_audio_output_device_types_t

libvlc_audio_output_set_device_type

void libvlc_audio_output_set_device_type(libvlc_media_player_t p_mi,
                                         int device_type)
Set current audio device type.

Parameters:
p_mi - vlc instance
device_type - the audio device type, according to @see libvlc_audio_output_device_types_t

libvlc_audio_toggle_mute

void libvlc_audio_toggle_mute(libvlc_media_player_t p_mi)
Toggle mute status.

Parameters:
p_mi - media player

libvlc_audio_get_mute

int libvlc_audio_get_mute(libvlc_media_player_t p_mi)
Get current mute status.

Parameters:
p_mi - media player
Returns:
the mute status (boolean)

libvlc_audio_set_mute

void libvlc_audio_set_mute(libvlc_media_player_t p_mi,
                           int status)
Set mute status.

Parameters:
p_mi - media player
status - If status is true then mute, otherwise unmute

libvlc_audio_get_volume

int libvlc_audio_get_volume(libvlc_media_player_t p_mi)
Get current audio level.

Parameters:
p_mi - media player
Returns:
the audio level (int)

libvlc_audio_set_volume

int libvlc_audio_set_volume(libvlc_media_player_t p_mi,
                            int i_volume)
Set current audio level.

Parameters:
p_mi - media player
i_volume - the volume (int)
Returns:
0 if the volume was set, -1 if it was out of range

libvlc_audio_get_track_count

int libvlc_audio_get_track_count(libvlc_media_player_t p_mi)
Get number of available audio tracks.

Parameters:
p_mi - media player
Returns:
the number of available audio tracks (int), or -1 if unavailable

libvlc_audio_get_track_description

libvlc_track_description_t libvlc_audio_get_track_description(libvlc_media_player_t p_mi)
Get the description of available audio tracks.

Parameters:
p_mi - media player
Returns:
list with description of available audio tracks, or NULL

libvlc_audio_get_track

int libvlc_audio_get_track(libvlc_media_player_t p_mi)
Get current audio track.

Parameters:
p_mi - media player
Returns:
the audio track (int), or -1 if none.

libvlc_audio_set_track

int libvlc_audio_set_track(libvlc_media_player_t p_mi,
                           int i_track)
Set current audio track.

Parameters:
p_mi - media player
i_track - the track (int)
Returns:
0 on success, -1 on error

libvlc_audio_get_channel

int libvlc_audio_get_channel(libvlc_media_player_t p_mi)
Get current audio channel.

Parameters:
p_mi - media player
Returns:
the audio channel @see libvlc_audio_output_channel_t

libvlc_audio_set_channel

int libvlc_audio_set_channel(libvlc_media_player_t p_mi,
                             int channel)
Set current audio channel.

Parameters:
p_mi - media player
channel - the audio channel, @see libvlc_audio_output_channel_t
Returns:
0 on success, -1 on error

libvlc_audio_get_delay

long libvlc_audio_get_delay(libvlc_media_player_t p_mi)
Get current audio delay.

Parameters:
p_mi - media player
Returns:
amount audio is being delayed by, in microseconds
Since:
LibVLC 1.1.1

libvlc_audio_set_delay

int libvlc_audio_set_delay(libvlc_media_player_t p_mi,
                           long i_delay)
Set current audio delay. The delay is only active for the current media item and will be reset to zero each time the media changes.

Parameters:
p_mi - media player
i_delay - amount to delay audio by, in microseconds
Returns:
0 on success, -1 on error
Since:
LibVLC 1.1.1

libvlc_media_list_new

libvlc_media_list_t libvlc_media_list_new(libvlc_instance_t p_instance)
Create an empty media list.

Parameters:
p_instance - libvlc instance
Returns:
empty media list, or NULL on error

libvlc_media_list_release

void libvlc_media_list_release(libvlc_media_list_t p_ml)
Release media list created with libvlc_media_list_new().

Parameters:
p_ml - a media list created with libvlc_media_list_new()

libvlc_media_list_retain

void libvlc_media_list_retain(libvlc_media_list_t p_ml)
Retain reference to a media list

Parameters:
p_ml - a media list created with libvlc_media_list_new()

libvlc_media_list_set_media

void libvlc_media_list_set_media(libvlc_media_list_t p_ml,
                                 libvlc_media_t p_md)
Associate media instance with this media list instance. If another media instance was present it will be released. The libvlc_media_list_lock should NOT be held upon entering this function.

Parameters:
p_ml - a media list instance
p_md - media instance to add

libvlc_media_list_media

libvlc_media_t libvlc_media_list_media(libvlc_media_list_t p_ml)
Get media instance from this media list instance. This action will increase the refcount on the media instance. The libvlc_media_list_lock should NOT be held upon entering this function.

Parameters:
p_ml - a media list instance
Returns:
media instance

libvlc_media_list_add_media

int libvlc_media_list_add_media(libvlc_media_list_t p_ml,
                                libvlc_media_t p_md)
Add media instance to media list The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
p_md - a media instance
Returns:
0 on success, -1 if the media list is read-only

libvlc_media_list_insert_media

int libvlc_media_list_insert_media(libvlc_media_list_t p_ml,
                                   libvlc_media_t p_md,
                                   int i_pos)
Insert media instance in media list on a position The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
p_md - a media instance
i_pos - position in array where to insert
Returns:
0 on success, -1 if the media list si read-only

libvlc_media_list_remove_index

int libvlc_media_list_remove_index(libvlc_media_list_t p_ml,
                                   int i_pos)
Remove media instance from media list on a position The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
i_pos - position in array where to insert
Returns:
0 on success, -1 if the list is read-only or the item was not found

libvlc_media_list_count

int libvlc_media_list_count(libvlc_media_list_t p_ml)
Get count on media list items The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
Returns:
number of items in media list

libvlc_media_list_item_at_index

libvlc_media_t libvlc_media_list_item_at_index(libvlc_media_list_t p_ml,
                                               int i_pos)
List media instance in media list at a position The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
i_pos - position in array where to insert
Returns:
media instance at position i_pos, or NULL if not found. In case of success, libvlc_media_retain() is called to increase the refcount on the media.

libvlc_media_list_index_of_item

int libvlc_media_list_index_of_item(libvlc_media_list_t p_ml,
                                    libvlc_media_t p_md)
Find index position of List media instance in media list. Warning: the function will return the first matched position. The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance
p_md - media list instance
Returns:
position of media instance

libvlc_media_list_is_readonly

int libvlc_media_list_is_readonly(libvlc_media_list_t p_ml)
This indicates if this media list is read-only from a user point of view

Parameters:
p_ml - media list instance
Returns:
0 on readonly, 1 on readwrite

libvlc_media_list_lock

void libvlc_media_list_lock(libvlc_media_list_t p_ml)
Get lock on media list items

Parameters:
p_ml - a media list instance

libvlc_media_list_unlock

void libvlc_media_list_unlock(libvlc_media_list_t p_ml)
Release lock on media list items The libvlc_media_list_lock should be held upon entering this function.

Parameters:
p_ml - a media list instance

libvlc_media_list_event_manager

libvlc_event_manager_t libvlc_media_list_event_manager(libvlc_media_list_t p_ml)
Get libvlc_event_manager from this media list instance. The p_event_manager is immutable, so you don't have to hold the lock

Parameters:
p_ml - a media list instance
Returns:
libvlc_event_manager

libvlc_media_list_player_new

libvlc_media_list_player_t libvlc_media_list_player_new(libvlc_instance_t p_instance)
Create new media_list_player.

Parameters:
p_instance - libvlc instance
Returns:
media list player instance or NULL on error

libvlc_media_list_player_release

void libvlc_media_list_player_release(libvlc_media_list_player_t p_mlp)
Release media_list_player.

Parameters:
p_mlp - media list player instance

libvlc_media_list_player_event_manager

libvlc_event_manager_t libvlc_media_list_player_event_manager(libvlc_media_list_player_t p_mlp)
Return the event manager of this media_list_player.

Parameters:
p_mlp - media list player instance
Returns:
the event manager

libvlc_media_list_player_set_media_player

void libvlc_media_list_player_set_media_player(libvlc_media_list_player_t p_mlp,
                                               libvlc_media_player_t p_mi)
Replace media player in media_list_player with this instance.

Parameters:
p_mlp - media list player instance
p_mi - media player instance

libvlc_media_list_player_set_media_list

void libvlc_media_list_player_set_media_list(libvlc_media_list_player_t p_mlp,
                                             libvlc_media_list_t p_mlist)
Set the media list associated with the player

Parameters:
p_mlp - media list player instance
p_mlist - list of media

libvlc_media_list_player_play

void libvlc_media_list_player_play(libvlc_media_list_player_t p_mlp)
Play media list

Parameters:
p_mlp - media list player instance

libvlc_media_list_player_pause

void libvlc_media_list_player_pause(libvlc_media_list_player_t p_mlp)
Pause media list

Parameters:
p_mlp - media list player instance

libvlc_media_list_player_is_playing

int libvlc_media_list_player_is_playing(libvlc_media_list_player_t p_mlp)
Is media list playing?

Parameters:
p_mlp - media list player instance
Returns:
true for playing and false for not playing

libvlc_media_list_player_get_state

libvlc_state_t libvlc_media_list_player_get_state(libvlc_media_list_player_t p_mlp)
Get current libvlc_state of media list player

Parameters:
p_mlp - media list player instance
Returns:
libvlc_state_t for media list player

libvlc_media_list_player_play_item_at_index

int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t p_mlp,
                                                int i_index)
Play media list item at position index

Parameters:
p_mlp - media list player instance
i_index - index in media list to play
Returns:
0 upon success -1 if the item wasn't found

libvlc_media_list_player_play_item

int libvlc_media_list_player_play_item(libvlc_media_list_player_t p_mlp,
                                       libvlc_media_t p_md)
Play the given media item

Parameters:
p_mlp - media list player instance
p_md - the media instance
Returns:
0 upon success, -1 if the media is not part of the media list

libvlc_media_list_player_stop

void libvlc_media_list_player_stop(libvlc_media_list_player_t p_mlp)
Stop playing media list

Parameters:
p_mlp - media list player instance

libvlc_media_list_player_next

int libvlc_media_list_player_next(libvlc_media_list_player_t p_mlp)
Play next item from media list

Parameters:
p_mlp - media list player instance
Returns:
0 upon success -1 if there is no next item

libvlc_media_list_player_previous

int libvlc_media_list_player_previous(libvlc_media_list_player_t p_mlp)
Play previous item from media list

Parameters:
p_mlp - media list player instance
Returns:
0 upon success -1 if there is no previous item

libvlc_media_list_player_set_playback_mode

void libvlc_media_list_player_set_playback_mode(libvlc_media_list_player_t p_mlp,
                                                int e_mode)
Sets the playback mode for the playlist

Parameters:
p_mlp - media list player instance
e_mode - playback mode specification

(C)2010 Caprica Software Limited