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

Class MediaPlayerSpecs.EmbeddedMediaPlayerSpec

java.lang.Object
uk.co.caprica.vlcj.player.component.MediaPlayerSpecs.EmbeddedMediaPlayerSpec
Enclosing class:
MediaPlayerSpecs
public static final class MediaPlayerSpecs.EmbeddedMediaPlayerSpec extends Object
Builder for an embedded media or media list player.

  • Method Details

    • withFactory

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withFactory(MediaPlayerFactory factory)
      Specify the media player factory to use.
      Parameters:
      factory - media player factory
      Returns:
      this builder

    • withVideoSurfaceComponent

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withVideoSurfaceComponent(Component videoSurfaceComponent)
      Specify the heavyweight video surface component to use.

      It is possible to render video into any AWT Component - optimally this would be a Canvas, but Window is possible, as in fact is Button or anything else (although this is not recommended).

      This video surface component will be added into the media player component layout.

      Parameters:
      videoSurfaceComponent - video surface component
      Returns:
      this builder

    • withFullScreenStrategy

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withFullScreenStrategy(FullScreenStrategy fullScreenStrategy)
      Specify the full-screen strategy to use.

      By default if no strategy is set there will be no support for full-screen mode.

      Parameters:
      fullScreenStrategy - full-screen strategy
      Returns:
      this builder

    • withDefaultFullScreenStrategy

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withDefaultFullScreenStrategy(Window fullScreenWindow)
      Specify to use the default full-screen strategy.

      The default strategy will use the "best" available native strategy depending on the run-time operating system.

      Parameters:
      fullScreenWindow - window that will be made full-screen (the window containing the video surface)
      Returns:
      this builder

    • withUnsupportedFullScreenStrategy

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withUnsupportedFullScreenStrategy()
      Specify to use the do-nothing unsupported full-screen strategy.

      This is not really necessary as the default situation is to have no full-screen strategy.

      Returns:
      this builder

    • withInputEvents

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withInputEvents(InputEvents inputEvents)
      Specify keyboard/mouse input-event configuration.
      Parameters:
      inputEvents - keyboard/mouse configuration
      Returns:
      this builder

    • withOverlay

      public MediaPlayerSpecs.EmbeddedMediaPlayerSpec withOverlay(Window overlay)
      Specify a heavyweight overlay.

      Any Window can be used as an overlay - it is recommended for the window to have a transparent background.

      Parameters:
      overlay - overlay
      Returns:
      this builder

    • embeddedMediaPlayer

      public EmbeddedMediaPlayerComponent embeddedMediaPlayer()
      Create an embedded media player component from this builder.
      Returns:
      embedded media player component

    • embeddedMediaListPlayer

      public EmbeddedMediaListPlayerComponent embeddedMediaListPlayer()
      Create an embedded media list player component from this builder.
      Returns:
      embedded media list player component