vlc.MediaListPlayer
===================

.. py:class:: vlc.MediaListPlayer

   Bases: :py:obj:`_Ctype`


   It may take as parameter either:

   * an :class:`Instance`
   * nothing



   .. py:method:: event_manager()

      Return the event manager of this media_list_player.

      :return: the event manager.



   .. py:method:: get_instance()

      Return the associated :class:`Instance`.



   .. py:method:: get_media_player()

      Get media player of the media_list_player instance.


      .. note:: the caller is responsible for releasing the returned instance.

      :return: media player instance.



   .. py:method:: get_state()

      Get current libvlc_state of media list player

      :return: :class:`State` for media list player.



   .. py:method:: is_playing()

      Is media list playing?

      :return: true for playing and false for not playing.



   .. py:method:: next()

      Play next item from media list

      :return: 0 upon success -1 if there is no next item.



   .. py:method:: pause()

      Toggle pause (or resume) media list



   .. py:method:: play()

      Play media list



   .. py:method:: play_item(p_md)

      Play the given media item

      :param p_md: the media instance.

      :return: 0 upon success, -1 if the media is not part of the media list.



   .. py:method:: play_item_at_index(i_index)

      Play media list item at position index

      :param i_index: index in media list to play.

      :return: 0 upon success -1 if the item wasn't found.



   .. py:method:: previous()

      Play previous item from media list

      :return: 0 upon success -1 if there is no previous item.



   .. py:method:: release()

      Release a media_list_player after use
      Decrement the reference count of a media player object. If the
      reference count is 0, then :func:`release` will
      release the media player object. If the media player object
      has been released, then it should not be used again.



   .. py:method:: retain()

      Retain a reference to a media player list object. Use
      :func:`release` to decrement reference count.



   .. py:method:: set_media_list(p_mlist)

      Set the media list associated with the player

      :param p_mlist: list of media.



   .. py:method:: set_media_player(p_mi)

      Replace media player in media_list_player with this instance.

      :param p_mi: media player instance.



   .. py:method:: set_pause(do_pause)

      Pause or resume media list

      :param do_pause: play/resume if zero, pause if non-zero.

      :version: LibVLC 3.0.0 or later.



   .. py:method:: set_playback_mode(e_mode)

      Sets the playback mode for the playlist

      :param e_mode: playback mode specification.



   .. py:method:: stop()

      Stop playing media list