Package uk.co.caprica.vlcj.player.list

Class ListApi

  • public final class ListApi
extends Object
    Behaviour pertaining to the list of media items.

    • Method Detail

      • setMediaList

        public void setMediaList​(MediaListRef mediaListRef)
        Set a new media list.

        The supplied MediaListRef is not kept by this component and must be released by the caller when the caller no longer has any use for it.

        Parameters:
        mediaListRef - media list

      • isValid

        public boolean isValid()
        Is the media list valid?

        This method could be used to check there is a list before using the various behaviours.

        Returns:
        true if there is a valid list; false if there is not

      • events

        public EventApi events()
        Delegated behaviour pertaining to the associated media list events.
        Returns:
        events behaviour, may be null if there is currently no media list

      • media

        public MediaApi media()
        Delegated behaviour pertaining to the associated media list items.
        Returns:
        item behaviour, may be null if there is currently no media list

      • newMediaList

        public MediaList newMediaList()
        Create a new MediaList for the associated media list.

        The caller must release the returned MediaList when it has no further use for it.

        Returns:
        media list reference

      • newMediaListRef

        public MediaListRef newMediaListRef()
        Create a new MediaListRef for the associated media list.

        The caller must release the returned MediaListRef when it has no further use for it.

        Returns:
        media list reference