FullScreenApi (vlcj 4.8.2 API)

java.lang.Object

uk.co.caprica.vlcj.player.embedded.FullScreenApi

public final class FullScreenApi extends Object

Behaviour pertaining to full-screen functionality.

Method Summary

Modifier and Type

Method

Description

boolean

isFullScreen()

Check whether the full-screen mode is currently active or not.

void

set(boolean fullScreen)

Set full-screen mode.

void

strategy(FullScreenStrategy fullScreenStrategy)

Set a full-screen strategy implementation.

void

toggle()

Toggle whether the video display is in full-screen or not.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- strategy
  
  public void strategy(FullScreenStrategy fullScreenStrategy)
  
  Set a full-screen strategy implementation.
  The preferred way to set a full-screen strategy is via a constructor argument when creating the media player.
  
  Parameters:
  
  fullScreenStrategy - full-screen strategy
- toggle
  
  public void toggle()
  
  Toggle whether the video display is in full-screen or not.
  Setting the display into or out of full-screen mode is delegated to the currently set FullScreenStrategy, which may be null (in which case full-screen mode is not supported).
- set
  
  public void set(boolean fullScreen)
  
  Set full-screen mode.
  Setting the display into or out of full-screen mode is delegated to the currently set FullScreenStrategy, which may be null (in which case full-screen mode is not supported).
  
  Parameters:
  
  fullScreen - true for full-screen, otherwise false
- isFullScreen
  
  public boolean isFullScreen()
  
  Check whether the full-screen mode is currently active or not.
  Testing whether or not the display is in full-screen mode is delegated to the currently set FullScreenStrategy which may be null (in which case full-screen mode is not supported).
  
  Returns:
  
  true if full-screen is active, otherwise false