Package 

Interface THEOplayerSettings

  • All Implemented Interfaces:
    
public interface THEOplayerSettings

    The THEOplayerSettings API.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract boolean isFullScreenOrientationCoupled() Returns whether fullscreen coupling is on.
      abstract void setFullScreenOrientationCoupled(boolean coupled) Sets whether the orientation of the device and the fullscreen state are coupled.
      abstract int getFullscreenOrientation() Returns which orientation was configured to go to in fullscreen, defaults to ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED.
      abstract void setFullscreenOrientation(int orientation) Sets in which ScreenOrientation the player should go into fullscreen.
      abstract void setAllowBackgroundPlayback(boolean allowBackgroundPlayback) Sets whether the player continues play-out while the app goes to the background, defaults to `false`.
      abstract boolean allowBackgroundPlayback()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • setFullScreenOrientationCoupled

         abstract void setFullScreenOrientationCoupled(boolean coupled)

        Sets whether the orientation of the device and the fullscreen state are coupled.

        • When this option is set to true, the player will go fullscreen when the device is rotated to landscape and will also exit fullscreen when the device is rotated back to portrait.
        • Note that this has no relation to the orientation in which the player will be in fullscreen. For that, refer to setFullscreenOrientation
        Parameters:
        coupled - Whether coupling is enabled.

      • getFullscreenOrientation

         abstract int getFullscreenOrientation()

        Returns which orientation was configured to go to in fullscreen, defaults to ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED.

      • setFullscreenOrientation

         abstract void setFullscreenOrientation(int orientation)

        Sets in which ScreenOrientation the player should go into fullscreen.

        • For values to which the orientation is limited, see ActivityInfo.SCREEN_ORIENTATION_*
        Parameters:
        orientation - The targeted fullscreen orientation.

      • setAllowBackgroundPlayback

         abstract void setAllowBackgroundPlayback(boolean allowBackgroundPlayback)

        Sets whether the player continues play-out while the app goes to the background, defaults to `false`.

        • When this option is set to true, the player will not pause play-out when the app goes to the background.
        • Note that when this option is enabled the player should be contained in a Service to allow the device to continue serving media and ensure a smooth and uninterrupted playback experience while the app is not in the foreground. For more information, please refer to Play media in the background
        Parameters:
        allowBackgroundPlayback - Whether background playback is enabled.