Module uk.co.caprica.vlcj
Package uk.co.caprica.vlcj.player.renderer

Class RendererItem

java.lang.Object
uk.co.caprica.vlcj.player.renderer.RendererItem
public final class RendererItem extends Object
Encapsulation of a renderer item.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RendererItem(uk.co.caprica.vlcj.binding.internal.libvlc_renderer_item_t item)
    Create a new renderer item.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAudio()
    Can this renderer item play audio?
    boolean
    canVideo()
    Can this renderer item play video?
    boolean
    hold()
    Hold this renderer item.
    String
    iconUri()
    Get the item icon URI.
    String
    name()
    Get the item name.
    void
    release()
    Release the renderer item.
    uk.co.caprica.vlcj.binding.internal.libvlc_renderer_item_t
    rendererItemInstance()
    Get the native renderer item instance.
    String
    toString()
     
    String
    type()
    Get the item type.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RendererItem

      public RendererItem(uk.co.caprica.vlcj.binding.internal.libvlc_renderer_item_t item)
      Create a new renderer item.
      Parameters:
      item - native renderer item instance

  • Method Details

    • name

      public String name()
      Get the item name.
      Returns:
      name

    • type

      public String type()
      Get the item type.
      Returns:
      type

    • iconUri

      public String iconUri()
      Get the item icon URI.
      Returns:
      icon URI

    • canAudio

      public boolean canAudio()
      Can this renderer item play audio?
      Returns:
      true if this item can play audio; false if it can not

    • canVideo

      public boolean canVideo()
      Can this renderer item play video?
      Returns:
      true if this item can play video; false if it can not

    • hold

      public boolean hold()
      Hold this renderer item.

      The item must be held prior to setting it via a call to MediaPlayer.setRenderer(RendererItem) on MediaPlayer.

      The item must be released when the caller no longer has any use for it.

      Returns:
      true if the renderer item was successfully held; false on error

    • release

      public void release()
      Release the renderer item.

      The renderer item may still be kept and re-used, invoke hold() again.

    • rendererItemInstance

      public uk.co.caprica.vlcj.binding.internal.libvlc_renderer_item_t rendererItemInstance()
      Get the native renderer item instance.
      Returns:
      renderer item instance

    • toString

      public String toString()
      Overrides:
      toString in class Object