vlc === .. py:module:: vlc .. autoapi-nested-parse:: This module provides bindings for the LibVLC public API, see https://wiki.videolan.org/LibVLC. You can find the documentation and a README file with some examples at https://www.olivieraubert.net/vlc/python-ctypes/. Basically, the most important class is :class:`Instance`, which is used to create a libvlc instance. From this instance, you then create :class:`MediaPlayer` and :class:`MediaListPlayer` instances. Alternatively, you may create instances of the :class:`MediaPlayer` and :class:`MediaListPlayer` class directly and an instance of :class:`Instance` will be implicitly created. The latter can be obtained using the :meth:`MediaPlayer.get_instance` and :class:`MediaListPlayer`. Attributes ---------- .. autoapisummary:: vlc.DEFAULT_ENCODING vlc.FILE_ptr vlc.LibvlcSetExitHandlerCb vlc.Log_ptr vlc.PyFile_AsFd vlc.PyFile_FromFd vlc._Cfunctions vlc._Globals vlc._Ints vlc._Seqs vlc._default_instance vlc._internal_guard vlc.build_date vlc.cb vlc.libc_path vlc.logger Exceptions ---------- .. toctree:: :hidden: /api/vlc/VLCException .. autoapisummary:: vlc.VLCException Classes ------- .. toctree:: :hidden: /api/vlc/AudioCleanupCb /api/vlc/AudioDrainCb /api/vlc/AudioEqualizer /api/vlc/AudioFlushCb /api/vlc/AudioOutput /api/vlc/AudioOutputChannel /api/vlc/AudioOutputDevice /api/vlc/AudioOutputDeviceTypes /api/vlc/AudioPauseCb /api/vlc/AudioPlayCb /api/vlc/AudioResumeCb /api/vlc/AudioSetVolumeCb /api/vlc/AudioSetupCb /api/vlc/AudioTrack /api/vlc/Callback /api/vlc/CallbackDecorators /api/vlc/ChapterDescription /api/vlc/DialogCbs /api/vlc/DialogQuestionType /api/vlc/Event /api/vlc/EventManager /api/vlc/EventType /api/vlc/EventUnion /api/vlc/FILE /api/vlc/Instance /api/vlc/ListPOINTER /api/vlc/Log /api/vlc/LogCb /api/vlc/LogIterator /api/vlc/LogLevel /api/vlc/LogMessage /api/vlc/Media /api/vlc/MediaCloseCb /api/vlc/MediaDiscoverer /api/vlc/MediaDiscovererCategory /api/vlc/MediaDiscovererDescription /api/vlc/MediaLibrary /api/vlc/MediaList /api/vlc/MediaListPlayer /api/vlc/MediaOpenCb /api/vlc/MediaParseFlag /api/vlc/MediaParsedStatus /api/vlc/MediaPlayer /api/vlc/MediaPlayerRole /api/vlc/MediaReadCb /api/vlc/MediaSeekCb /api/vlc/MediaSlave /api/vlc/MediaSlaveType /api/vlc/MediaStats /api/vlc/MediaThumbnailRequest /api/vlc/MediaTrack /api/vlc/MediaTrackInfo /api/vlc/MediaType /api/vlc/Meta /api/vlc/ModuleDescription /api/vlc/NavigateMode /api/vlc/PlaybackMode /api/vlc/Position /api/vlc/RdDescription /api/vlc/Renderer /api/vlc/RendererDiscoverer /api/vlc/State /api/vlc/SubtitleTrack /api/vlc/TeletextKey /api/vlc/TitleDescription /api/vlc/TrackDescription /api/vlc/TrackType /api/vlc/VideoAdjustOption /api/vlc/VideoCleanupCb /api/vlc/VideoDisplayCb /api/vlc/VideoFormatCb /api/vlc/VideoLockCb /api/vlc/VideoLogoOption /api/vlc/VideoMarqueeOption /api/vlc/VideoOrient /api/vlc/VideoProjection /api/vlc/VideoTrack /api/vlc/VideoUnlockCb /api/vlc/VideoViewpoint /api/vlc/_Cstruct /api/vlc/_Ctype /api/vlc/_Enum /api/vlc/memoize_parameterless .. autoapisummary:: vlc.AudioCleanupCb vlc.AudioDrainCb vlc.AudioEqualizer vlc.AudioFlushCb vlc.AudioOutput vlc.AudioOutputChannel vlc.AudioOutputDevice vlc.AudioOutputDeviceTypes vlc.AudioPauseCb vlc.AudioPlayCb vlc.AudioResumeCb vlc.AudioSetVolumeCb vlc.AudioSetupCb vlc.AudioTrack vlc.Callback vlc.CallbackDecorators vlc.ChapterDescription vlc.DialogCbs vlc.DialogQuestionType vlc.Event vlc.EventManager vlc.EventType vlc.EventUnion vlc.FILE vlc.Instance vlc.ListPOINTER vlc.Log vlc.LogCb vlc.LogIterator vlc.LogLevel vlc.LogMessage vlc.Media vlc.MediaCloseCb vlc.MediaDiscoverer vlc.MediaDiscovererCategory vlc.MediaDiscovererDescription vlc.MediaLibrary vlc.MediaList vlc.MediaListPlayer vlc.MediaOpenCb vlc.MediaParseFlag vlc.MediaParsedStatus vlc.MediaPlayer vlc.MediaPlayerRole vlc.MediaReadCb vlc.MediaSeekCb vlc.MediaSlave vlc.MediaSlaveType vlc.MediaStats vlc.MediaThumbnailRequest vlc.MediaTrack vlc.MediaTrackInfo vlc.MediaType vlc.Meta vlc.ModuleDescription vlc.NavigateMode vlc.PlaybackMode vlc.Position vlc.RdDescription vlc.Renderer vlc.RendererDiscoverer vlc.State vlc.SubtitleTrack vlc.TeletextKey vlc.TitleDescription vlc.TrackDescription vlc.TrackType vlc.VideoAdjustOption vlc.VideoCleanupCb vlc.VideoDisplayCb vlc.VideoFormatCb vlc.VideoLockCb vlc.VideoLogoOption vlc.VideoMarqueeOption vlc.VideoOrient vlc.VideoProjection vlc.VideoTrack vlc.VideoUnlockCb vlc.VideoViewpoint vlc._Cstruct vlc._Ctype vlc._Enum vlc.memoize_parameterless Functions --------- .. autoapisummary:: vlc._Cfunction vlc._Cobject vlc._Constructor vlc._dot2int vlc.bytes_to_str vlc.callbackmethod vlc.class_result vlc.debug_callback vlc.find_lib vlc.get_default_instance vlc.getch vlc.hex_version vlc.len_args vlc.libvlc_add_intf vlc.libvlc_audio_equalizer_get_amp_at_index vlc.libvlc_audio_equalizer_get_band_count vlc.libvlc_audio_equalizer_get_band_frequency vlc.libvlc_audio_equalizer_get_preamp vlc.libvlc_audio_equalizer_get_preset_count vlc.libvlc_audio_equalizer_get_preset_name vlc.libvlc_audio_equalizer_new vlc.libvlc_audio_equalizer_new_from_preset vlc.libvlc_audio_equalizer_release vlc.libvlc_audio_equalizer_set_amp_at_index vlc.libvlc_audio_equalizer_set_preamp vlc.libvlc_audio_filter_list_get vlc.libvlc_audio_get_channel vlc.libvlc_audio_get_delay vlc.libvlc_audio_get_mute vlc.libvlc_audio_get_track vlc.libvlc_audio_get_track_count vlc.libvlc_audio_get_track_description vlc.libvlc_audio_get_volume vlc.libvlc_audio_output_device_count vlc.libvlc_audio_output_device_enum vlc.libvlc_audio_output_device_get vlc.libvlc_audio_output_device_id vlc.libvlc_audio_output_device_list_get vlc.libvlc_audio_output_device_list_release vlc.libvlc_audio_output_device_longname vlc.libvlc_audio_output_device_set vlc.libvlc_audio_output_get_device_type vlc.libvlc_audio_output_list_get vlc.libvlc_audio_output_list_release vlc.libvlc_audio_output_set vlc.libvlc_audio_output_set_device_type vlc.libvlc_audio_set_callbacks vlc.libvlc_audio_set_channel vlc.libvlc_audio_set_delay vlc.libvlc_audio_set_format vlc.libvlc_audio_set_format_callbacks vlc.libvlc_audio_set_mute vlc.libvlc_audio_set_track vlc.libvlc_audio_set_volume vlc.libvlc_audio_set_volume_callback vlc.libvlc_audio_toggle_mute vlc.libvlc_chapter_descriptions_release vlc.libvlc_clearerr vlc.libvlc_clock vlc.libvlc_dialog_dismiss vlc.libvlc_dialog_get_context vlc.libvlc_dialog_post_action vlc.libvlc_dialog_post_login vlc.libvlc_dialog_set_callbacks vlc.libvlc_dialog_set_context vlc.libvlc_errmsg vlc.libvlc_event_attach vlc.libvlc_event_detach vlc.libvlc_event_type_name vlc.libvlc_free vlc.libvlc_get_changeset vlc.libvlc_get_compiler vlc.libvlc_get_fullscreen vlc.libvlc_get_log_verbosity vlc.libvlc_get_version vlc.libvlc_hex_version vlc.libvlc_log_clear vlc.libvlc_log_close vlc.libvlc_log_count vlc.libvlc_log_get_context vlc.libvlc_log_get_iterator vlc.libvlc_log_get_object vlc.libvlc_log_iterator_free vlc.libvlc_log_iterator_has_next vlc.libvlc_log_iterator_next vlc.libvlc_log_open vlc.libvlc_log_set vlc.libvlc_log_set_file vlc.libvlc_log_unset vlc.libvlc_media_add_option vlc.libvlc_media_add_option_flag vlc.libvlc_media_discoverer_event_manager vlc.libvlc_media_discoverer_is_running vlc.libvlc_media_discoverer_list_get vlc.libvlc_media_discoverer_list_release vlc.libvlc_media_discoverer_localized_name vlc.libvlc_media_discoverer_media_list vlc.libvlc_media_discoverer_new vlc.libvlc_media_discoverer_new_from_name vlc.libvlc_media_discoverer_release vlc.libvlc_media_discoverer_start vlc.libvlc_media_discoverer_stop vlc.libvlc_media_duplicate vlc.libvlc_media_event_manager vlc.libvlc_media_get_codec_description vlc.libvlc_media_get_duration vlc.libvlc_media_get_meta vlc.libvlc_media_get_mrl vlc.libvlc_media_get_parsed_status vlc.libvlc_media_get_state vlc.libvlc_media_get_stats vlc.libvlc_media_get_tracks_info vlc.libvlc_media_get_type vlc.libvlc_media_get_user_data vlc.libvlc_media_is_parsed vlc.libvlc_media_library_load vlc.libvlc_media_library_media_list vlc.libvlc_media_library_new vlc.libvlc_media_library_release vlc.libvlc_media_library_retain vlc.libvlc_media_list_add_media vlc.libvlc_media_list_count vlc.libvlc_media_list_event_manager vlc.libvlc_media_list_index_of_item vlc.libvlc_media_list_insert_media vlc.libvlc_media_list_is_readonly vlc.libvlc_media_list_item_at_index vlc.libvlc_media_list_lock vlc.libvlc_media_list_media vlc.libvlc_media_list_new vlc.libvlc_media_list_player_event_manager vlc.libvlc_media_list_player_get_media_player vlc.libvlc_media_list_player_get_state vlc.libvlc_media_list_player_is_playing vlc.libvlc_media_list_player_new vlc.libvlc_media_list_player_next vlc.libvlc_media_list_player_pause vlc.libvlc_media_list_player_play vlc.libvlc_media_list_player_play_item vlc.libvlc_media_list_player_play_item_at_index vlc.libvlc_media_list_player_previous vlc.libvlc_media_list_player_release vlc.libvlc_media_list_player_retain vlc.libvlc_media_list_player_set_media_list vlc.libvlc_media_list_player_set_media_player vlc.libvlc_media_list_player_set_pause vlc.libvlc_media_list_player_set_playback_mode vlc.libvlc_media_list_player_stop vlc.libvlc_media_list_release vlc.libvlc_media_list_remove_index vlc.libvlc_media_list_retain vlc.libvlc_media_list_set_media vlc.libvlc_media_list_unlock vlc.libvlc_media_new_as_node vlc.libvlc_media_new_callbacks vlc.libvlc_media_new_fd vlc.libvlc_media_new_location vlc.libvlc_media_new_path vlc.libvlc_media_parse vlc.libvlc_media_parse_async vlc.libvlc_media_parse_stop vlc.libvlc_media_parse_with_options vlc.libvlc_media_player_add_slave vlc.libvlc_media_player_can_pause vlc.libvlc_media_player_event_manager vlc.libvlc_media_player_get_agl vlc.libvlc_media_player_get_chapter vlc.libvlc_media_player_get_chapter_count vlc.libvlc_media_player_get_chapter_count_for_title vlc.libvlc_media_player_get_fps vlc.libvlc_media_player_get_full_chapter_descriptions vlc.libvlc_media_player_get_full_title_descriptions vlc.libvlc_media_player_get_hwnd vlc.libvlc_media_player_get_length vlc.libvlc_media_player_get_media vlc.libvlc_media_player_get_nsobject vlc.libvlc_media_player_get_position vlc.libvlc_media_player_get_rate vlc.libvlc_media_player_get_role vlc.libvlc_media_player_get_state vlc.libvlc_media_player_get_time vlc.libvlc_media_player_get_title vlc.libvlc_media_player_get_title_count vlc.libvlc_media_player_get_xwindow vlc.libvlc_media_player_has_vout vlc.libvlc_media_player_is_playing vlc.libvlc_media_player_is_seekable vlc.libvlc_media_player_navigate vlc.libvlc_media_player_new vlc.libvlc_media_player_new_from_media vlc.libvlc_media_player_next_chapter vlc.libvlc_media_player_next_frame vlc.libvlc_media_player_pause vlc.libvlc_media_player_play vlc.libvlc_media_player_previous_chapter vlc.libvlc_media_player_program_scrambled vlc.libvlc_media_player_release vlc.libvlc_media_player_retain vlc.libvlc_media_player_set_agl vlc.libvlc_media_player_set_android_context vlc.libvlc_media_player_set_chapter vlc.libvlc_media_player_set_equalizer vlc.libvlc_media_player_set_evas_object vlc.libvlc_media_player_set_hwnd vlc.libvlc_media_player_set_media vlc.libvlc_media_player_set_nsobject vlc.libvlc_media_player_set_pause vlc.libvlc_media_player_set_position vlc.libvlc_media_player_set_rate vlc.libvlc_media_player_set_renderer vlc.libvlc_media_player_set_role vlc.libvlc_media_player_set_time vlc.libvlc_media_player_set_title vlc.libvlc_media_player_set_video_title_display vlc.libvlc_media_player_set_xwindow vlc.libvlc_media_player_stop vlc.libvlc_media_player_will_play vlc.libvlc_media_release vlc.libvlc_media_retain vlc.libvlc_media_save_meta vlc.libvlc_media_set_meta vlc.libvlc_media_set_user_data vlc.libvlc_media_slaves_add vlc.libvlc_media_slaves_clear vlc.libvlc_media_slaves_get vlc.libvlc_media_slaves_release vlc.libvlc_media_subitems vlc.libvlc_media_tracks_get vlc.libvlc_media_tracks_release vlc.libvlc_module_description_list_release vlc.libvlc_new vlc.libvlc_playlist_play vlc.libvlc_printerr vlc.libvlc_release vlc.libvlc_renderer_discoverer_event_manager vlc.libvlc_renderer_discoverer_list_get vlc.libvlc_renderer_discoverer_list_release vlc.libvlc_renderer_discoverer_new vlc.libvlc_renderer_discoverer_release vlc.libvlc_renderer_discoverer_start vlc.libvlc_renderer_discoverer_stop vlc.libvlc_renderer_item_flags vlc.libvlc_renderer_item_hold vlc.libvlc_renderer_item_icon_uri vlc.libvlc_renderer_item_name vlc.libvlc_renderer_item_release vlc.libvlc_renderer_item_type vlc.libvlc_retain vlc.libvlc_set_app_id vlc.libvlc_set_exit_handler vlc.libvlc_set_fullscreen vlc.libvlc_set_log_verbosity vlc.libvlc_set_user_agent vlc.libvlc_title_descriptions_release vlc.libvlc_toggle_fullscreen vlc.libvlc_toggle_teletext vlc.libvlc_track_description_list_release vlc.libvlc_track_description_release vlc.libvlc_video_filter_list_get vlc.libvlc_video_get_adjust_float vlc.libvlc_video_get_adjust_int vlc.libvlc_video_get_aspect_ratio vlc.libvlc_video_get_chapter_description vlc.libvlc_video_get_crop_geometry vlc.libvlc_video_get_cursor vlc.libvlc_video_get_height vlc.libvlc_video_get_logo_int vlc.libvlc_video_get_marquee_int vlc.libvlc_video_get_marquee_string vlc.libvlc_video_get_scale vlc.libvlc_video_get_size vlc.libvlc_video_get_spu vlc.libvlc_video_get_spu_count vlc.libvlc_video_get_spu_delay vlc.libvlc_video_get_spu_description vlc.libvlc_video_get_teletext vlc.libvlc_video_get_title_description vlc.libvlc_video_get_track vlc.libvlc_video_get_track_count vlc.libvlc_video_get_track_description vlc.libvlc_video_get_width vlc.libvlc_video_new_viewpoint vlc.libvlc_video_set_adjust_float vlc.libvlc_video_set_adjust_int vlc.libvlc_video_set_aspect_ratio vlc.libvlc_video_set_callbacks vlc.libvlc_video_set_crop_geometry vlc.libvlc_video_set_deinterlace vlc.libvlc_video_set_format vlc.libvlc_video_set_format_callbacks vlc.libvlc_video_set_key_input vlc.libvlc_video_set_logo_int vlc.libvlc_video_set_logo_string vlc.libvlc_video_set_marquee_int vlc.libvlc_video_set_marquee_string vlc.libvlc_video_set_mouse_input vlc.libvlc_video_set_scale vlc.libvlc_video_set_spu vlc.libvlc_video_set_spu_delay vlc.libvlc_video_set_subtitle_file vlc.libvlc_video_set_teletext vlc.libvlc_video_set_track vlc.libvlc_video_take_snapshot vlc.libvlc_video_update_viewpoint vlc.libvlc_vlm_add_broadcast vlc.libvlc_vlm_add_input vlc.libvlc_vlm_add_vod vlc.libvlc_vlm_change_media vlc.libvlc_vlm_del_media vlc.libvlc_vlm_get_event_manager vlc.libvlc_vlm_get_media_instance_length vlc.libvlc_vlm_get_media_instance_position vlc.libvlc_vlm_get_media_instance_rate vlc.libvlc_vlm_get_media_instance_time vlc.libvlc_vlm_pause_media vlc.libvlc_vlm_play_media vlc.libvlc_vlm_release vlc.libvlc_vlm_seek_media vlc.libvlc_vlm_set_enabled vlc.libvlc_vlm_set_input vlc.libvlc_vlm_set_loop vlc.libvlc_vlm_set_mux vlc.libvlc_vlm_set_output vlc.libvlc_vlm_show_media vlc.libvlc_vlm_stop_media vlc.libvlc_vprinterr vlc.libvlc_wait vlc.module_description_list vlc.print_python vlc.print_version vlc.str_to_bytes vlc.string_result vlc.track_description_list vlc.try_fspath Module Contents --------------- .. py:data:: DEFAULT_ENCODING :value: 'utf-8' .. py:data:: FILE_ptr .. py:data:: LibvlcSetExitHandlerCb .. py:data:: Log_ptr .. py:data:: PyFile_AsFd .. py:data:: PyFile_FromFd .. py:function:: _Cfunction(name, flags, errcheck, *types) (INTERNAL) New ctypes function binding. .. py:data:: _Cfunctions .. py:function:: _Cobject(cls, ctype) (INTERNAL) New instance from ctypes. .. py:function:: _Constructor(cls, ptr=_internal_guard) (INTERNAL) New wrapper from ctypes. .. py:data:: _Globals .. py:data:: _Ints .. py:data:: _Seqs .. py:data:: _default_instance :value: None .. py:function:: _dot2int(v) (INTERNAL) Convert 'i.i.i[.i]' str to int. .. py:data:: _internal_guard .. py:data:: build_date :value: 'Mon Oct 7 16:36:40 2024 3.0.21' .. py:function:: bytes_to_str(b) Translate bytes to string. .. py:function:: callbackmethod(callback) Now obsolete ``@callbackmethod`` decorator. .. py:data:: cb .. py:function:: class_result(classname) Errcheck function. Returns a function that creates the specified class. .. py:function:: debug_callback(event, *args, **kwds) Example callback, useful for debugging. .. py:function:: find_lib() .. py:function:: get_default_instance() Returns the default :class:`Instance`. .. py:function:: getch() .. py:function:: hex_version() Return the version of these bindings in hex or 0 if unavailable. .. py:function:: len_args(func) Return number of positional arguments. .. py:data:: libc_path :value: None .. py:function:: libvlc_add_intf(p_instance, name) Try to start a user interface for the libvlc instance. :param p_instance: the instance. :param name: interface name, or None for default. :return: 0 on success, -1 on error. .. py:function:: libvlc_audio_equalizer_get_amp_at_index(p_equalizer, u_band) Get the amplification value for a particular equalizer frequency band. :param p_equalizer: valid equalizer handle, must not be None. :param u_band: index, counting from zero, of the frequency band to get. :return: amplification value (Hz); NaN if there is no such frequency band. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_get_band_count() Get the number of distinct frequency bands for an equalizer. :return: number of frequency bands. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_get_band_frequency(u_index) Get a particular equalizer band frequency. This value can be used, for example, to create a label for an equalizer band control in a user interface. :param u_index: index of the band, counting from zero. :return: equalizer band frequency (Hz), or -1 if there is no such band. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_get_preamp(p_equalizer) Get the current pre-amplification value from an equalizer. :param p_equalizer: valid equalizer handle, must not be None. :return: preamp value (Hz). :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_get_preset_count() Get the number of equalizer presets. :return: number of presets. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_get_preset_name(u_index) Get the name of a particular equalizer preset. This name can be used, for example, to prepare a preset label or menu in a user interface. :param u_index: index of the preset, counting from zero. :return: preset name, or None if there is no such preset. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_new() Create a new default equalizer, with all frequency values zeroed. The new equalizer can subsequently be applied to a media player by invoking :func:`libvlc_media_player_set_equalizer`. The returned handle should be freed via :func:`libvlc_audio_equalizer_release` when it is no longer needed. :return: opaque equalizer handle, or None on error. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_new_from_preset(u_index) Create a new equalizer, with initial frequency values copied from an existing preset. The new equalizer can subsequently be applied to a media player by invoking :func:`libvlc_media_player_set_equalizer`. The returned handle should be freed via :func:`libvlc_audio_equalizer_release` when it is no longer needed. :param u_index: index of the preset, counting from zero. :return: opaque equalizer handle, or None on error. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_release(p_equalizer) Release a previously created equalizer instance. The equalizer was previously created by using :func:`libvlc_audio_equalizer_new` or :func:`libvlc_audio_equalizer_new_from_preset`. It is safe to invoke this method with a None *p_equalizer* parameter for no effect. :param p_equalizer: opaque equalizer handle, or None. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_set_amp_at_index(p_equalizer, f_amp, u_band) Set a new amplification value for a particular equalizer frequency band. The new equalizer settings are subsequently applied to a media player by invoking :func:`libvlc_media_player_set_equalizer`. The supplied amplification value will be clamped to the -20.0 to +20.0 range. :param p_equalizer: valid equalizer handle, must not be None. :param f_amp: amplification value (-20.0 to 20.0 Hz). :param u_band: index, counting from zero, of the frequency band to set. :return: zero on success, -1 on error. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_equalizer_set_preamp(p_equalizer, f_preamp) Set a new pre-amplification value for an equalizer. The new equalizer settings are subsequently applied to a media player by invoking :func:`libvlc_media_player_set_equalizer`. The supplied amplification value will be clamped to the -20.0 to +20.0 range. :param p_equalizer: valid equalizer handle, must not be None. :param f_preamp: preamp value (-20.0 to 20.0 Hz). :return: zero on success, -1 on error. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_filter_list_get(p_instance) Returns a list of audio filters that are available. See :class:`ModuleDescription` See :func:`libvlc_module_description_list_release`. :param p_instance: libvlc instance. :return: a list of module descriptions. It should be freed with :func:`libvlc_module_description_list_release`. In case of an error, None is returned. .. py:function:: libvlc_audio_get_channel(p_mi) Get current audio channel. :param p_mi: media player. :return: the audio channel See :class:`AudioOutputChannel`. .. py:function:: libvlc_audio_get_delay(p_mi) Get current audio delay. :param p_mi: media player. :return: the audio delay (microseconds). :version: LibVLC 1.1.1 or later. .. py:function:: libvlc_audio_get_mute(p_mi) Get current mute status. :param p_mi: media player. :return: the mute status (boolean) if defined, -1 if undefined/unapplicable. .. py:function:: libvlc_audio_get_track(p_mi) Get current audio track. :param p_mi: media player. :return: the audio track ID or -1 if no active input. .. py:function:: libvlc_audio_get_track_count(p_mi) Get number of available audio tracks. :param p_mi: media player. :return: the number of available audio tracks (int), or -1 if unavailable. .. py:function:: libvlc_audio_get_track_description(p_mi) Get the description of available audio tracks. :param p_mi: media player. :return: list with description of available audio tracks, or None. It must be freed with :func:`libvlc_track_description_list_release`. .. py:function:: libvlc_audio_get_volume(p_mi) Get current software audio volume. :param p_mi: media player. :return: the software volume in percents. (0 = mute, 100 = nominal / 0dB). .. py:function:: libvlc_audio_output_device_count(p_instance, psz_audio_output) Backward compatibility stub. Do not use in new code. .. warning:: **Deprecated!** Use :func:`libvlc_audio_output_device_list_get` instead. :return: always 0. .. py:function:: libvlc_audio_output_device_enum(mp) Gets a list of potential audio output devices, See :func:`libvlc_audio_output_device_set`. .. note:: Not all audio outputs support enumerating devices. The audio output may be functional even if the list is empty (None). .. note:: The list may not be exhaustive. .. warning:: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. :param mp: media player. :return: A None-terminated linked list of potential audio output devices. It must be freed with :func:`libvlc_audio_output_device_list_release`. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_audio_output_device_get(mp) Get the current audio output device identifier. This complements :func:`libvlc_audio_output_device_set`. .. warning:: The initial value for the current audio output device identifier may not be set or may be some unknown value. A LibVLC application should compare this value against the known device identifiers (e.g. those that were previously retrieved by a call to :func:`libvlc_audio_output_device_enum` or libvlc_audio_output_device_list_get) to find the current audio output device. It is possible that the selected audio output device changes (an external change) without a call to :func:`libvlc_audio_output_device_set`. That may make this method unsuitable to use if a LibVLC application is attempting to track dynamic audio device changes as they happen. :param mp: media player. :return: the current audio output device identifier. None if no device is selected or in case of error. (the result must be released with free() or libvlc_free). :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_audio_output_device_id(p_instance, psz_audio_output, i_device) Backward compatibility stub. Do not use in new code. .. warning:: **Deprecated!** Use :func:`libvlc_audio_output_device_list_get` instead. :return: always None. .. py:function:: libvlc_audio_output_device_list_get(p_instance, aout) Gets a list of audio output devices for a given audio output module, See :func:`libvlc_audio_output_device_set`. .. note:: Not all audio outputs support this. In particular, an empty (None) list of devices does **not** imply that the specified audio output does not work. .. note:: The list might not be exhaustive. .. warning:: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. :param p_instance: libvlc instance. :param aout: audio output name. (as returned by libvlc_audio_output_list_get). :return: A None-terminated linked list of potential audio output devices. It must be freed with :func:`libvlc_audio_output_device_list_release`. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_audio_output_device_list_release(p_list) Frees a list of available audio output devices. :param p_list: list with audio outputs for release. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_audio_output_device_longname(p_instance, psz_output, i_device) Backward compatibility stub. Do not use in new code. .. warning:: **Deprecated!** Use :func:`libvlc_audio_output_device_list_get` instead. :return: always None. .. py:function:: libvlc_audio_output_device_set(mp, module, device_id) Configures an explicit audio output device. If the *module* paramater is None, audio output will be moved to the device specified by the device identifier string immediately. This is the recommended usage. A list of adequate potential device strings can be obtained with :func:`libvlc_audio_output_device_enum`. However passing None is supported in LibVLC version 2.2.0 and later only; in earlier versions, this function would have no effects when the module parameter was None. If the *module* parameter is not None, the device parameter of the corresponding audio output, if it exists, will be set to the specified string. Note that some audio output modules do not have such a parameter (notably MMDevice and PulseAudio). A list of adequate potential device strings can be obtained with :func:`libvlc_audio_output_device_list_get`. .. note:: This function does not select the specified audio output plugin. :func:`libvlc_audio_output_set` is used for that purpose. .. warning:: The syntax for the device parameter depends on the audio output. Some audio output modules require further parameters (e.g. a channels map in the case of ALSA). :param mp: media player. :param module: If None, current audio output module. if non-None, name of audio output module. (See libvlc_audio_output_t). :param device_id: device identifier string. :return: Nothing. Errors are ignored (this is a design bug). .. py:function:: libvlc_audio_output_get_device_type(p_mi) Stub for backward compatibility. :return: always -1. .. py:function:: libvlc_audio_output_list_get(p_instance) Gets the list of available audio output modules. :param p_instance: libvlc instance. :return: list of available audio outputs. It must be freed with. See :func:`libvlc_audio_output_list_release` See :class:`AudioOutput` . In case of error, None is returned. .. py:function:: libvlc_audio_output_list_release(p_list) Frees the list of available audio output modules. :param p_list: list with audio outputs for release. .. py:function:: libvlc_audio_output_set(p_mi, psz_name) Selects an audio output module. .. note:: Any change will take be effect only after playback is stopped and restarted. Audio output cannot be changed while playing. :param p_mi: media player. :param psz_name: name of audio output, use psz_name of See :class:`AudioOutput`. :return: 0 if function succeeded, -1 on error. .. py:function:: libvlc_audio_output_set_device_type(p_mp, device_type) Stub for backward compatibility. .. py:function:: libvlc_audio_set_callbacks(mp, play, pause, resume, flush, drain, opaque) Sets callbacks and private data for decoded audio. Use :func:`libvlc_audio_set_format` or :func:`libvlc_audio_set_format_callbacks` to configure the decoded audio format. .. note:: The audio callbacks override any other audio output mechanism. If the callbacks are set, LibVLC will **not** output audio in any way. :param mp: the media player. :param play: callback to play audio samples (must not be None). :param pause: callback to pause playback (or None to ignore). :param resume: callback to resume playback (or None to ignore). :param flush: callback to flush audio buffers (or None to ignore). :param drain: callback to drain audio buffers (or None to ignore). :param opaque: private pointer for the audio callbacks (as first parameter). :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_audio_set_channel(p_mi, channel) Set current audio *channel*. :param p_mi: media player. :param channel: the audio channel, See :class:`AudioOutputChannel`. :return: 0 on success, -1 on error. .. py:function:: libvlc_audio_set_delay(p_mi, i_delay) Set current audio delay. The audio delay will be reset to zero each time the media changes. :param p_mi: media player. :param i_delay: the audio delay (microseconds). :return: 0 on success, -1 on error. :version: LibVLC 1.1.1 or later. .. py:function:: libvlc_audio_set_format(mp, format, rate, channels) Sets a fixed decoded audio *format*. This only works in combination with :func:`libvlc_audio_set_callbacks`, and is mutually exclusive with :func:`libvlc_audio_set_format_callbacks`. :param mp: the media player. :param format: a four-characters string identifying the sample format. (e.g. "S16N" or "f32l"). :param rate: sample rate (expressed in Hz). :param channels: channels count. :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_audio_set_format_callbacks(mp, setup, cleanup) Sets decoded audio format via callbacks. This only works in combination with :func:`libvlc_audio_set_callbacks`. :param mp: the media player. :param setup: callback to select the audio format (cannot be None). :param cleanup: callback to release any allocated resources (or None). :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_audio_set_mute(p_mi, status) Set mute *status*. .. warning:: This function does not always work. If there are no active audio playback stream, the mute *status* might not be available. If digital pass-through (S/PDIF, HDMI...) is in use, muting may be unapplicable. Also some audio output plugins do not support muting at all. .. note:: To force silent playback, disable all audio tracks. This is more efficient and reliable than mute. :param p_mi: media player. :param status: If status is true then mute, otherwise unmute. .. py:function:: libvlc_audio_set_track(p_mi, i_track) Set current audio track. :param p_mi: media player. :param i_track: the track ID (i_id field from track description). :return: 0 on success, -1 on error. .. py:function:: libvlc_audio_set_volume(p_mi, i_volume) Set current software audio volume. :param p_mi: media player. :param i_volume: the volume in percents (0 = mute, 100 = 0dB). :return: 0 if the volume was set, -1 if it was out of range. .. py:function:: libvlc_audio_set_volume_callback(mp, set_volume) Set callbacks and private data for decoded audio. This only works in combination with :func:`libvlc_audio_set_callbacks`. Use :func:`libvlc_audio_set_format` or :func:`libvlc_audio_set_format_callbacks` to configure the decoded audio format. :param mp: the media player. :param set_volume: callback to apply audio volume, or None to apply volume in software. :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_audio_toggle_mute(p_mi) Toggle mute status. .. warning:: Toggling mute atomically is not always possible: On some platforms, other processes can mute the VLC audio playback stream asynchronously. Thus, there is a small race condition where toggling will not work. See also the limitations of :func:`libvlc_audio_set_mute`. :param p_mi: media player. .. py:function:: libvlc_chapter_descriptions_release(p_chapters, i_count) Release a chapter description :param p_chapters: chapter description array to release. :param i_count: number of chapter descriptions to release. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_clearerr() Clears the LibVLC error status for the current thread. This is optional. By default, the error status is automatically overridden when a new error occurs, and destroyed when the thread exits. .. py:function:: libvlc_clock() Return the current time as defined by LibVLC. The unit is the microsecond. Time increases monotonically (regardless of time zone changes and RTC adjustements). The origin is arbitrary but consistent across the whole system (e.g. the system uptim, the time since the system was booted). .. note:: On systems that support it, the POSIX monotonic clock is used. .. py:function:: libvlc_dialog_dismiss(p_id) Dismiss a dialog After this call, *p_id* won't be valid anymore See :class:`DialogCbs`.pf_cancel :param p_id: id of the dialog. :return: 0 on success, or -1 on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_dialog_get_context(p_id) Return the opaque pointer associated with the dialog id :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_dialog_post_action(p_id, i_action) Post a question answer After this call, *p_id* won't be valid anymore See :class:`DialogCbs`.pf_display_question :param p_id: id of the dialog. :param i_action: 1 for action1, 2 for action2. :return: 0 on success, or -1 on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_dialog_post_login(p_id, psz_username, psz_password, b_store) Post a login answer After this call, *p_id* won't be valid anymore See :class:`DialogCbs`.pf_display_login :param p_id: id of the dialog. :param psz_username: valid and non empty string. :param psz_password: valid string (can be empty). :param b_store: if true, store the credentials. :return: 0 on success, or -1 on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_dialog_set_callbacks(p_instance, p_cbs, p_data) Register callbacks in order to handle VLC dialogs :param p_cbs: a pointer to callbacks, or None to unregister callbacks. :param p_data: opaque pointer for the callback. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_dialog_set_context(p_id, p_context) Associate an opaque pointer with the dialog id :version: LibVLC 3.0.0 and later. .. py:function:: 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). .. warning:: This will be None if there was no error. .. py:function:: libvlc_event_attach(p_event_manager, i_event_type, f_callback, user_data) Register for an event notification. :param 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. :param i_event_type: the desired event to which we want to listen. :param f_callback: the function to call when i_event_type occurs. :param user_data: user provided data to carry with the event. :return: 0 on success, ENOMEM on error. .. py:function:: libvlc_event_detach(p_event_manager, i_event_type, f_callback, p_user_data) Unregister an event notification. :param p_event_manager: the event manager. :param i_event_type: the desired event to which we want to unregister. :param f_callback: the function to call when i_event_type occurs. :param p_user_data: user provided data to carry with the event. .. py:function:: libvlc_event_type_name(event_type) Get an event's type name. :param event_type: the desired event. .. py:function:: libvlc_free(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. :param ptr: the pointer. .. py:function:: libvlc_get_changeset() Retrieve libvlc changeset. Example: "aa9bce0bc4" :return: a string containing the libvlc changeset. .. py:function:: libvlc_get_compiler() Retrieve libvlc compiler version. Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)" :return: a string containing the libvlc compiler version. .. py:function:: libvlc_get_fullscreen(p_mi) Get current fullscreen status. :param p_mi: the media player. :return: the fullscreen status (boolean). .. py:function:: libvlc_get_log_verbosity(p_instance) Always returns minus one. This function is only provided for backward compatibility. :param p_instance: ignored. :return: always -1. .. py:function:: libvlc_get_version() Retrieve libvlc version. Example: "1.1.0-git The Luggage" :return: a string containing the libvlc version. .. py:function:: libvlc_hex_version() Return the libvlc version in hex or 0 if unavailable. .. py:function:: libvlc_log_clear(p_log) This function does nothing. It is only provided for backward compatibility. :param p_log: ignored. .. py:function:: libvlc_log_close(p_log) Frees memory allocated by :func:`libvlc_log_open`. :param p_log: libvlc log instance or None. .. py:function:: libvlc_log_count(p_log) Always returns zero. This function is only provided for backward compatibility. :param p_log: ignored. :return: always zero. .. py:function:: libvlc_log_get_context(ctx, module, file) Gets log message debug infos. This function retrieves self-debug information about a log message: * the name of the VLC *module* emitting the message, * the name of the source code *module* (i.e. *file*) and * the *line* number within the source code *module*. The returned *module* name and *file* name will be None if unknown. The returned *line* number will similarly be zero if unknown. .. warning:: The returned *module* name and source code *file* name, if non-None, are only valid until the logging callback returns. :param ctx: message context (as passed to the :class:`LogCb` callback). :param module: module name storage (or None) [OUT]. :param file: source code file name storage (or None) [OUT]. :param line: source code file line number storage (or None) [OUT]. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_log_get_iterator(p_log) This function does nothing useful. It is only provided for backward compatibility. :param p_log: ignored. :return: an unique pointer or None on error or if the parameter was None. .. py:function:: libvlc_log_get_object(ctx, name, header, id) Gets log message info. This function retrieves meta-information about a log message: * the type *name* of the VLC object emitting the message, * the object *header* if any, and * a temporaly-unique object identifier. This information is mainly meant for **manual** troubleshooting. The returned type *name* may be "generic" if unknown, but it cannot be None. The returned *header* will be None if unset; in current versions, the header is used to distinguish for VLM inputs. The returned object ID will be zero if the message is not associated with any VLC object. .. warning:: The returned module *name* and source code file *name*, if non-None, are only valid until the logging callback returns. :param ctx: message context (as passed to the :class:`LogCb` callback). :param name: object name storage (or None) [OUT]. :param header: object header (or None) [OUT]. :param line: source code file line number storage (or None) [OUT]. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_log_iterator_free(p_iter) Frees memory allocated by :func:`libvlc_log_get_iterator`. :param p_iter: libvlc log iterator or None. .. py:function:: libvlc_log_iterator_has_next(p_iter) Always returns zero. This function is only provided for backward compatibility. :param p_iter: ignored. :return: always zero. .. py:function:: libvlc_log_iterator_next(p_iter, p_buf) Always returns None. This function is only provided for backward compatibility. :param p_iter: libvlc log iterator or None. :param p_buf: ignored. :return: always None. .. py:function:: libvlc_log_open(p_instance) This function does nothing useful. It is only provided for backward compatibility. :param p_instance: libvlc instance. :return: an unique pointer or None on error. .. py:function:: libvlc_log_set(p_instance, cb, data) Sets the logging callback for a LibVLC instance. This function is thread-safe: it will wait for any pending callbacks invocation to complete. .. note:: Some log messages (especially debug) are emitted by LibVLC while is being initialized. These messages cannot be captured with this interface. .. warning:: A deadlock may occur if this function is called from the callback. :param cb: callback function pointer. :param data: opaque data pointer for the callback function. :param p_instance: libvlc instance. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_log_set_file(p_instance, stream) Sets up logging to a file. :param p_instance: libvlc instance. :param stream: FILE pointer opened for writing. (the FILE pointer must remain valid until libvlc_log_unset). :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_log_unset(p_instance) Unsets the logging callback. This function deregisters the logging callback for a LibVLC instance. This is rarely needed as the callback is implicitly unset when the instance is destroyed. .. note:: This function will wait for any pending callbacks invocation to complete (causing a deadlock if called from within the callback). :param p_instance: libvlc instance. :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_media_add_option(p_md, psz_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. .. note:: The options are listed in 'vlc --long-help' from the command line, e.g. "-sout-all". Keep in mind that available options and their semantics vary across LibVLC versions and builds. .. warning:: Not all options affects :class:`Media` objects: Specifically, due to architectural issues most audio and video options, such as text renderer options, have no effects on an individual media. These options must be set through :func:`libvlc_new` instead. :param p_md: the media descriptor. :param psz_options: the options (as a string). .. py:function:: libvlc_media_add_option_flag(p_md, psz_options, 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". Note that all options are not usable on medias: specifically, due to architectural issues, video-related options such as text renderer options cannot be set on a single media. They must be set on the whole libvlc instance instead. :param p_md: the media descriptor. :param psz_options: the options (as a string). :param i_flags: the flags for this option. .. py:function:: libvlc_media_discoverer_event_manager(p_mdis) Get event manager from media service discover object. .. warning:: **Deprecated!** Useless, media_discoverer events are only triggered when calling :func:`libvlc_media_discoverer_start` and :func:`libvlc_media_discoverer_stop`. :param p_mdis: media service discover object. :return: event manager object. .. py:function:: libvlc_media_discoverer_is_running(p_mdis) Query if media service discover object is running. :param p_mdis: media service discover object. :return: true if running, false if not. .. py:function:: libvlc_media_discoverer_list_get(p_inst, i_cat, ppp_services) Get media discoverer services by category :param p_inst: libvlc instance. :param i_cat: category of services to fetch. :param ppp_services: address to store an allocated array of media discoverer. services (must be freed with :func:`libvlc_media_discoverer_list_release` by. the caller) [OUT]. :return: the number of media discoverer services (0 on error). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_discoverer_list_release(pp_services, i_count) Release an array of media discoverer services See :func:`libvlc_media_discoverer_list_get` :param pp_services: array to release. :param i_count: number of elements in the array. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_discoverer_localized_name(p_mdis) Get media service discover object its localized name. .. warning:: **Deprecated!** Useless, use :func:`libvlc_media_discoverer_list_get` to get the longname of the service discovery. :param p_mdis: media discover object. :return: localized name or None if the media_discoverer is not started. .. py:function:: libvlc_media_discoverer_media_list(p_mdis) Get media service discover media list. :param p_mdis: media service discover object. :return: list of media items. .. py:function:: libvlc_media_discoverer_new(p_inst, psz_name) Create a media discoverer object by name. After this object is created, you should attach to media_list events in order to be notified of new items discovered. You need to call :func:`libvlc_media_discoverer_start` in order to start the discovery. See :func:`libvlc_media_discoverer_media_list` See :func:`libvlc_media_discoverer_event_manager` See :func:`libvlc_media_discoverer_start` :param p_inst: libvlc instance. :param psz_name: service name; use :func:`libvlc_media_discoverer_list_get` to get. a list of the discoverer names available in this libVLC instance. :return: media discover object or None in case of error. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_discoverer_new_from_name(p_inst, psz_name) .. warning:: **Deprecated!** Use :func:`libvlc_media_discoverer_new` and :func:`libvlc_media_discoverer_start`. .. py:function:: libvlc_media_discoverer_release(p_mdis) Release media discover object. If the reference count reaches 0, then the object will be released. :param p_mdis: media service discover object. .. py:function:: libvlc_media_discoverer_start(p_mdis) Start media discovery. To stop it, call :func:`libvlc_media_discoverer_stop` or :func:`libvlc_media_discoverer_list_release` directly. See :func:`libvlc_media_discoverer_stop` :param p_mdis: media discover object. :return: -1 in case of error, 0 otherwise. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_discoverer_stop(p_mdis) Stop media discovery. See :func:`libvlc_media_discoverer_start` :param p_mdis: media discover object. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_duplicate(p_md) Duplicate a media descriptor object. :param p_md: a media descriptor object. .. py:function:: libvlc_media_event_manager(p_md) Get event manager from media descriptor object. NOTE: this function doesn't increment reference counting. :param p_md: a media descriptor object. :return: event manager object. .. py:function:: libvlc_media_get_codec_description(i_type, i_codec) Get codec description from media elementary stream See :class:`MediaTrack` :param i_type: i_type from :class:`MediaTrack`. :param i_codec: i_codec or i_original_fourcc from :class:`MediaTrack`. :return: codec description. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_get_duration(p_md) Get duration (in ms) of media descriptor object item. :param p_md: media descriptor object. :return: duration of media item or -1 on error. .. py:function:: libvlc_media_get_meta(p_md, e_meta) Read the meta of the media. If the media has not yet been parsed this will return None. See :func:`libvlc_media_parse` See :func:`libvlc_media_parse_with_options` See libvlc_MediaMetaChanged :param p_md: the media descriptor. :param e_meta: the meta to read. :return: the media's meta. .. py:function:: libvlc_media_get_mrl(p_md) Get the media resource locator (mrl) from a media descriptor object :param p_md: a media descriptor object. :return: string with mrl of media descriptor object. .. py:function:: libvlc_media_get_parsed_status(p_md) Get Parsed status for media descriptor object. See libvlc_MediaParsedChanged See :class:`MediaParsedStatus` :param p_md: media descriptor object. :return: a value of the :class:`MediaParsedStatus` enum. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_get_state(p_md) Get current state of media descriptor object. Possible media states are libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused, libvlc_Stopped, libvlc_Ended, libvlc_Error. See :class:`State`. :param p_md: a media descriptor object. :return: state of media descriptor object. .. py:function:: libvlc_media_get_stats(p_md, p_stats) Get the current statistics about the media. :param p_md:: media descriptor object. :param p_stats:: structure that contain the statistics about the media. (this structure must be allocated by the caller). :return: true if the statistics are available, false otherwise. .. py:function:: libvlc_media_get_tracks_info(p_md) Get media descriptor's elementary streams description Note, you need to call :func:`libvlc_media_parse` or play the media at least once before calling this function. Not doing this will result in an empty array. .. warning:: **Deprecated!** Use :func:`libvlc_media_tracks_get` instead :param p_md: media descriptor object. :param tracks: address to store an allocated array of Elementary Streams. descriptions (must be freed by the caller) [OUT]. :return: the number of Elementary Streams. .. py:function:: libvlc_media_get_type(p_md) Get the media type of the media descriptor object See :class:`MediaType` :param p_md: media descriptor object. :return: media type. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_get_user_data(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 :class:`Media` pointer :param p_md: media descriptor object. .. py:function:: libvlc_media_is_parsed(p_md) Return true is the media descriptor object is parsed .. warning:: **Deprecated!** This can return true in case of failure. Use :func:`libvlc_media_get_parsed_status` instead See libvlc_MediaParsedChanged :param p_md: media descriptor object. :return: true if media object has been parsed otherwise it returns false. .. py:function:: libvlc_media_library_load(p_mlib) Load media library. :param p_mlib: media library object. :return: 0 on success, -1 on error. .. py:function:: libvlc_media_library_media_list(p_mlib) Get media library subitems. :param p_mlib: media library object. :return: media list subitems. .. py:function:: libvlc_media_library_new(p_instance) Create an new Media Library object :param p_instance: the libvlc instance. :return: a new object or None on error. .. py:function:: libvlc_media_library_release(p_mlib) Release media library object. This functions decrements the reference count of the media library object. If it reaches 0, then the object will be released. :param p_mlib: media library object. .. py:function:: libvlc_media_library_retain(p_mlib) Retain a reference to a media library object. This function will increment the reference counting for this object. Use :func:`libvlc_media_library_release` to decrement the reference count. :param p_mlib: media library object. .. py:function:: libvlc_media_list_add_media(p_ml, p_md) Add media instance to media list The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :param p_md: a media instance. :return: 0 on success, -1 if the media list is read-only. .. py:function:: libvlc_media_list_count(p_ml) Get count on media list items The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :return: number of items in media list. .. py:function:: libvlc_media_list_event_manager(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 :param p_ml: a media list instance. :return: libvlc_event_manager. .. py:function:: libvlc_media_list_index_of_item(p_ml, p_md) Find index position of List media instance in media list. Warning: the function will return the first matched position. The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :param p_md: media instance. :return: position of media instance or -1 if media not found. .. py:function:: libvlc_media_list_insert_media(p_ml, p_md, i_pos) Insert media instance in media list on a position The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :param p_md: a media instance. :param i_pos: position in array where to insert. :return: 0 on success, -1 if the media list is read-only. .. py:function:: libvlc_media_list_is_readonly(p_ml) This indicates if this media list is read-only from a user point of view :param p_ml: media list instance. :return: 1 on readonly, 0 on readwrite. .. py:function:: libvlc_media_list_item_at_index(p_ml, i_pos) List media instance in media list at a position The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :param i_pos: position in array where to insert. :return: media instance at position *i_pos*, or None if not found. In case of success, :func:`libvlc_media_retain` is called to increase the refcount. on the media. .. py:function:: libvlc_media_list_lock(p_ml) Get lock on media list items :param p_ml: a media list instance. .. py:function:: libvlc_media_list_media(p_ml) Get media instance from this media list instance. This action will increase the refcount on the media instance. The :func:`libvlc_media_list_lock` should NOT be held upon entering this function. :param p_ml: a media list instance. :return: media instance. .. py:function:: libvlc_media_list_new(p_instance) Create an empty media list. :param p_instance: libvlc instance. :return: empty media list, or None on error. .. py:function:: libvlc_media_list_player_event_manager(p_mlp) Return the event manager of this media_list_player. :param p_mlp: media list player instance. :return: the event manager. .. py:function:: libvlc_media_list_player_get_media_player(p_mlp) Get media player of the media_list_player instance. .. note:: the caller is responsible for releasing the returned instance. :param p_mlp: media list player instance. :return: media player instance. .. py:function:: libvlc_media_list_player_get_state(p_mlp) Get current libvlc_state of media list player :param p_mlp: media list player instance. :return: :class:`State` for media list player. .. py:function:: libvlc_media_list_player_is_playing(p_mlp) Is media list playing? :param p_mlp: media list player instance. :return: true for playing and false for not playing. .. py:function:: libvlc_media_list_player_new(p_instance) Create new media_list_player. :param p_instance: libvlc instance. :return: media list player instance or None on error. .. py:function:: libvlc_media_list_player_next(p_mlp) Play next item from media list :param p_mlp: media list player instance. :return: 0 upon success -1 if there is no next item. .. py:function:: libvlc_media_list_player_pause(p_mlp) Toggle pause (or resume) media list :param p_mlp: media list player instance. .. py:function:: libvlc_media_list_player_play(p_mlp) Play media list :param p_mlp: media list player instance. .. py:function:: libvlc_media_list_player_play_item(p_mlp, p_md) Play the given media item :param p_mlp: media list player instance. :param p_md: the media instance. :return: 0 upon success, -1 if the media is not part of the media list. .. py:function:: libvlc_media_list_player_play_item_at_index(p_mlp, i_index) Play media list item at position index :param p_mlp: media list player instance. :param i_index: index in media list to play. :return: 0 upon success -1 if the item wasn't found. .. py:function:: libvlc_media_list_player_previous(p_mlp) Play previous item from media list :param p_mlp: media list player instance. :return: 0 upon success -1 if there is no previous item. .. py:function:: libvlc_media_list_player_release(p_mlp) Release a media_list_player after use Decrement the reference count of a media player object. If the reference count is 0, then :func:`libvlc_media_list_player_release` will release the media player object. If the media player object has been released, then it should not be used again. :param p_mlp: media list player instance. .. py:function:: libvlc_media_list_player_retain(p_mlp) Retain a reference to a media player list object. Use :func:`libvlc_media_list_player_release` to decrement reference count. :param p_mlp: media player list object. .. py:function:: libvlc_media_list_player_set_media_list(p_mlp, p_mlist) Set the media list associated with the player :param p_mlp: media list player instance. :param p_mlist: list of media. .. py:function:: libvlc_media_list_player_set_media_player(p_mlp, p_mi) Replace media player in media_list_player with this instance. :param p_mlp: media list player instance. :param p_mi: media player instance. .. py:function:: libvlc_media_list_player_set_pause(p_mlp, do_pause) Pause or resume media list :param p_mlp: media list player instance. :param do_pause: play/resume if zero, pause if non-zero. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_list_player_set_playback_mode(p_mlp, e_mode) Sets the playback mode for the playlist :param p_mlp: media list player instance. :param e_mode: playback mode specification. .. py:function:: libvlc_media_list_player_stop(p_mlp) Stop playing media list :param p_mlp: media list player instance. .. py:function:: libvlc_media_list_release(p_ml) Release media list created with :func:`libvlc_media_list_new`. :param p_ml: a media list created with :func:`libvlc_media_list_new`. .. py:function:: libvlc_media_list_remove_index(p_ml, i_pos) Remove media instance from media list on a position The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. :param i_pos: position in array where to insert. :return: 0 on success, -1 if the list is read-only or the item was not found. .. py:function:: libvlc_media_list_retain(p_ml) Retain reference to a media list :param p_ml: a media list created with :func:`libvlc_media_list_new`. .. py:function:: libvlc_media_list_set_media(p_ml, p_md) Associate media instance with this media list instance. If another media instance was present it will be released. The :func:`libvlc_media_list_lock` should NOT be held upon entering this function. :param p_ml: a media list instance. :param p_md: media instance to add. .. py:function:: libvlc_media_list_unlock(p_ml) Release lock on media list items The :func:`libvlc_media_list_lock` should be held upon entering this function. :param p_ml: a media list instance. .. py:function:: libvlc_media_new_as_node(p_instance, psz_name) Create a media as an empty node with a given name. See :func:`libvlc_media_release` :param p_instance: the instance. :param psz_name: the name of the node. :return: the new empty media or None on error. .. py:function:: libvlc_media_new_callbacks(instance, open_cb, read_cb, seek_cb, close_cb, opaque) Create a media with custom callbacks to read the data from. .. note:: If *open_cb* is None, the *opaque* pointer will be passed to *read_cb*, *seek_cb* and *close_cb*, and the stream size will be treated as unknown. .. note:: The callbacks may be called asynchronously (from another thread). A single stream *instance* need not be reentrant. However the *open_cb* needs to be reentrant if the media is used by multiple player instances. .. warning:: The callbacks may be used until all or any player instances that were supplied the media item are stopped. See :func:`libvlc_media_release` :param instance: LibVLC instance. :param open_cb: callback to open the custom bitstream input media. :param read_cb: callback to read data (must not be None). :param seek_cb: callback to seek, or None if seeking is not supported. :param close_cb: callback to close the media, or None if unnecessary. :param opaque: data pointer for the open callback. :return: the newly created media or None on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_new_fd(p_instance, fd) Create a media for an already open file descriptor. The file descriptor shall be open for reading (or reading and writing). Regular file descriptors, pipe read descriptors and character device descriptors (including TTYs) are supported on all platforms. Block device descriptors are supported where available. Directory descriptors are supported on systems that provide fdopendir(). Sockets are supported on all platforms where they are file descriptors, i.e. all except Windows. .. note:: This library will **not** automatically close the file descriptor under any circumstance. Nevertheless, a file descriptor can usually only be rendered once in a media player. To render it a second time, the file descriptor should probably be rewound to the beginning with lseek(). See :func:`libvlc_media_release` :param p_instance: the instance. :param fd: open file descriptor. :return: the newly created media or None on error. :version: LibVLC 1.1.5 and later. .. py:function:: libvlc_media_new_location(p_instance, psz_mrl) Create a media with a certain given media resource location, for instance a valid URL. .. note:: To refer to a local file with this function, the file://... URI syntax **must** be used (see IETF RFC3986). We recommend using :func:`libvlc_media_new_path` instead when dealing with local files. See :func:`libvlc_media_release` :param p_instance: the instance. :param psz_mrl: the media location. :return: the newly created media or None on error. .. py:function:: libvlc_media_new_path(p_instance, path) Create a media for a certain file *path*. See :func:`libvlc_media_release` :param p_instance: the instance. :param path: local filesystem path. :return: the newly created media or None on error. .. py:function:: libvlc_media_parse(p_md) Parse a media. This fetches (local) art, meta data and tracks information. The method is synchronous. .. warning:: **Deprecated!** This function could block indefinitely. Use :func:`libvlc_media_parse_with_options` instead See :func:`libvlc_media_parse_with_options` See :func:`libvlc_media_get_meta` See :func:`libvlc_media_get_tracks_info` :param p_md: media descriptor object. .. py:function:: libvlc_media_parse_async(p_md) Parse a media. This fetches (local) art, meta data and tracks information. The method is the asynchronous of :func:`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. .. warning:: **Deprecated!** You can't be sure to receive the libvlc_MediaParsedChanged event (you can wait indefinitely for this event). Use :func:`libvlc_media_parse_with_options` instead See :func:`libvlc_media_parse` See libvlc_MediaParsedChanged See :func:`libvlc_media_get_meta` See :func:`libvlc_media_get_tracks_info` :param p_md: media descriptor object. .. py:function:: libvlc_media_parse_stop(p_md) Stop the parsing of the media When the media parsing is stopped, the libvlc_MediaParsedChanged event will be sent with the libvlc_media_parsed_status_timeout status. See :func:`libvlc_media_parse_with_options` :param p_md: media descriptor object. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_parse_with_options(p_md, parse_flag, timeout) Parse the media asynchronously with options. This fetches (local or network) art, meta data and/or tracks information. This method is the extended version of :func:`libvlc_media_parse_with_options`. To track when this is over you can listen to libvlc_MediaParsedChanged event. However if this functions returns an error, you will not receive any events. It uses a flag to specify parse options (see libvlc_media_parse_flag_t). All these flags can be combined. By default, media is parsed if it's a local file. .. note:: Parsing can be aborted with :func:`libvlc_media_parse_stop`. See libvlc_MediaParsedChanged See :func:`libvlc_media_get_meta` See :func:`libvlc_media_tracks_get` See :func:`libvlc_media_get_parsed_status` See :class:`MediaParseFlag` :param p_md: media descriptor object. :param parse_flag: parse options: :param timeout: maximum time allowed to preparse the media. If -1, the. default "preparse-timeout" option will be used as a timeout. If 0, it will. wait indefinitely. If > 0, the timeout will be used (in milliseconds). :return: -1 in case of error, 0 otherwise. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_player_add_slave(p_mi, i_type, psz_uri, b_select) Add a slave to the current media player. .. note:: If the player is playing, the slave will be added directly. This call will also update the slave list of the attached :class:`Media`. See :func:`libvlc_media_slaves_add` :param p_mi: the media player. :param i_type: subtitle or audio. :param psz_uri: Uri of the slave (should contain a valid scheme). :param b_select: True if this slave should be selected when it's loaded. :return: 0 on success, -1 on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_can_pause(p_mi) Can this media player be paused? :param p_mi: the media player. :return: true if the media player can pause. .. py:function:: libvlc_media_player_event_manager(p_mi) Get the Event Manager from which the media player send event. :param p_mi: the Media Player. :return: the event manager associated with p_mi. .. py:function:: libvlc_media_player_get_agl(p_mi) .. warning:: **Deprecated!** Use :func:`libvlc_media_player_get_nsobject` instead. .. py:function:: libvlc_media_player_get_chapter(p_mi) Get movie chapter. :param p_mi: the Media Player. :return: chapter number currently playing, or -1 if there is no media. .. py:function:: libvlc_media_player_get_chapter_count(p_mi) Get movie chapter count :param p_mi: the Media Player. :return: number of chapters in movie, or -1. .. py:function:: libvlc_media_player_get_chapter_count_for_title(p_mi, i_title) Get title chapter count :param p_mi: the Media Player. :param i_title: title. :return: number of chapters in title, or -1. .. py:function:: libvlc_media_player_get_fps(p_mi) Get movie fps rate This function is provided for backward compatibility. It cannot deal with multiple video tracks. In LibVLC versions prior to 3.0, it would also fail if the file format did not convey the frame rate explicitly. .. warning:: **Deprecated!** Consider using :func:`libvlc_media_tracks_get` instead. :param p_mi: the Media Player. :return: frames per second (fps) for this playing movie, or 0 if unspecified. .. py:function:: libvlc_media_player_get_full_chapter_descriptions(p_mi, i_chapters_of_title, pp_chapters) Get the full description of available chapters :param p_mi: the media player. :param i_chapters_of_title: index of the title to query for chapters (uses current title if set to -1). :param pp_chapters: address to store an allocated array of chapter descriptions. descriptions (must be freed with :func:`libvlc_chapter_descriptions_release`. by the caller) [OUT]. :return: the number of chapters (-1 on error). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_get_full_title_descriptions(p_mi, titles) Get the full description of available titles :param p_mi: the media player. :param titles: address to store an allocated array of title descriptions. descriptions (must be freed with :func:`libvlc_title_descriptions_release`. by the caller) [OUT]. :return: the number of *titles* (-1 on error). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_get_hwnd(p_mi) Get the Windows API window handle (HWND) previously set with :func:`libvlc_media_player_set_hwnd`. The handle will be returned even if LibVLC is not currently outputting any video to it. :param p_mi: the Media Player. :return: a window handle or None if there are none. .. py:function:: libvlc_media_player_get_length(p_mi) Get the current movie length (in ms). :param p_mi: the Media Player. :return: the movie length (in ms), or -1 if there is no media. .. py:function:: libvlc_media_player_get_media(p_mi) Get the media used by the media_player. :param p_mi: the Media Player. :return: the media associated with *p_mi*, or None if no. media is associated. .. py:function:: libvlc_media_player_get_nsobject(p_mi) Get the NSView handler previously set with :func:`libvlc_media_player_set_nsobject`. :param p_mi: the Media Player. :return: the NSView handler or 0 if none where set. .. py:function:: libvlc_media_player_get_position(p_mi) Get movie position as percentage between 0.0 and 1.0. :param p_mi: the Media Player. :return: movie position, or -1. in case of error. .. py:function:: libvlc_media_player_get_rate(p_mi) Get the requested movie play rate. .. warning:: Depending on the underlying media, the requested rate may be different from the real playback rate. :param p_mi: the Media Player. :return: movie play rate. .. py:function:: libvlc_media_player_get_role(p_mi) Gets the media role. :param p_mi: media player. :return: the media player role (libvlc_media_player_role_t). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_get_state(p_mi) Get current movie state :param p_mi: the Media Player. :return: the current state of the media player (playing, paused, ...) See :class:`State`. .. py:function:: libvlc_media_player_get_time(p_mi) Get the current movie time (in ms). :param p_mi: the Media Player. :return: the movie time (in ms), or -1 if there is no media. .. py:function:: libvlc_media_player_get_title(p_mi) Get movie title :param p_mi: the Media Player. :return: title number currently playing, or -1. .. py:function:: libvlc_media_player_get_title_count(p_mi) Get movie title count :param p_mi: the Media Player. :return: title number count, or -1. .. py:function:: libvlc_media_player_get_xwindow(p_mi) Get the X Window System window identifier previously set with :func:`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). :param p_mi: the Media Player. :return: an X window ID, or 0 if none where set. .. py:function:: libvlc_media_player_has_vout(p_mi) How many video outputs does this media player have? :param p_mi: the media player. :return: the number of video outputs. .. py:function:: libvlc_media_player_is_playing(p_mi) is_playing :param p_mi: the Media Player. :return: 1 if the media player is playing, 0 otherwise. .. py:function:: libvlc_media_player_is_seekable(p_mi) Is this media player seekable? :param p_mi: the media player. :return: true if the media player can seek. .. py:function:: libvlc_media_player_navigate(p_mi, navigate) Navigate through DVD Menu :param p_mi: the Media Player. :param navigate: the Navigation mode. :version: libVLC 2.0.0 or later. .. py:function:: libvlc_media_player_new(p_libvlc_instance) Create an empty Media Player object :param p_libvlc_instance: the libvlc instance in which the Media Player. should be created. :return: a new media player object, or None on error. .. py:function:: libvlc_media_player_new_from_media(p_md) Create a Media Player object from a Media :param p_md: the media. Afterwards the p_md can be safely. destroyed. :return: a new media player object, or None on error. .. py:function:: libvlc_media_player_next_chapter(p_mi) Set next chapter (if applicable) :param p_mi: the Media Player. .. py:function:: libvlc_media_player_next_frame(p_mi) Display the next frame (if supported) :param p_mi: the media player. .. py:function:: libvlc_media_player_pause(p_mi) Toggle pause (no effect if there is no media) :param p_mi: the Media Player. .. py:function:: libvlc_media_player_play(p_mi) Play :param p_mi: the Media Player. :return: 0 if playback started (and was already started), or -1 on error. .. py:function:: libvlc_media_player_previous_chapter(p_mi) Set previous chapter (if applicable) :param p_mi: the Media Player. .. py:function:: libvlc_media_player_program_scrambled(p_mi) Check if the current program is scrambled :param p_mi: the media player. :return: true if the current program is scrambled. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_media_player_release(p_mi) Release a media_player after use Decrement the reference count of a media player object. If the reference count is 0, then :func:`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. :param p_mi: the Media Player to free. .. py:function:: libvlc_media_player_retain(p_mi) Retain a reference to a media player object. Use :func:`libvlc_media_player_release` to decrement reference count. :param p_mi: media player object. .. py:function:: libvlc_media_player_set_agl(p_mi, drawable) .. warning:: **Deprecated!** Use :func:`libvlc_media_player_set_nsobject` instead. .. py:function:: libvlc_media_player_set_android_context(p_mi, p_awindow_handler) Set the android context. :param p_mi: the media player. :param p_awindow_handler: org.videolan.libvlc.AWindow jobject owned by the. org.videolan.libvlc.MediaPlayer class from the libvlc-android project. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_set_chapter(p_mi, i_chapter) Set movie chapter (if applicable). :param p_mi: the Media Player. :param i_chapter: chapter number to play. .. py:function:: libvlc_media_player_set_equalizer(p_mi, p_equalizer) Apply new equalizer settings to a media player. The equalizer is first created by invoking :func:`libvlc_audio_equalizer_new` or :func:`libvlc_audio_equalizer_new_from_preset`. It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not. Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any. If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played. Equalizer settings will automatically be applied to subsequently played media. To disable the equalizer for a media player invoke this method passing None for the p_equalizer parameter. The media player does not keep a reference to the supplied equalizer so it is safe for an application to release the equalizer reference any time after this method returns. :param p_mi: opaque media player handle. :param p_equalizer: opaque equalizer handle, or None to disable the equalizer for this media player. :return: zero on success, -1 on error. :version: LibVLC 2.2.0 or later. .. py:function:: libvlc_media_player_set_evas_object(p_mi, p_evas_object) Set the EFL Evas Object. :param p_mi: the media player. :param p_evas_object: a valid EFL Evas Object (Evas_Object). :return: -1 if an error was detected, 0 otherwise. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_player_set_hwnd(p_mi, 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. .. warning:: the HWND must have the WS_CLIPCHILDREN set in its style. :param p_mi: the Media Player. :param drawable: windows handle of the drawable. .. py:function:: libvlc_media_player_set_media(p_mi, p_md) Set the media that will be used by the media_player. If any, previous md will be released. :param p_mi: the Media Player. :param p_md: the Media. Afterwards the p_md can be safely. destroyed. .. py:function:: libvlc_media_player_set_nsobject(p_mi, 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: .. code-block:: objectivec++ @protocol VLCOpenGLVideoViewEmbedding - (void)addVoutSubview:(NSView *)view; - (void)removeVoutSubview:(NSView *)view; @end Or it can be an NSView object. If you want to use it along with Qt see the QMacCocoaViewContainer. Then the following code should work: .. code-block:: objectivec++ NSView *video = [[NSView alloc] init]; QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); libvlc_media_player_set_nsobject(mp, video); [video release]; You can find a live example in VLCVideoView in VLCKit.framework. :param p_mi: the Media Player. :param drawable: the drawable that is either an NSView or an object following. the VLCOpenGLVideoViewEmbedding protocol. .. py:function:: libvlc_media_player_set_pause(mp, do_pause) Pause or resume (no effect if there is no media) :param mp: the Media Player. :param do_pause: play/resume if zero, pause if non-zero. :version: LibVLC 1.1.1 or later. .. py:function:: libvlc_media_player_set_position(p_mi, f_pos) Set movie position as percentage between 0.0 and 1.0. This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol. :param p_mi: the Media Player. :param f_pos: the position. .. py:function:: libvlc_media_player_set_rate(p_mi, rate) Set movie play rate :param p_mi: the Media Player. :param rate: movie play rate to set. :return: -1 if an error was detected, 0 otherwise (but even then, it might. not actually work depending on the underlying media protocol). .. py:function:: libvlc_media_player_set_renderer(p_mi, p_item) Set a renderer to the media player .. note:: must be called before the first call of :func:`libvlc_media_player_play` to take effect. See :func:`libvlc_renderer_discoverer_new` :param p_mi: the Media Player. :param p_item: an item discovered by :func:`libvlc_renderer_discoverer_start`. :return: 0 on success, -1 on error. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_media_player_set_role(p_mi, role) Sets the media *role*. :param p_mi: media player. :param role: the media player role (libvlc_media_player_role_t). :return: 0 on success, -1 on error. .. py:function:: libvlc_media_player_set_time(p_mi, 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. :param p_mi: the Media Player. :param i_time: the movie time (in ms). .. py:function:: libvlc_media_player_set_title(p_mi, i_title) Set movie title :param p_mi: the Media Player. :param i_title: title number to play. .. py:function:: libvlc_media_player_set_video_title_display(p_mi, position, timeout) Set if, and how, the video title will be shown when media is played. :param p_mi: the media player. :param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed. :param timeout: title display timeout in milliseconds (ignored if libvlc_position_disable). :version: libVLC 2.1.0 or later. .. py:function:: libvlc_media_player_set_xwindow(p_mi, drawable) Set an X Window System *drawable* where the media player should render its video output. The call takes effect when the playback starts. If it is already started, it might need to be stopped before changes apply. If LibVLC was built without X11 output support, then this function has no effects. By default, LibVLC will capture input events on the video rendering area. Use :func:`libvlc_video_set_mouse_input` and :func:`libvlc_video_set_key_input` to disable that and deliver events to the parent window / to the application instead. By design, the X11 protocol delivers input events to only one recipient. .. warning:: The application must call the XInitThreads() function from Xlib before :func:`libvlc_new`, and before any call to XOpenDisplay() directly or via any other library. Failure to call XInitThreads() will seriously impede LibVLC performance. Calling XOpenDisplay() before XInitThreads() will eventually crash the process. That is a limitation of Xlib. .. note:: The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are **not** currently supported. The default X11 server is assumed, i.e. that specified in the DISPLAY environment variable. .. warning:: LibVLC can deal with invalid X11 handle errors, however some display drivers (EGL, GLX, VA and/or VDPAU) can unfortunately not. Thus the window handle must remain valid until playback is stopped, otherwise the process may abort or crash. :param p_mi: media player. :param drawable: X11 window ID. :bug: No more than one window handle per media player instance can be specified. If the media has multiple simultaneously active video tracks, extra tracks. will be rendered into external windows beyond the control of the. application. .. py:function:: libvlc_media_player_stop(p_mi) Stop (no effect if there is no media) :param p_mi: the Media Player. .. py:function:: libvlc_media_player_will_play(p_mi) Is the player able to play :param p_mi: the Media Player. :return: boolean. .. py:function:: libvlc_media_release(p_md) Decrement the reference count of a media descriptor object. If the reference count is 0, then :func:`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. :param p_md: the media descriptor. .. py:function:: libvlc_media_retain(p_md) Retain a reference to a media descriptor object (libvlc_media_t). Use :func:`libvlc_media_release` to decrement the reference count of a media descriptor object. :param p_md: the media descriptor. .. py:function:: libvlc_media_save_meta(p_md) Save the meta previously set :param p_md: the media desriptor. :return: true if the write operation was successful. .. py:function:: libvlc_media_set_meta(p_md, e_meta, psz_value) Set the meta of the media (this function will not save the meta, call :func:`libvlc_media_save_meta` in order to save the meta) :param p_md: the media descriptor. :param e_meta: the meta to write. :param psz_value: the media's meta. .. py:function:: libvlc_media_set_user_data(p_md, 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 :class:`Media` pointer :param p_md: media descriptor object. :param p_new_user_data: pointer to user data. .. py:function:: libvlc_media_slaves_add(p_md, i_type, i_priority, psz_uri) Add a slave to the current media. A slave is an external input source that may contains an additional subtitle track (like a .srt) or an additional audio track (like a .ac3). .. note:: This function must be called before the media is parsed (via libvlc_media_parse_with_options) or before the media is played (via libvlc_media_player_play) :param p_md: media descriptor object. :param i_type: subtitle or audio. :param i_priority: from 0 (low priority) to 4 (high priority). :param psz_uri: Uri of the slave (should contain a valid scheme). :return: 0 on success, -1 on error. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_slaves_clear(p_md) Clear all slaves previously added by :func:`libvlc_media_slaves_add` or internally. :param p_md: media descriptor object. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_slaves_get(p_md, ppp_slaves) Get a media descriptor's slave list The list will contain slaves parsed by VLC or previously added by :func:`libvlc_media_slaves_add`. The typical use case of this function is to save a list of slave in a database for a later use. See :func:`libvlc_media_slaves_add` :param p_md: media descriptor object. :param ppp_slaves: address to store an allocated array of slaves (must be. freed with libvlc_media_slaves_release) [OUT]. :return: the number of slaves (zero on error). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_slaves_release(pp_slaves, i_count) Release a media descriptor's slave list :param pp_slaves: slave array to release. :param i_count: number of elements in the array. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_media_subitems(p_md) Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use :func:`libvlc_media_list_release` to decrement the reference counting. :param p_md: media descriptor object. :return: list of media descriptor subitems or None. .. py:function:: libvlc_media_tracks_get(p_md, tracks) Get media descriptor's elementary streams description Note, you need to call :func:`libvlc_media_parse` or play the media at least once before calling this function. Not doing this will result in an empty array. :param p_md: media descriptor object. :param tracks: address to store an allocated array of Elementary Streams. descriptions (must be freed with :func:`libvlc_media_tracks_release`. by the caller) [OUT]. :return: the number of Elementary Streams (zero on error). :version: LibVLC 2.1.0 and later. .. py:function:: libvlc_media_tracks_release(p_tracks, i_count) Release media descriptor's elementary streams description array :param p_tracks: tracks info array to release. :param i_count: number of elements in the array. :version: LibVLC 2.1.0 and later. .. py:function:: libvlc_module_description_list_release(p_list) Release a list of module descriptions. :param p_list: the list to be released. .. py:function:: libvlc_new(argc, argv) Create and initialize a libvlc instance. This functions accept a list of "command line" arguments similar to the main(). These arguments affect the LibVLC instance default configuration. .. note:: LibVLC may create threads. Therefore, any thread-unsafe process initialization must be performed before calling :func:`libvlc_new`. In particular and where applicable: * setlocale() and textdomain(), * setenv(), unsetenv() and putenv(), * with the X11 display system, XInitThreads() (see also libvlc_media_player_set_xwindow) and * on Microsoft Windows, SetErrorMode(). * sigprocmask() shall never be invoked; pthread_sigmask() can be used. On POSIX systems, the SIGCHLD signal **must not** be ignored, i.e. the signal handler must set to SIG_DFL or a function pointer, not SIG_IGN. Also while LibVLC is active, the wait() function shall not be called, and any call to waitpid() shall use a strictly positive value for the first parameter (i.e. the PID). Failure to follow those rules may lead to a deadlock or a busy loop. Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked, even if it is not, in principles, necessary, e.g.: .. code-block:: objectivec++ sigset_t set; signal(SIGCHLD, SIG_DFL); sigemptyset(&set); sigaddset(&set, SIGPIPE); pthread_sigmask(SIG_BLOCK, &set, None); On Microsoft Windows Vista/2008, the process error mode SEM_FAILCRITICALERRORS flag **must** be set before using LibVLC. On later versions, that is optional and unnecessary. Also on Microsoft Windows (Vista and any later version), setting the default DLL directories to SYSTEM32 exclusively is strongly recommended for security reasons: .. code-block:: objectivec++ SetErrorMode(SEM_FAILCRITICALERRORS); SetDefaultDllDirectories(LOAD_LIBRARY_SEARCH_SYSTEM32); .. warning:: There is absolutely no warranty or promise of forward, backward and cross-platform compatibility with regards to :func:`libvlc_new` arguments. We recommend that you do not use them, other than when debugging. :param argc: the number of arguments (should be 0). :param argv: list of arguments (should be None). :return: the libvlc instance or None in case of error. :version: Arguments are meant to be passed from the command line to LibVLC, just like. VLC media player does. The list of valid arguments depends on the LibVLC. version, the operating system and platform, and set of available LibVLC. plugins. Invalid or unsupported arguments will cause the function to fail. (i.e. return None). Also, some arguments may alter the behaviour or. otherwise interfere with other LibVLC functions. .. py:function:: libvlc_playlist_play(p_instance, i_id, i_options, ppsz_options) Start playing (if there is any item in the playlist). Additionnal playlist item options can be specified for addition to the item before it is played. :param p_instance: the playlist instance. :param i_id: the item to play. If this is a negative number, the next. item will be selected. Otherwise, the item with the given ID will be. played. :param i_options: the number of options to add to the item. :param ppsz_options: the options to add to the item. .. py:function:: libvlc_printerr(fmt) Sets the LibVLC error status and message for the current thread. Any previous error is overridden. :param fmt: the format string. :param args: the arguments. :return: a nul terminated string in any case. .. py:function:: libvlc_release(p_instance) Decrement the reference count of a libvlc instance, and destroy it if it reaches zero. :param p_instance: the instance to destroy. .. py:function:: libvlc_renderer_discoverer_event_manager(p_rd) Get the event manager of the renderer discoverer The possible events to attach are libvlc_RendererDiscovererItemAdded and libvlc_RendererDiscovererItemDeleted. The :class:`Renderer` struct passed to event callbacks is owned by VLC, users should take care of holding/releasing this struct for their internal usage. See :class:`Event`.u.renderer_discoverer_item_added.item See :class:`Event`.u.renderer_discoverer_item_removed.item :return: a valid event manager (can't fail). :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_discoverer_list_get(p_inst, ppp_services) Get media discoverer services See libvlc_renderer_list_release :param p_inst: libvlc instance. :param ppp_services: address to store an allocated array of renderer. discoverer services (must be freed with libvlc_renderer_list_release by. the caller) [OUT]. :return: the number of media discoverer services (0 on error). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_renderer_discoverer_list_release(pp_services, i_count) Release an array of media discoverer services See :func:`libvlc_renderer_discoverer_list_get` :param pp_services: array to release. :param i_count: number of elements in the array. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_renderer_discoverer_new(p_inst, psz_name) Create a renderer discoverer object by name After this object is created, you should attach to events in order to be notified of the discoverer events. You need to call :func:`libvlc_renderer_discoverer_start` in order to start the discovery. See :func:`libvlc_renderer_discoverer_event_manager` See :func:`libvlc_renderer_discoverer_start` :param p_inst: libvlc instance. :param psz_name: service name; use :func:`libvlc_renderer_discoverer_list_get` to. get a list of the discoverer names available in this libVLC instance. :return: media discover object or None in case of error. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_discoverer_release(p_rd) Release a renderer discoverer object :param p_rd: renderer discoverer object. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_discoverer_start(p_rd) Start renderer discovery To stop it, call :func:`libvlc_renderer_discoverer_stop` or :func:`libvlc_renderer_discoverer_release` directly. See :func:`libvlc_renderer_discoverer_stop` :param p_rd: renderer discoverer object. :return: -1 in case of error, 0 otherwise. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_discoverer_stop(p_rd) Stop renderer discovery. See :func:`libvlc_renderer_discoverer_start` :param p_rd: renderer discoverer object. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_flags(p_item) Get the flags of a renderer item See LIBVLC_RENDERER_CAN_AUDIO See LIBVLC_RENDERER_CAN_VIDEO :return: bitwise flag: capabilities of the renderer, see. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_hold(p_item) Hold a renderer item, i.e. creates a new reference This functions need to called from the libvlc_RendererDiscovererItemAdded callback if the libvlc user wants to use this item after. (for display or for passing it to the mediaplayer for example). :return: the current item. :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_icon_uri(p_item) Get the icon uri of a renderer item :return: the uri of the item's icon (can be None, must *not* be freed). :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_name(p_item) Get the human readable name of a renderer item :return: the name of the item (can't be None, must *not* be freed). :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_release(p_item) Releases a renderer item, i.e. decrements its reference counter :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_renderer_item_type(p_item) Get the type (not translated) of a renderer item. For now, the type can only be "chromecast" ("upnp", "airplay" may come later). :return: the type of the item (can't be None, must *not* be freed). :version: LibVLC 3.0.0 or later. .. py:function:: libvlc_retain(p_instance) Increments the reference count of a libvlc instance. The initial reference count is 1 after :func:`libvlc_new` returns. :param p_instance: the instance to reference. .. py:function:: libvlc_set_app_id(p_instance, id, version, icon) Sets some meta-information about the application. See also :func:`libvlc_set_user_agent`. :param p_instance: LibVLC instance. :param id: Java-style application identifier, e.g. "com.acme.foobar". :param version: application version numbers, e.g. "1.2.3". :param icon: application icon name, e.g. "foobar". :version: LibVLC 2.1.0 or later. .. py:function:: libvlc_set_exit_handler(p_instance, cb, opaque) Registers a callback for the LibVLC exit event. This is mostly useful if the VLC playlist and/or at least one interface are started with :func:`libvlc_playlist_play` or :func:`libvlc_add_intf` respectively. Typically, this function will wake up your application main loop (from another thread). .. note:: This function should be called before the playlist or interface are started. Otherwise, there is a small race condition: the exit event could be raised before the handler is registered. .. warning:: This function and :func:`libvlc_wait` cannot be used at the same time. :param p_instance: LibVLC instance. :param cb: callback to invoke when LibVLC wants to exit, or None to disable the exit handler (as by default). :param opaque: data pointer for the callback. .. py:function:: libvlc_set_fullscreen(p_mi, b_fullscreen) Enable or disable fullscreen. .. warning:: With most window managers, only a top-level windows can be in full-screen mode. Hence, this function will not operate properly if :func:`libvlc_media_player_set_xwindow` was used to embed the video in a non-top-level window. In that case, the embedding window must be reparented to the root window **before** fullscreen mode is enabled. You will want to reparent it back to its normal parent when disabling fullscreen. :param p_mi: the media player. :param b_fullscreen: boolean for fullscreen status. .. py:function:: libvlc_set_log_verbosity(p_instance, level) This function does nothing. It is only provided for backward compatibility. :param p_instance: ignored. :param level: ignored. .. py:function:: libvlc_set_user_agent(p_instance, name, http) Sets the application *name*. LibVLC passes this as the user agent string when a protocol requires it. :param p_instance: LibVLC instance. :param name: human-readable application name, e.g. "FooBar player 1.2.3". :param http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0". :version: LibVLC 1.1.1 or later. .. py:function:: libvlc_title_descriptions_release(p_titles, i_count) Release a title description :param p_titles: title description array to release. :param i_count: number of title descriptions to release. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_toggle_fullscreen(p_mi) Toggle fullscreen status on non-embedded video outputs. .. warning:: The same limitations applies to this function as to :func:`libvlc_set_fullscreen`. :param p_mi: the media player. .. py:function:: libvlc_toggle_teletext(p_mi) Toggle teletext transparent status on video output. .. warning:: **Deprecated!** use :func:`libvlc_video_set_teletext` instead. :param p_mi: the media player. .. py:function:: libvlc_track_description_list_release(p_track_description) Release (free) :class:`TrackDescription` :param p_track_description: the structure to release. .. py:function:: libvlc_track_description_release(p_track_description) .. warning:: **Deprecated!** Use :func:`libvlc_track_description_list_release` instead. .. py:function:: libvlc_video_filter_list_get(p_instance) Returns a list of video filters that are available. See :class:`ModuleDescription` See :func:`libvlc_module_description_list_release`. :param p_instance: libvlc instance. :return: a list of module descriptions. It should be freed with :func:`libvlc_module_description_list_release`. In case of an error, None is returned. .. py:function:: libvlc_video_get_adjust_float(p_mi, option) Get float adjust *option*. :param p_mi: libvlc media player instance. :param option: adjust option to get, values of :class:`VideoAdjustOption`. :version: LibVLC 1.1.1 and later. .. py:function:: libvlc_video_get_adjust_int(p_mi, option) Get integer adjust *option*. :param p_mi: libvlc media player instance. :param option: adjust option to get, values of :class:`VideoAdjustOption`. :version: LibVLC 1.1.1 and later. .. py:function:: libvlc_video_get_aspect_ratio(p_mi) Get current video aspect ratio. :param p_mi: the media player. :return: the video aspect ratio or None if unspecified. (the result must be released with free() or libvlc_free). .. py:function:: libvlc_video_get_chapter_description(p_mi, i_title) Get the description of available chapters for specific title. :param p_mi: the media player. :param i_title: selected title. :return: list containing description of available chapter for title *i_title*. It must be freed with :func:`libvlc_track_description_list_release`. .. py:function:: libvlc_video_get_crop_geometry(p_mi) Get current crop filter geometry. :param p_mi: the media player. :return: the crop filter geometry or None if unset. .. py:function:: libvlc_video_get_cursor(p_mi, num) 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. .. warning:: The coordinates may be out-of-date if the pointer is not located on the video rendering area. LibVLC does not track the pointer if it is outside of the video widget. .. note:: LibVLC does not support multiple pointers (it does of course support multiple input devices sharing the same pointer) at the moment. :param p_mi: media player. :param num: number of the video (starting from, and most commonly 0). :param px: abscissa [OUT]. :param py: ordinate [OUT]. :return: 0 on success, -1 if the specified video does not exist. .. py:function:: libvlc_video_get_height(p_mi) Get current video height. .. warning:: **Deprecated!** Use :func:`libvlc_video_get_size` instead. :param p_mi: the media player. :return: the video pixel height or 0 if not applicable. .. py:function:: libvlc_video_get_logo_int(p_mi, option) Get integer logo *option*. :param p_mi: libvlc media player instance. :param option: logo option to get, values of :class:`VideoLogoOption`. .. py:function:: libvlc_video_get_marquee_int(p_mi, option) Get an integer marquee *option* value :param p_mi: libvlc media player. :param option: marq option to get See libvlc_video_marquee_int_option_t. .. py:function:: libvlc_video_get_marquee_string(p_mi, option) Get a string marquee *option* value :param p_mi: libvlc media player. :param option: marq option to get See libvlc_video_marquee_string_option_t. .. py:function:: libvlc_video_get_scale(p_mi) Get the current video scaling factor. See also :func:`libvlc_video_set_scale`. :param p_mi: the media player. :return: the currently configured zoom factor, or 0. if the video is set. to fit to the output window/drawable automatically. .. py:function:: libvlc_video_get_size(p_mi, num) Get the pixel dimensions of a video. :param p_mi: media player. :param num: number of the video (starting from, and most commonly 0). :param px: pixel width [OUT]. :param py: pixel height [OUT]. :return: 0 on success, -1 if the specified video does not exist. .. py:function:: libvlc_video_get_spu(p_mi) Get current video subtitle. :param p_mi: the media player. :return: the video subtitle selected, or -1 if none. .. py:function:: libvlc_video_get_spu_count(p_mi) Get the number of available video subtitles. :param p_mi: the media player. :return: the number of available video subtitles. .. py:function:: libvlc_video_get_spu_delay(p_mi) Get the current subtitle delay. Positive values means subtitles are being displayed later, negative values earlier. :param p_mi: media player. :return: time (in microseconds) the display of subtitles is being delayed. :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_video_get_spu_description(p_mi) Get the description of available video subtitles. :param p_mi: the media player. :return: list containing description of available video subtitles. It must be freed with :func:`libvlc_track_description_list_release`. .. py:function:: libvlc_video_get_teletext(p_mi) Get current teletext page requested or 0 if it's disabled. Teletext is disabled by default, call :func:`libvlc_video_set_teletext` to enable it. :param p_mi: the media player. :return: the current teletext page requested. .. py:function:: libvlc_video_get_title_description(p_mi) Get the description of available titles. :param p_mi: the media player. :return: list containing description of available titles. It must be freed with :func:`libvlc_track_description_list_release`. .. py:function:: libvlc_video_get_track(p_mi) Get current video track. :param p_mi: media player. :return: the video track ID (int) or -1 if no active input. .. py:function:: libvlc_video_get_track_count(p_mi) Get number of available video tracks. :param p_mi: media player. :return: the number of available video tracks (int). .. py:function:: libvlc_video_get_track_description(p_mi) Get the description of available video tracks. :param p_mi: media player. :return: list with description of available video tracks, or None on error. It must be freed with :func:`libvlc_track_description_list_release`. .. py:function:: libvlc_video_get_width(p_mi) Get current video width. .. warning:: **Deprecated!** Use :func:`libvlc_video_get_size` instead. :param p_mi: the media player. :return: the video pixel width or 0 if not applicable. .. py:function:: libvlc_video_new_viewpoint() Create a video viewpoint structure. :return: video viewpoint or None. (the result must be released with free() or libvlc_free). :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_video_set_adjust_float(p_mi, option, value) Set adjust *option* as float. Options that take a different type value are ignored. :param p_mi: libvlc media player instance. :param option: adust option to set, values of :class:`VideoAdjustOption`. :param value: adjust option value. :version: LibVLC 1.1.1 and later. .. py:function:: libvlc_video_set_adjust_int(p_mi, option, 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. :param p_mi: libvlc media player instance. :param option: adust option to set, values of :class:`VideoAdjustOption`. :param value: adjust option value. :version: LibVLC 1.1.1 and later. .. py:function:: libvlc_video_set_aspect_ratio(p_mi, psz_aspect) Set new video aspect ratio. .. note:: Invalid aspect ratios are ignored. :param p_mi: the media player. :param psz_aspect: new video aspect-ratio or None to reset to default. .. py:function:: libvlc_video_set_callbacks(mp, lock, unlock, display, opaque) Set callbacks and private data to render decoded video to a custom area in memory. Use :func:`libvlc_video_set_format` or :func:`libvlc_video_set_format_callbacks` to configure the decoded format. .. warning:: Rendering video into custom memory buffers is considerably less efficient than rendering in a custom window as normal. For optimal perfomances, VLC media player renders into a custom window, and does not use this function and associated callbacks. It is **highly recommended** that other LibVLC-based application do likewise. To embed video in a window, use libvlc_media_player_set_xid or equivalent depending on the operating system. If window embedding does not fit the application use case, then a custom LibVLC video output *display* plugin is required to maintain optimal video rendering performances. The following limitations affect performance: * Hardware video decoding acceleration will either be disabled completely, or require (relatively slow) copy from video/DSP memory to main memory. * Sub-pictures (subtitles, on-screen *display*, etc.) must be blent into the main picture by the CPU instead of the GPU. * Depending on the video format, pixel format conversion, picture scaling, cropping and/or picture re-orientation, must be performed by the CPU instead of the GPU. * Memory copying is required between LibVLC reference picture buffers and application buffers (between *lock* and *unlock* callbacks). :param mp: the media player. :param lock: callback to lock video memory (must not be None). :param unlock: callback to unlock video memory (or None if not needed). :param display: callback to display video (or None if not needed). :param opaque: private pointer for the three callbacks (as first parameter). :version: LibVLC 1.1.1 or later. .. py:function:: libvlc_video_set_crop_geometry(p_mi, psz_geometry) Set new crop filter geometry. :param p_mi: the media player. :param psz_geometry: new crop filter geometry (None to unset). .. py:function:: libvlc_video_set_deinterlace(p_mi, psz_mode) Enable or disable deinterlace filter :param p_mi: libvlc media player. :param psz_mode: type of deinterlace filter, None to disable. .. py:function:: libvlc_video_set_format(mp, chroma, width, height, pitch) Set decoded video *chroma* and dimensions. This only works in combination with :func:`libvlc_video_set_callbacks`, and is mutually exclusive with :func:`libvlc_video_set_format_callbacks`. :param mp: the media player. :param chroma: a four-characters string identifying the chroma. (e.g. "RV32" or "YUYV"). :param width: pixel width. :param height: pixel height. :param pitch: line pitch (in bytes). :version: LibVLC 1.1.1 or later. :bug: All pixel planes are expected to have the same *pitch*. To use the YCbCr color space with chrominance subsampling, consider using :func:`libvlc_video_set_format_callbacks` instead. .. py:function:: libvlc_video_set_format_callbacks(mp, setup, cleanup) Set decoded video chroma and dimensions. This only works in combination with :func:`libvlc_video_set_callbacks`. :param mp: the media player. :param setup: callback to select the video format (cannot be None). :param cleanup: callback to release any allocated resources (or None). :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_video_set_key_input(p_mi, 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. :param p_mi: the media player. :param on: true to handle key press events, false to ignore them. .. py:function:: libvlc_video_set_logo_int(p_mi, option, 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. :param p_mi: libvlc media player instance. :param option: logo option to set, values of :class:`VideoLogoOption`. :param value: logo option value. .. py:function:: libvlc_video_set_logo_string(p_mi, option, psz_value) Set logo *option* as string. Options that take a different type value are ignored. :param p_mi: libvlc media player instance. :param option: logo option to set, values of :class:`VideoLogoOption`. :param psz_value: logo option value. .. py:function:: libvlc_video_set_marquee_int(p_mi, option, 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. :param p_mi: libvlc media player. :param option: marq option to set See libvlc_video_marquee_int_option_t. :param i_val: marq option value. .. py:function:: libvlc_video_set_marquee_string(p_mi, option, psz_text) Set a marquee string option :param p_mi: libvlc media player. :param option: marq option to set See libvlc_video_marquee_string_option_t. :param psz_text: marq option value. .. py:function:: libvlc_video_set_mouse_input(p_mi, 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". See :func:`libvlc_video_set_key_input`. .. warning:: This function is only implemented for X11 and Win32 at the moment. :param p_mi: the media player. :param on: true to handle mouse click events, false to ignore them. .. py:function:: libvlc_video_set_scale(p_mi, 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. :param p_mi: the media player. :param f_factor: the scaling factor, or zero. .. py:function:: libvlc_video_set_spu(p_mi, i_spu) Set new video subtitle. :param p_mi: the media player. :param i_spu: video subtitle track to select (i_id from track description). :return: 0 on success, -1 if out of range. .. py:function:: libvlc_video_set_spu_delay(p_mi, i_delay) Set the subtitle delay. This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, while negative values will result in subtitles being displayed earlier. The subtitle delay will be reset to zero each time the media changes. :param p_mi: media player. :param i_delay: time (in microseconds) the display of subtitles should be delayed. :return: 0 on success, -1 on error. :version: LibVLC 2.0.0 or later. .. py:function:: libvlc_video_set_subtitle_file(p_mi, psz_subtitle) Set new video subtitle file. .. warning:: **Deprecated!** Use :func:`libvlc_media_player_add_slave` instead. :param p_mi: the media player. :param psz_subtitle: new video subtitle file. :return: the success status (boolean). .. py:function:: libvlc_video_set_teletext(p_mi, i_page) Set new teletext page to retrieve. This function can also be used to send a teletext key. :param p_mi: the media player. :param i_page: teletex page number requested. This value can be 0 to disable. teletext, a number in the range ]0;1000[ to show the requested page, or a. :class:`TeletextKey`. 100 is the default teletext page. .. py:function:: libvlc_video_set_track(p_mi, i_track) Set video track. :param p_mi: media player. :param i_track: the track ID (i_id field from track description). :return: 0 on success, -1 if out of range. .. py:function:: libvlc_video_take_snapshot(p_mi, num, psz_filepath, i_width, 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. :param p_mi: media player instance. :param num: number of video output (typically 0 for the first/only one). :param psz_filepath: the path of a file or a folder to save the screenshot into. :param i_width: the snapshot's width. :param i_height: the snapshot's height. :return: 0 on success, -1 if the video was not found. .. py:function:: libvlc_video_update_viewpoint(p_mi, p_viewpoint, b_absolute) Update the video viewpoint information. .. note:: It is safe to call this function before the media player is started. .. note:: the values are set asynchronously, it will be used by the next frame displayed. :param p_mi: the media player. :param p_viewpoint: video viewpoint allocated via :func:`libvlc_video_new_viewpoint`. :param b_absolute: if true replace the old viewpoint with the new one. If. false, increase/decrease it. :return: -1 in case of error, 0 otherwise. :version: LibVLC 3.0.0 and later. .. py:function:: libvlc_vlm_add_broadcast(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop) Add a broadcast, with one input. :param p_instance: the instance. :param psz_name: the name of the new broadcast. :param psz_input: the input MRL. :param psz_output: the output MRL (the parameter to the "sout" variable). :param i_options: number of additional options. :param ppsz_options: additional options. :param b_enabled: boolean for enabling the new broadcast. :param b_loop: Should this broadcast be played in loop ? :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_add_input(p_instance, psz_name, psz_input) Add a media's input MRL. This will add the specified one. :param p_instance: the instance. :param psz_name: the media to work on. :param psz_input: the input MRL. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_add_vod(p_instance, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux) Add a vod, with one input. :param p_instance: the instance. :param psz_name: the name of the new vod media. :param psz_input: the input MRL. :param i_options: number of additional options. :param ppsz_options: additional options. :param b_enabled: boolean for enabling the new vod. :param psz_mux: the muxer of the vod media. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_change_media(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop) Edit the parameters of a media. This will delete all existing inputs and add the specified one. :param p_instance: the instance. :param psz_name: the name of the new broadcast. :param psz_input: the input MRL. :param psz_output: the output MRL (the parameter to the "sout" variable). :param i_options: number of additional options. :param ppsz_options: additional options. :param b_enabled: boolean for enabling the new broadcast. :param b_loop: Should this broadcast be played in loop ? :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_del_media(p_instance, psz_name) Delete a media (VOD or broadcast). :param p_instance: the instance. :param psz_name: the media to delete. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_get_event_manager(p_instance) Get libvlc_event_manager from a vlm media. The p_event_manager is immutable, so you don't have to hold the lock :param p_instance: a libvlc instance. :return: libvlc_event_manager. .. py:function:: libvlc_vlm_get_media_instance_length(p_instance, psz_name, i_instance) Get vlm_media instance length by name or instance id :param p_instance: a libvlc instance. :param psz_name: name of vlm media instance. :param i_instance: instance id. :return: length of media item or -1 on error. .. py:function:: libvlc_vlm_get_media_instance_position(p_instance, psz_name, i_instance) Get vlm_media instance position by name or instance id :param p_instance: a libvlc instance. :param psz_name: name of vlm media instance. :param i_instance: instance id. :return: position as float or -1. on error. .. py:function:: libvlc_vlm_get_media_instance_rate(p_instance, psz_name, i_instance) Get vlm_media instance playback rate by name or instance id :param p_instance: a libvlc instance. :param psz_name: name of vlm media instance. :param i_instance: instance id. :return: playback rate or -1 on error. .. py:function:: libvlc_vlm_get_media_instance_time(p_instance, psz_name, i_instance) Get vlm_media instance time by name or instance id :param p_instance: a libvlc instance. :param psz_name: name of vlm media instance. :param i_instance: instance id. :return: time as integer or -1 on error. .. py:function:: libvlc_vlm_pause_media(p_instance, psz_name) Pause the named broadcast. :param p_instance: the instance. :param psz_name: the name of the broadcast. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_play_media(p_instance, psz_name) Play the named broadcast. :param p_instance: the instance. :param psz_name: the name of the broadcast. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_release(p_instance) Release the vlm instance related to the given :class:`Instance` :param p_instance: the instance. .. py:function:: libvlc_vlm_seek_media(p_instance, psz_name, f_percentage) Seek in the named broadcast. :param p_instance: the instance. :param psz_name: the name of the broadcast. :param f_percentage: the percentage to seek to. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_set_enabled(p_instance, psz_name, b_enabled) Enable or disable a media (VOD or broadcast). :param p_instance: the instance. :param psz_name: the media to work on. :param b_enabled: the new status. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_set_input(p_instance, psz_name, psz_input) Set a media's input MRL. This will delete all existing inputs and add the specified one. :param p_instance: the instance. :param psz_name: the media to work on. :param psz_input: the input MRL. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_set_loop(p_instance, psz_name, b_loop) Set a media's loop status. :param p_instance: the instance. :param psz_name: the media to work on. :param b_loop: the new status. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_set_mux(p_instance, psz_name, psz_mux) Set a media's vod muxer. :param p_instance: the instance. :param psz_name: the media to work on. :param psz_mux: the new muxer. :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_set_output(p_instance, psz_name, psz_output) Set the output for a media. :param p_instance: the instance. :param psz_name: the media to work on. :param psz_output: the output MRL (the parameter to the "sout" variable). :return: 0 on success, -1 on error. .. py:function:: libvlc_vlm_show_media(p_instance, psz_name) Return information about the named media as a JSON string representation. This function is mainly intended for debugging use, if you want programmatic access to the state of a vlm_media_instance_t, please use the corresponding libvlc_vlm_get_media_instance_xxx -functions. Currently there are no such functions available for vlm_media_t though. :param p_instance: the instance. :param psz_name: the name of the media, if the name is an empty string, all media is described. :return: string with information about named media, or None on error. .. py:function:: libvlc_vlm_stop_media(p_instance, psz_name) Stop the named broadcast. :param p_instance: the instance. :param psz_name: the name of the broadcast. :return: 0 on success, -1 on error. .. py:function:: libvlc_vprinterr(fmt, ap) Sets the LibVLC error status and message for the current thread. Any previous error is overridden. :param fmt: the format string. :param ap: the arguments. :return: a nul terminated string in any case. .. py:function:: libvlc_wait(p_instance) Waits until an interface causes the instance to exit. You should start at least one interface first, using :func:`libvlc_add_intf`. .. warning:: This function wastes one thread doing basically nothing. :func:`libvlc_set_exit_handler` should be used instead. :param p_instance: the instance. .. py:data:: logger .. py:function:: module_description_list(head) Convert a ModuleDescription linked list to a Python list (and release the former). .. py:function:: print_python() .. py:function:: print_version() Print version of this vlc.py and of the libvlc .. py:function:: str_to_bytes(s) Translate string or bytes to bytes. .. py:function:: string_result(result, func, arguments) Errcheck function. Returns a string and frees the original pointer. It assumes the result is a ``char*``. .. py:function:: track_description_list(head) Convert a TrackDescription linked list to a Python list (and release the former). .. py:function:: try_fspath(path) Try calling ``os.fspath``. ``os.fspath`` is only available from py3.6.