Class JWPlayerView

  • All Implemented Interfaces:
    android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent

    public class JWPlayerView
    extends android.widget.FrameLayout
    JW Player SDK for Android main class, contains the player API methods, event listeners, and handles the instantiation of all classes needed to play video.

    Users from this class must forward several important lifecycle methods. It's important that you forward the following methods:

    • onResume()
    • onPause()
    • onDestroy()
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  JWPlayerView.Listener  
      • Nested classes/interfaces inherited from class android.widget.FrameLayout

        android.widget.FrameLayout.LayoutParams
      • Nested classes/interfaces inherited from class android.view.ViewGroup

        android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener
      • Nested classes/interfaces inherited from class android.view.View

        android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnCapturedPointerListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener, android.view.View.OnUnhandledKeyEventListener
    • Field Summary

      • Fields inherited from class android.view.ViewGroup

        CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE
      • Fields inherited from class android.view.View

        ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_CONTENT_CAPTURE_AUTO, IMPORTANT_FOR_CONTENT_CAPTURE_NO, IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_CONTENT_CAPTURE_YES, IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_CAPTURE_HINT_AUTO, SCROLL_CAPTURE_HINT_EXCLUDE, SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS, SCROLL_CAPTURE_HINT_INCLUDE, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z
    • Constructor Summary

      Constructors 
      Constructor Description
      JWPlayerView​(android.content.Context context, android.util.AttributeSet attrs)
      Constructor that is called when inflating a view from XML.
      JWPlayerView​(android.content.Context context, PlayerConfig playerConfig)
      Constructor used to programmatically initialize a JWPlayerView.
    • Constructor Detail

      • JWPlayerView

        public JWPlayerView​(android.content.Context context,
                            android.util.AttributeSet attrs)
        Constructor that is called when inflating a view from XML.
        Parameters:
        context - The view context.
        attrs - The attributes to the view.
      • JWPlayerView

        public JWPlayerView​(android.content.Context context,
                            PlayerConfig playerConfig)
        Constructor used to programmatically initialize a JWPlayerView.
        Parameters:
        context - the activity the JWPlayerView runs in.
        playerConfig - the player configuration.
    • Method Detail

      • getVersionCode

        public java.lang.String getVersionCode()
        Returns the SDK version.
        Returns:
        The current SDK version.
      • setup

        public void setup​(PlayerConfig playerConfig)
        Sets up JW Player with a new PlayerConfig. This can be used to load media and change options (e.g. captions styling) without creating a new instance of the player.
        Parameters:
        playerConfig - The player configuration to use with this JWPlayerView.
      • setPlaylistItemCallbackListener

        public void setPlaylistItemCallbackListener​(VideoPlayerEvents.PlaylistItemCallbackListener listener)
        Registers a listener to receive a blocking callback before the start of the next playlist item There can only be 1 listener, additional assignments overwrite the previous listener You can set the listener to null to clear to value
      • removePlaylistItemCallbackListener

        public void removePlaylistItemCallbackListener()
      • next

        public void next()
        Tells JW Player to immediately play the next playlist item.
      • load

        public void load​(java.util.List<PlaylistItem> playlist,
                         AdvertisingBase advertising)
        Loads a new playlist into the player.

        If you want to play a local file on the device the url of the media should be in the form of: "file:///path/to/file.mp4".

        In order to play a local file on Android 6+ (API 23) you need to ask for the permission "READ_EXTERNAL_STORE" at runtime, and check if the user has granted that permission. If the user denied permission to read the external storage the JW Player will not be able to play the local file.

        For more information about permissions in Android 6 see Permissions.

        Parameters:
        playlist - List of PlaylistItem objects that make up the playlist.
        advertising - AdvertisingBase settings to load for the entire playlist.
      • load

        public void load​(PlaylistItem playlistItem)
        Loads media into the player.

        If you want to play a local file on the device the url of the media should be in the form of: "file:///path/to/file.mp4".

        In order to play a local file on Android 6+ (API 23) you need to ask for the permission "READ_EXTERNAL_STORE" at runtime, and check if the user has granted that permission. If the user denied permission to read the external storage the JW Player will not be able to play the local file.

        For more information about permissions in Android 6 see Permissions.

        Parameters:
        playlistItem - PlaylistItem object to play.
      • load

        public void load​(java.util.List<PlaylistItem> playlist)
        Loads a new playlist into the player.

        If you want to play a local file on the device the url of the media should be in the form of: "file:///path/to/file.mp4".

        In order to play a local file on Android 6+ (API 23) you need to ask for the permission "READ_EXTERNAL_STORE" at runtime, and check if the user has granted that permission. If the user denied permission to read the external storage the JW Player will not be able to play the local file.

        For more information about permissions in Android 6 see Permissions.

        Parameters:
        playlist - List of PlaylistItem objects that make up the playlist.
      • getConfig

        public PlayerConfig getConfig()
        Returns the current configuration being used by the player.
        Returns:
        The current configuration.
      • getState

        public com.longtailvideo.jwplayer.core.PlayerState getState()
        Returns the player's current playback state.
        Returns:
        The player's current playback state.
      • play

        public void play()
        Sets the play state of the JW Player. Calling play() while media is playing does nothing.
      • pause

        public void pause()
        Pauses playback, changing the state of JW Player from playing to paused. Calling pause() while media is already paused does nothing. Note: When using this method with a non-DVR live stream, the player will appear paused. After this, when play() is called, the stream restarts from the live edge.
      • stop

        public void stop()
        Stops the player, returning it to the idle state.
      • getPosition

        public double getPosition()
        Returns the current playback position.
        Returns:
        The current playback position in seconds, or -1 if not available.
      • getAdPosition

        public double getAdPosition()
        Returns the current ad playback position.
        Returns:
        The current ad playback position in seconds, or -1 if not available.
      • getDuration

        public double getDuration()
        Returns the duration of the current media.
        Returns:
        The current media duration in seconds, or -1 if not available.
      • seek

        public void seek​(double position)
        Seeks the currently playing media to the specified position.
        Parameters:
        position - The position to seek to in seconds from the beginning.
      • getFullscreen

        public boolean getFullscreen()
        Returns whether the player is currently in fullscreen.
        Returns:
        Whether the video player is running in fullscreen mode.
      • setFullscreen

        public void setFullscreen​(boolean state,
                                  boolean allowRotation)
        Enables or disables fullscreen mode.
        Parameters:
        state - Whether the video player should run in fullscreen mode.
        allowRotation - Whether to allow rotation to enter or exit fullscreen, false to only allow portrait/landscape change via setFullscreen().
      • setControls

        public void setControls​(boolean controls)
        Enable the built-in controls by setting them true, disable the controls by setting them false.
        Parameters:
        controls - whether to enable or disable the controls.
      • playAd

        public void playAd​(java.lang.String... vasts)
        Used to play an ad right now, which is primarily useful for situations where the built-in ad. schedule of JW Player cannot be used. (e.g. for live streaming or dynamic ads for playlist items).

        Supported for VAST only. Use playAd(AdSource, String...) if you want to play IMA ads.

        Parameters:
        vasts - The ad tags to play.
      • playAd

        public void playAd​(AdSource adSource,
                           java.lang.String... vasts)
        Used to play an ad right now, which is primarily useful for situations where the built-in ad. schedule of JW Player cannot be used. (e.g. for live streaming or dynamic ads for playlist items).

        VMAP's are not supported by this method.

        Parameters:
        vasts - The ad tags to play.
      • pauseAd

        public void pauseAd()
        Pauses ad playback.
      • pauseAd

        public void pauseAd​(boolean state)
        Used to pause or resume ad playback.
        Parameters:
        state - Set whether or not the ad playback should be paused.
      • setWindowOpenHandler

        public void setWindowOpenHandler​(WindowOpenHandler windowOpenHandler)
        Sets the WindowOpenHandler, you can use this to override the default behavior of opening the browser when a url is requested.
        Parameters:
        windowOpenHandler - the WindowOpenHandler to use for opening URLs.
      • openRelatedOverlay

        public void openRelatedOverlay()
        Opens the related videos overlay if the current video/playlist has a related feed enabled If the video is still playing it will pause
      • closeRelatedOverlay

        public void closeRelatedOverlay()
        Closes the related videos overlay if the current video/playlist has a related feed enabled and is shown
      • openSharingOverlay

        public void openSharingOverlay()
        Opens the sharing plugin. This will also pause content if it is triggered during playback.
      • closeSharingOverlay

        public void closeSharingOverlay()
        Closes the sharing plugin if it is opened. This will resume playback if the sharing overlay was triggered during content.
      • getPlaylist

        public java.util.List<PlaylistItem> getPlaylist()
        Returns the player's current playlist List.
        Returns:
        The player's curent playlist.
      • getPlaylistIndex

        public int getPlaylistIndex()
        Returns the index of the currently active item in the playlist.
        Returns:
        The index of the currently active item in the playlist.
      • getPlaylistItem

        public PlaylistItem getPlaylistItem​(int index)
        Retrieves the same information as getPlaylist(), but for a single playlist item
        Returns:
        Retrieves the same information as getPlaylist(), but for a single playlist item
      • playlistItem

        public void playlistItem​(int index)
        Start playback of the playlist item at the specified index.
        Parameters:
        index - The index of a playlist item you wish to play.
      • getBuffer

        public int getBuffer()
        Gets the current buffer percentage of the loaded media.
        Returns:
        A percentage (0-100) of the video's current loaded amount
      • getQualityLevels

        public java.util.List<QualityLevel> getQualityLevels()
        Returns a list with quality levels from the player.
        Returns:
        List of quality levels from the player.
      • getCurrentQuality

        public int getCurrentQuality()
        Returns the index of the currently active quality level.
        Returns:
        The index of the currently active quality level.
      • setCurrentQuality

        public void setCurrentQuality​(int index)
        Change the quality level to the provided index. The index must be within the list provided by getQualityLevels().
        Parameters:
        index - Index of the quality level to switch to.
      • getPlaybackRate

        public float getPlaybackRate()
        Returns current playback rate
        Returns:
        The playback rate
      • setPlaybackRate

        public void setPlaybackRate​(float playbackRate)
        Sets playback rate
        Parameters:
        playbackRate - The playback rate to be set
      • getVisualQuality

        public VisualQualityEvent getVisualQuality()
        Returns a VisualQuality object containing information about the current quality of a video stream.
        Returns:
        an object containing information about the current quality, or null if the information is not available.
      • getCaptionsList

        public java.util.List<Caption> getCaptionsList()
        Returns a List with captions tracks from the player.
        Returns:
        List with captions tracks from the player.
      • getCurrentCaptions

        public int getCurrentCaptions()
        Returns the index of the currently active captions track. Note the captions are Off if the index is 0.
        Returns:
        The index of the currently active captions track.
      • setCurrentCaptions

        public void setCurrentCaptions​(int index)
        Change the visible captions track to the provided index. The index must be within the list provided by getCaptionsList.

        Note an index of 0 always turns the captions Off.

        Parameters:
        index - The index of the caption track to switch to.
      • setCurrentAudioTrack

        public void setCurrentAudioTrack​(int index)
        Change the audio track to the provided index. The index must be within the list provided by getAudioTracks().
        Parameters:
        index - Index of the audio track to switch to.
      • getCurrentAudioTrack

        public int getCurrentAudioTrack()
        Returns the index of the currently active audio track.
        Returns:
        Index of the currently active audio track.
      • getAudioTracks

        public java.util.List<AudioTrack> getAudioTracks()
        Returns a List with audio tracks from the player.
        Returns:
        List with audio tracks from the player.
      • getMute

        public boolean getMute()
        Returns whether the player is currently muted or not
        Returns:
        true if the player has been muted, false if it isn't.
      • getControls

        public boolean getControls()
        Returns whether or not the built-in controls are currently enabled
        Returns:
        true if the built-in controls are currently enabled
      • getExoPlayerSettings

        @NonNull
        public ExoPlayerSettings getExoPlayerSettings()
        Returns ExoPlayerSettings reference to manage ExoPlayer's settings
        Returns:
        ExoPlayer's settings
      • getExperimentalAPI

        @NonNull
        public com.longtailvideo.jwplayer.ExperimentalAPI getExperimentalAPI()
        Returns ExperimentalAPI reference to access the Experimental API
        Returns:
        the Experimental API
      • isControlBarVisible

        public boolean isControlBarVisible()
        Returns whether or not the built-in control bar is visible.

        Note: this might not give the expected result if you are using a custom CSS skin that alters the behavior of the control bar.

        Returns:
        true if the built-in control bar is visible.
      • setMute

        public void setMute()
        Toggles the mute state of the player.
      • setMute

        public void setMute​(boolean state)
        Sets the mute state of the player.
        Parameters:
        state - If true, mute the player. If false, unmute the player.
      • setFullscreenHandler

        public void setFullscreenHandler​(FullscreenHandler fullscreenHandler)
        Replaces the default FullscreenHandler with the one provided.
        Parameters:
        fullscreenHandler - the fullscreen handler that should take care of fullscreening.
      • setUseFullscreenLayoutFlags

        protected void setUseFullscreenLayoutFlags​(boolean useFullscreenLayoutFlags)
        Determines whether the View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN and View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION flags are used during fullscreen.

        These flags create an issue on Android 4.1, 4.2, and 4.3 devices when using the SupportActionBar, set this to false to disable using these flags.

      • setLicenseKey

        public static void setLicenseKey​(android.content.Context context,
                                         java.lang.String license)
        Sets the license key for JW Player programmatically. Use this as an alternative to storing the license key in AndroidManifest.xml

        This must be called before JWPlayerView is instantiated.

        Parameters:
        context - The application's context
        license - The JW Player license to use
      • setAnalyticsListener

        public void setAnalyticsListener​(com.google.android.exoplayer2.analytics.AnalyticsListener listener)
        Sets an AnalyticsListener to receive analytics events.
        Parameters:
        listener - The listener to be added.
      • getExternalMetadata

        public java.util.List<ExternalMetadata> getExternalMetadata()
        Returns:
        Current ExternalMetadata for this playlistItem
      • setExternalMetadata

        public void setExternalMetadata​(java.util.List<ExternalMetadata> externalMetadataList)
        Parameters:
        externalMetadataList -
      • updateHttpHeaders

        public void updateHttpHeaders​(java.util.Map<java.lang.String,​java.lang.String> httpHeaders)
        Updates HTTP headers included in content network requests
        Parameters:
        httpHeaders - mapping of headers to add to content network requests
      • addButton

        public void addButton​(@NonNull
                              java.lang.String imageUrl,
                              @NonNull
                              java.lang.String tooltip,
                              @Nullable
                              VideoPlayerEvents.OnCustomButtonClickListener listener,
                              @NonNull
                              java.lang.String id,
                              @Nullable
                              java.lang.String buttonClass)
        Adds a custom button to the player's control bar. Placement: Buttons are added to the righthand-side grouping of icons in the control bar. Buttons are added all the way to the left of the grouping, except if there is a logo in the control bar. In this case, buttons will be added to the right of the logo. Multiple buttons are added from right to left in the order they are entered.
        Parameters:
        imageUrl - The image that will be used as the button icon.
        tooltip - A tooltip label to display when the button is hovered.
        listener - Listener that is called when the button is clicked.
        id - The string used to identify the button. It must be unique across all buttons (a IllegalArgumentException will be thrown otherwise).
        buttonClass - An optional CSS class name added to the button element. Can be null.
      • removeButton

        public void removeButton​(@NonNull
                                 java.lang.String id)
        Removes a custom button from the control bar.
        Parameters:
        id - The id used to identify the button to remove.
      • onStart

        public void onStart()
        Called by Activity.onStart() to allow the player to handle activity resuming/foregrounding.
      • onResume

        public void onResume()
        Called by Activity.onResume() to allow the player to handle activity resuming/foregrounding.
      • onPause

        public void onPause()
        Called by Activity.onPause() to allow the player to prepare for the activity pausing/backgrounding.
      • onStop

        public void onStop()
        Called by Activity.onStop() to allow the player to prepare for the activity pausing/backgrounding.
      • onDestroy

        public void onDestroy()
        Called by Activity.onDestroy to allow the player to release resources.
      • onAttachedToWindow

        protected void onAttachedToWindow()
        Overrides:
        onAttachedToWindow in class android.view.ViewGroup
      • setLayoutParams

        public void setLayoutParams​(android.view.ViewGroup.LayoutParams params)
        Overrides:
        setLayoutParams in class android.view.View
      • initializeSurface

        public void initializeSurface()
        Initializes the video surface the JW Player renders to. Usually you don't need to use this method, except if you called destroySurface() yourself.
      • destroySurface

        public void destroySurface()
        Destroys the video surface the JW Player is rendering too. Usually you don't need to use this method, except for when you want to detach and reattach a JWPlayerView to a ViewGroup.
      • setBackgroundAudio

        public void setBackgroundAudio​(boolean enableBackgroundAudio)
        Sets whether the player is allowed to play audio in the background.
        Parameters:
        enableBackgroundAudio - true if the player should play audio in the background, false if it should not.
      • getBackgroundAudio

        public boolean getBackgroundAudio()
        Returns whether the player is allowed to play audio in the background.
      • addOnReadyListener

        public void addOnReadyListener​(VideoPlayerEvents.OnReadyListener listener)
        Adds an OnReadyListener.
        Parameters:
        listener - The listener to add for the onSetupError event.
      • removeOnReadyListener

        public boolean removeOnReadyListener​(VideoPlayerEvents.OnReadyListener listener)
        Removes the ready listener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been remvoed.
      • addOnSetupErrorListener

        public void addOnSetupErrorListener​(VideoPlayerEvents.OnSetupErrorListener listener)
        Adds an OnSetupErrorListener.
        Parameters:
        listener - The listener to add for the onSetupError event.
      • removeOnSetupErrorListener

        public boolean removeOnSetupErrorListener​(VideoPlayerEvents.OnSetupErrorListener listener)
        Removes the setup error listener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been remvoed.
      • addOnPlaylistListener

        public void addOnPlaylistListener​(VideoPlayerEvents.OnPlaylistListener listener)
        Adds an OnPlaylistListener.
        Parameters:
        listener - The listener for the onPlaylist event.
      • removeOnPlaylistListener

        public boolean removeOnPlaylistListener​(VideoPlayerEvents.OnPlaylistListener listener)
        Removes an OnPlaylistListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnPlaylistItemListener

        public void addOnPlaylistItemListener​(VideoPlayerEvents.OnPlaylistItemListener listener)
        Adds an OnPlaylistItemListener.
        Parameters:
        listener - The listener for the onPlaylistItem event.
      • removeOnPlaylistItemListener

        public boolean removeOnPlaylistItemListener​(VideoPlayerEvents.OnPlaylistItemListener listener)
        Removes an OnPlaylistItemListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        listener to remove for the OnPlaylistItem event.
      • addOnPlayListener

        public void addOnPlayListener​(VideoPlayerEvents.OnPlayListener listener)
        Adds an OnPlayListener.
        Parameters:
        listener - The listener to add for the onPlay event.
      • removeOnPlayListener

        public void removeOnPlayListener​(VideoPlayerEvents.OnPlayListener listener)
        Removes an OnPlayListener.
        Parameters:
        listener - the listener to remove for the OnPlay event.
      • addOnPauseListener

        public void addOnPauseListener​(VideoPlayerEvents.OnPauseListener listener)
        Adds an OnPauseListener.
        Parameters:
        listener - The listener to add for the onPause event.
      • removeOnPauseListener

        public boolean removeOnPauseListener​(VideoPlayerEvents.OnPauseListener listener)
        Removes an OnPauseListener.
        Parameters:
        listener - The listener to remove for the onPauseListener.
        Returns:
        true if the listener has been removed.
      • addOnBufferListener

        public void addOnBufferListener​(VideoPlayerEvents.OnBufferListener listener)
        Adds an OnBufferListener.
        Parameters:
        listener - The listener to add for the onBuffer event.
      • removeOnBufferListener

        public boolean removeOnBufferListener​(VideoPlayerEvents.OnBufferListener listener)
        Removes an OnBufferListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnIdleListener

        public void addOnIdleListener​(VideoPlayerEvents.OnIdleListener listener)
        Adds an OnIdleListener.
        Parameters:
        listener - The listener to add for the onIdle event.
      • removeOnIdleListener

        public boolean removeOnIdleListener​(VideoPlayerEvents.OnIdleListener listener)
        Removes an OnIdleListener.
        Parameters:
        listener - the listener to remove for the OnIdle event.
        Returns:
        true if the listener has been removed.
      • addOnErrorListener

        public void addOnErrorListener​(VideoPlayerEvents.OnErrorListener listener)
        Adds an OnErrorListener.
        Parameters:
        listener - The listener to add for the onError event.
      • removeOnErrorListener

        public boolean removeOnErrorListener​(VideoPlayerEvents.OnErrorListener listener)
        Removes an OnErrorListener.
        Parameters:
        listener - the listener to remove for the onError event.
        Returns:
        true if the listener has been removed.
      • addOnWarningListener

        public void addOnWarningListener​(VideoPlayerEvents.OnWarningListener listener)
        Adds an OnWarningListener.
        Parameters:
        listener - The listener to add for the onWarning event.
      • removeOnWarningListener

        public boolean removeOnWarningListener​(VideoPlayerEvents.OnWarningListener listener)
        Removes an OnWarningListener.
        Parameters:
        listener - the listener to remove for the onError event.
        Returns:
        true if the listener has been removed.
      • addOnSeekListener

        public void addOnSeekListener​(VideoPlayerEvents.OnSeekListener listener)
        Adds an OnSeekListener.
        Parameters:
        listener - The listener to ad for the onSeek event.
      • removeOnSeekListener

        public boolean removeOnSeekListener​(VideoPlayerEvents.OnSeekListener listener)
        Removes an OnSeekListener.
        Parameters:
        listener - the listener to remove for the onSeek event.
        Returns:
        true if the listener has been removed.
      • addOnTimeListener

        public void addOnTimeListener​(VideoPlayerEvents.OnTimeListener listener)
        Adds an OnTimeListener.
        Parameters:
        listener - The listener for the onTime event.
      • removeOnTimeListener

        public boolean removeOnTimeListener​(VideoPlayerEvents.OnTimeListener listener)
        Removes an OnTimeListener.
        Parameters:
        listener - The listener to remove for the onTime event.
        Returns:
        true if the listener has been removed.
      • addOnFullscreenListener

        public void addOnFullscreenListener​(VideoPlayerEvents.OnFullscreenListener listener)
        Adds an listener for the OnFullScreen event.
        Parameters:
        listener - The listener to add for the onFullscreen event.
      • removeOnFullscreenListener

        public boolean removeOnFullscreenListener​(VideoPlayerEvents.OnFullscreenListener listener)
        Removes an OnFullScreenListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnLevelsListener

        public void addOnLevelsListener​(VideoPlayerEvents.OnLevelsListener listener)
        Adds an OnLevelsListener.
        Parameters:
        listener - The listener to add for the onLevels event.
      • removeOnLevelsListener

        public boolean removeOnLevelsListener​(VideoPlayerEvents.OnLevelsListener listener)
        Removes an OnLevelsListener.
        Parameters:
        listener - The listener to add for the onLevels event.
        Returns:
        true if the listener has been removed.
      • addOnLevelsChangedListener

        public void addOnLevelsChangedListener​(VideoPlayerEvents.OnLevelsChangedListener listener)
        Adds an OnLevelsChangedListener.
        Parameters:
        listener - The listener to add for the onLevelsChanged event.
      • removeOnLevelsChangedListener

        public boolean removeOnLevelsChangedListener​(VideoPlayerEvents.OnLevelsChangedListener listener)
        Removes an OnLevelsChangedListener.
        Parameters:
        listener - the listener to remove for the OnLevelsChanged event.
        Returns:
        true if the listener has been removed.
      • addOnAudioTracksListener

        public void addOnAudioTracksListener​(VideoPlayerEvents.OnAudioTracksListener listener)
        Adds an OnAudioTracksListener.
        Parameters:
        listener - The listener to add for the onAudioTracks event.
      • removeOnAudioTracksListener

        public boolean removeOnAudioTracksListener​(VideoPlayerEvents.OnAudioTracksListener listener)
        Removes an OnAudioTracksListener.
        Parameters:
        listener - The listener to add for the OnAudioTracks Event.
        Returns:
        true if the listener has been removed.
      • addOnAudioTrackChangedListener

        public void addOnAudioTrackChangedListener​(VideoPlayerEvents.OnAudioTrackChangedListener listener)
        Adds an OnAudioTracksChangedListener.
        Parameters:
        listener - The listener to add for the OnAudioTrackChange event.
      • removeOnAudioTrackChangedListener

        public boolean removeOnAudioTrackChangedListener​(VideoPlayerEvents.OnAudioTrackChangedListener listener)
        Removes the given OnAudioTrackChanged listener.
        Parameters:
        listener - the listener to remove for the OnAudioTrackChanged event.
        Returns:
        true if the listener has been removed.
      • addOnMuteListener

        public void addOnMuteListener​(VideoPlayerEvents.OnMuteListener listener)
        Adds an OnMuteListener.
        Parameters:
        listener - the listener to add for the OnMute event.
      • removeOnMuteListener

        public boolean removeOnMuteListener​(VideoPlayerEvents.OnMuteListener listener)
        Removes a listener for the OnMute event.
        Parameters:
        listener - the listener to remove for the OnMute event.
        Returns:
        true if the listener has been removed.
      • addOnPlaybackRateChangedListener

        public void addOnPlaybackRateChangedListener​(VideoPlayerEvents.OnPlaybackRateChangedListener listener)
        Adds an OnPlaybackRateChangedListener.
        Parameters:
        listener - the listener to add for the OnPlaybackRateChanged event.
      • removeOnPlaybackRateChangedListener

        public void removeOnPlaybackRateChangedListener​(VideoPlayerEvents.OnPlaybackRateChangedListener listener)
        Removes a listener for the OnMute event.
        Parameters:
        listener - the listener to remove for the OnPlaybackRateChanged event.
      • addOnCaptionsListListener

        public void addOnCaptionsListListener​(VideoPlayerEvents.OnCaptionsListListener listener)
        Adds an listener for the CaptionsList event.
        Parameters:
        listener - The listener to add for the onCaptionsList event.
      • removeOnCaptionsListListener

        public boolean removeOnCaptionsListListener​(VideoPlayerEvents.OnCaptionsListListener listener)
        Removes an OnCaptionsListListener.
        Parameters:
        listener - the listener to remove from the OnCaptionsList event.
        Returns:
        true if the listener has been removed.
      • addOnCaptionsChangedListener

        public void addOnCaptionsChangedListener​(VideoPlayerEvents.OnCaptionsChangedListener listener)
        Adds an OnCaptionsChangedListener.
        Parameters:
        listener - The listener to add for the onCaptionsChanged event.
      • removeOnCaptionsChangedListener

        public boolean removeOnCaptionsChangedListener​(VideoPlayerEvents.OnCaptionsChangedListener listener)
        Removes an OnCaptionsChangedListener.
        Parameters:
        listener - the listener to remove from the OnCaptionsChanged event.
        Returns:
        true if the listener has been removed.
      • addOnAdClickListener

        public void addOnAdClickListener​(AdvertisingEvents.OnAdClickListener listener)
        Adds a listener for the OnAdClick event.
        Parameters:
        listener - The listener to add for the onAdClick event.
      • removeOnAdClickListener

        public boolean removeOnAdClickListener​(AdvertisingEvents.OnAdClickListener listener)
        Removes the listener from the OnAdClick event.
        Parameters:
        listener - the listener to remove from the OnAdClick event.
        Returns:
        true if the listener has been removed.
      • addOnAdCompleteListener

        public void addOnAdCompleteListener​(AdvertisingEvents.OnAdCompleteListener listener)
        Adds a listener for the OnAddComplete event.
        Parameters:
        listener - The listener to add for the onAdComplete event.
      • removeOnAdCompleteListener

        public boolean removeOnAdCompleteListener​(AdvertisingEvents.OnAdCompleteListener listener)
        Removes a listener for the OnAddComplete event.
        Parameters:
        listener - the listener to remove for the OnAddComplete event.
        Returns:
        true if the listener has been removed.
      • addOnAdSkippedListener

        public void addOnAdSkippedListener​(AdvertisingEvents.OnAdSkippedListener listener)
        Adds a listener for the OnAdSkipped event.
        Parameters:
        listener - The listener to add for the onAdSkipped event.
      • removeOnAdSkippedListener

        public boolean removeOnAdSkippedListener​(AdvertisingEvents.OnAdSkippedListener listener)
        Removes a listener for the OnAdSkipped event.
        Parameters:
        listener - the listener to remove for the OnAdSkipped event.
        Returns:
        true if the listener has been removed.
      • addOnAdErrorListener

        public void addOnAdErrorListener​(AdvertisingEvents.OnAdErrorListener listener)
        Adds a listener for the OnAdError Event.
        Parameters:
        listener - The listener to add for the onAdError event.
      • removeOnAdErrorListener

        public boolean removeOnAdErrorListener​(AdvertisingEvents.OnAdErrorListener listener)
        Removes an OnAdError listener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdWarningListener

        public void addOnAdWarningListener​(AdvertisingEvents.OnAdWarningListener listener)
        Adds a listener for the OnAdWarning Event.
        Parameters:
        listener - The listener to add for the onAdWarning event.
      • removeOnAdWarningListener

        public boolean removeOnAdWarningListener​(AdvertisingEvents.OnAdWarningListener listener)
        Removes an OnAdWarning listener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdImpressionListener

        public void addOnAdImpressionListener​(AdvertisingEvents.OnAdImpressionListener listener)
        Adds a listener for the OnAdImpression Event.
        Parameters:
        listener - The listener to add for the onAdImpression event.
      • removeOnAdImpressionListener

        public boolean removeOnAdImpressionListener​(AdvertisingEvents.OnAdImpressionListener listener)
        Removes a listener from the OnAdImpression event.
        Parameters:
        listener - the listener to remove for the OnAdImpression event.
        Returns:
        true if the listener has been removed.
      • addOnAdViewableImpressionListener

        public void addOnAdViewableImpressionListener​(AdvertisingEvents.OnAdViewableImpressionListener listener)
        Adds a listener for the OnAdViewableImpression Event.
        Parameters:
        listener - The listener to add for the onAdViewableImpression event.
      • removeOnAdViewableImpressionListener

        public boolean removeOnAdViewableImpressionListener​(AdvertisingEvents.OnAdViewableImpressionListener listener)
        Removes a listener from the OnAdViewableImpression event.
        Parameters:
        listener - the listener to remove for the OnAdViewableImpression event.
        Returns:
        true if the listener has been removed.
      • addOnAdTimeListener

        public void addOnAdTimeListener​(AdvertisingEvents.OnAdTimeListener listener)
        Adds a listener to the OnAdTime event.
        Parameters:
        listener - The listener to add for the onAdTime event.
      • removeOnAdTimeListener

        public boolean removeOnAdTimeListener​(AdvertisingEvents.OnAdTimeListener listener)
        Removes a listener from the OnAdTime event.
        Parameters:
        listener - the listener to add to the OnAdTime event.
        Returns:
        true if the listener has been removed.
      • addOnAdBreakStartListener

        public void addOnAdBreakStartListener​(AdvertisingEvents.OnAdBreakStartListener listener)
        Adds a listener to the OnAdBreakStart event.
        Parameters:
        listener - The listener to add for the onAdBreakStart event.
      • removeOnAdBreakStartListener

        public boolean removeOnAdBreakStartListener​(AdvertisingEvents.OnAdBreakStartListener listener)
        Removes a listener from the OnAdBreakStart event.
        Parameters:
        listener - the listener to add to the OnAdBreakStart event.
        Returns:
        true if the listener has been removed.
      • addOnAdBreakEndListener

        public void addOnAdBreakEndListener​(AdvertisingEvents.OnAdBreakEndListener listener)
        Adds a listener to the OnAdBreakEnd event.
        Parameters:
        listener - The listener to add for the onAdBreakEnd event.
      • removeOnAdBreakEndListener

        public boolean removeOnAdBreakEndListener​(AdvertisingEvents.OnAdBreakEndListener listener)
        Removes a listener from the OnAdBreakEnd event.
        Parameters:
        listener - the listener to add to the OnAdBreakEnd event.
        Returns:
        true if the listener has been removed.
      • addOnAdBreakIgnoredListener

        public void addOnAdBreakIgnoredListener​(AdvertisingEvents.OnAdBreakIgnoredListener listener)
        Adds a listener to the OnAdBreakIgnored event.
        Parameters:
        listener - The listener to add for the onAdBreakIgnored event.
      • removeOnAdBreakIgnoredListener

        public boolean removeOnAdBreakIgnoredListener​(AdvertisingEvents.OnAdBreakIgnoredListener listener)
        Removes a listener from the OnAdBreakIgnored event.
        Parameters:
        listener - the listener to add to the OnAdBreakIgnored event.
        Returns:
        true if the listener has been removed.
      • addOnAdPauseListener

        public void addOnAdPauseListener​(AdvertisingEvents.OnAdPauseListener listener)
        Adds a listener to the OnAdPause event.
        Parameters:
        listener - The listener to add for the onAdPause event.
      • removeOnAdPauseListener

        public boolean removeOnAdPauseListener​(AdvertisingEvents.OnAdPauseListener listener)
        Removes a listener from the OnAdPause event.
        Parameters:
        listener - the listener to remove from the OnAdPause event.
        Returns:
        true if the listener has been removed.
      • addOnAdPlayListener

        public void addOnAdPlayListener​(AdvertisingEvents.OnAdPlayListener listener)
        Adds a listener for the OnAdPlay event.
        Parameters:
        listener - The listener to add for the onAdPlay event.
      • removeOnAdPlayListener

        public boolean removeOnAdPlayListener​(AdvertisingEvents.OnAdPlayListener listener)
        Removes an OnAdPlayListener.
        Parameters:
        listener - The listener to remove from the OnAdPlay event.
        Returns:
        true if the listener has been removed.
      • addOnAdScheduleListener

        public void addOnAdScheduleListener​(AdvertisingEvents.OnAdScheduleListener listener)
        Adds a listener for the OnAdSchedule event.
        Parameters:
        listener - The listener to add for the onAdSchedule event.
      • removeOnAdScheduleListener

        public boolean removeOnAdScheduleListener​(AdvertisingEvents.OnAdScheduleListener listener)
        Removes an OnAdScheduleListener.
        Parameters:
        listener - The listener to remove from the OnAdSchedule event.
        Returns:
        true if the listener has been removed.
      • addOnMetaListener

        public void addOnMetaListener​(VideoPlayerEvents.OnMetaListener listener)
        Adds an OnMetaListener.
        Parameters:
        listener - The listener for the onMeta event.
      • removeOnMetaListener

        public boolean removeOnMetaListener​(VideoPlayerEvents.OnMetaListener listener)
        Removes an OnMetaListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnExternalMetadataListener

        public void addOnExternalMetadataListener​(VideoPlayerEvents.OnExternalMetadataListener listener)
        Adds an OnExternalMetadataListener.
        Parameters:
        listener - The listener for the onMeta event.
      • removeOnExternalMetadataListener

        public boolean removeOnExternalMetadataListener​(VideoPlayerEvents.OnExternalMetadataListener listener)
        Removes an OnExternalMetadataListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnPlaylistCompleteListener

        public void addOnPlaylistCompleteListener​(VideoPlayerEvents.OnPlaylistCompleteListener listener)
        Adds an OnPlaylistCompleteListener.
        Parameters:
        listener - The listener for the onPlaylistComplete event.
      • removeOnPlaylistCompleteListener

        public boolean removeOnPlaylistCompleteListener​(VideoPlayerEvents.OnPlaylistCompleteListener listener)
        Adds an listener to the OnPlaylistComplete event.
        Parameters:
        listener - the listener to remove from the event.
        Returns:
        true if the listener has been removed.
      • addOnCompleteListener

        public void addOnCompleteListener​(VideoPlayerEvents.OnCompleteListener listener)
        Adds an OnCompleteListener.
        Parameters:
        listener - The listener for the onComplete event.
      • removeOnCompleteListener

        public boolean removeOnCompleteListener​(VideoPlayerEvents.OnCompleteListener listener)
        Removes an OnCompleteListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnBeforePlayListener

        public void addOnBeforePlayListener​(AdvertisingEvents.OnBeforePlayListener listener)
        Adds an OnBeforePlayListener.
        Parameters:
        listener - The listener for the onBeforePlay event.
      • removeOnBeforePlayListener

        public boolean removeOnBeforePlayListener​(AdvertisingEvents.OnBeforePlayListener listener)
        Removes an OnBeforePlayListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnBeforeCompleteListener

        public void addOnBeforeCompleteListener​(AdvertisingEvents.OnBeforeCompleteListener listener)
        Adds an OnBeforeCompleteListener.
        Parameters:
        listener - The listener to add for the onBeforeComplete event.
      • removeOnBeforeCompleteListener

        public boolean removeOnBeforeCompleteListener​(AdvertisingEvents.OnBeforeCompleteListener listener)
        Removes an OnBeforeCompleteListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnFirstFrameListener

        public void addOnFirstFrameListener​(VideoPlayerEvents.OnFirstFrameListener listener)
        Adds an OnFirstFrameListener.
        Parameters:
        listener - The listener to add for the onFirstFrame event.
      • removeOnFirstFrameListener

        public boolean removeOnFirstFrameListener​(VideoPlayerEvents.OnFirstFrameListener listener)
        Removes an OnFirstFrameListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnViewableListener

        public void addOnViewableListener​(VideoPlayerEvents.OnViewableListener listener)
        Adds an OnViewableListener.
        Parameters:
        listener - The listener to add for the onFirstFrame event.
      • removeOnViewableListener

        public boolean removeOnViewableListener​(VideoPlayerEvents.OnViewableListener listener)
        Removes an OnViewableListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdMetaListener

        public void addOnAdMetaListener​(AdvertisingEvents.OnAdMetaListener listener)
        Adds an OnAdMetaListener.
        Parameters:
        listener - The listener to add for the onAdMeta event.
      • removeOnAdMetaListener

        public boolean removeOnAdMetaListener​(AdvertisingEvents.OnAdMetaListener listener)
        Removes an OnAdMetaListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnSeekedListener

        public void addOnSeekedListener​(VideoPlayerEvents.OnSeekedListener listener)
        Adds an OnSeekedListener.
        Parameters:
        listener - The listener to add for the onSeeked event.
      • removeOnSeekedListener

        public boolean removeOnSeekedListener​(VideoPlayerEvents.OnSeekedListener listener)
        Removes an OnSeekedListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnVisualQualityListener

        public void addOnVisualQualityListener​(VideoPlayerEvents.OnVisualQualityListener listener)
        Adds an OnVisualQualityListener.
        Parameters:
        listener - The listener to add for the onVisualQuality event.
      • removeOnVisualQualityListener

        public boolean removeOnVisualQualityListener​(VideoPlayerEvents.OnVisualQualityListener listener)
        Removes an OnVisualQualityListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnDisplayClickListener

        public void addOnDisplayClickListener​(VideoPlayerEvents.OnDisplayClickListener listener)
        Adds an OnDisplayClickListener.
        Parameters:
        listener - The listener to add for the onDisplayClick event.
      • removeOnDisplayClickListener

        public boolean removeOnDisplayClickListener​(VideoPlayerEvents.OnDisplayClickListener listener)
        Removes an OnDisplayClickListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdRequestListener

        public void addOnAdRequestListener​(AdvertisingEvents.OnAdRequestListener listener)
        Adds an OnAdRequestListener.
        Parameters:
        listener - The listener to add for the onAdRequest event.
      • removeOnAdRequestListener

        public boolean removeOnAdRequestListener​(AdvertisingEvents.OnAdRequestListener listener)
        Removes an OnAdRequestListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdStartedListener

        public void addOnAdStartedListener​(AdvertisingEvents.OnAdStartedListener listener)
        Adds an OnAdStartedListener.
        Parameters:
        listener - The listener to add for the onAdStarted event.
      • removeOnAdStartedListener

        public boolean removeOnAdStartedListener​(AdvertisingEvents.OnAdStartedListener listener)
        Removes an OnAdStartedListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnControlsListener

        public void addOnControlsListener​(VideoPlayerEvents.OnControlsListener listener)
        Adds an OnControlsListener.
        Parameters:
        listener - The listener for the onControls event.
      • removeOnControlsListener

        public boolean removeOnControlsListener​(VideoPlayerEvents.OnControlsListener listener)
        Removes an OnControlsListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnControlBarVisibilityListener

        public void addOnControlBarVisibilityListener​(VideoPlayerEvents.OnControlBarVisibilityListener listener)
        Adds an OnControlBarVisibilityListener.
        Parameters:
        listener - The listener for the onControlBarVisibility event.
      • removeOnControlBarVisibilityListener

        public boolean removeOnControlBarVisibilityListener​(VideoPlayerEvents.OnControlBarVisibilityListener listener)
        Removes an OnControlsListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnBufferChangeListener

        public void addOnBufferChangeListener​(VideoPlayerEvents.OnBufferChangeListener listener)
        Adds an OnBufferChangeListener.
        Parameters:
        listener - The listener for the onBufferChange event.
      • removeOnBufferChangeListener

        public boolean removeOnBufferChangeListener​(VideoPlayerEvents.OnBufferChangeListener listener)
        Removes an OnBufferChangeListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnAdCompanionsListener

        public void addOnAdCompanionsListener​(AdvertisingEvents.OnAdCompanionsListener listener)
        Adds an OnAdCompanionsListener.
        Parameters:
        listener - the Listener for the onAdCompanions event.
      • removeOnAdCompanionsListener

        public boolean removeOnAdCompanionsListener​(AdvertisingEvents.OnAdCompanionsListener listener)
        Removes an OnAdCompanionsListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnRelatedOpenListener

        public void addOnRelatedOpenListener​(RelatedPluginEvents.OnRelatedOpenListener listener)
        Adds an OnRelatedOpenListener.
        Parameters:
        listener - The listener for the onRelatedOpen event.
      • removeOnRelatedOpenListener

        public boolean removeOnRelatedOpenListener​(RelatedPluginEvents.OnRelatedOpenListener listener)
        Removes an OnRelatedOpenListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnRelatedCloseListener

        public void addOnRelatedCloseListener​(RelatedPluginEvents.OnRelatedCloseListener listener)
        Adds an OnRelatedCloseListener.
        Parameters:
        listener - The listener for the onRelatedClose event.
      • removeOnRelatedCloseListener

        public boolean removeOnRelatedCloseListener​(RelatedPluginEvents.OnRelatedCloseListener listener)
        Removes an OnRelatedCloseListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnRelatedPlayListener

        public void addOnRelatedPlayListener​(RelatedPluginEvents.OnRelatedPlayListener listener)
        Adds an OnRelatedPlayListener.
        Parameters:
        listener - The listener for the onRelatedPlay event.
      • removeOnRelatedPlayListener

        public boolean removeOnRelatedPlayListener​(RelatedPluginEvents.OnRelatedPlayListener listener)
        Removes an OnRelatedPlayListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnSharingOpenListener

        public void addOnSharingOpenListener​(SharingPluginEvents.OnSharingOpenListener listener)
        Adds an OnSharingOpenListener.
        Parameters:
        listener - The listener for the onSharingOpen event.
      • removeOnSharingOpenListener

        public boolean removeOnSharingOpenListener​(SharingPluginEvents.OnSharingOpenListener listener)
        Removes an OnSharingOpenListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnSharingCloseListener

        public void addOnSharingCloseListener​(SharingPluginEvents.OnSharingCloseListener listener)
        Adds an OnSharingCloseListener.
        Parameters:
        listener - The listener for the onSharingClose event.
      • removeOnSharingCloseListener

        public boolean removeOnSharingCloseListener​(SharingPluginEvents.OnSharingCloseListener listener)
        Removes an OnSharingCloseListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnSharingClickListener

        public void addOnSharingClickListener​(SharingPluginEvents.OnSharingClickListener listener)
        Adds an OnSharingClickListener.
        Parameters:
        listener - The listener for the onSharingClick event.
      • removeOnSharingClickListener

        public boolean removeOnSharingClickListener​(SharingPluginEvents.OnSharingClickListener listener)
        Removes an OnSharingClickListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnInPlaylistTimedMetadataListener

        public void addOnInPlaylistTimedMetadataListener​(VideoPlayerEvents.OnInPlaylistTimedMetadataListener listener)
        Adds an OnInPlaylistTimedMetadataListener.
        Parameters:
        listener - The listener for the onInPlaylistTimedMetadataListener event.
      • removeOnInPlaylistTimedMetadataListener

        public boolean removeOnInPlaylistTimedMetadataListener​(VideoPlayerEvents.OnInPlaylistTimedMetadataListener listener)
        Removes an OnInPlaylistTimedMetadataListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.
      • addOnEventMessageMetadataListener

        public void addOnEventMessageMetadataListener​(VideoPlayerEvents.OnEventMessageMetadataListener listener)
        Adds an OnEventMessageMetadataListener.
        Parameters:
        listener - The listener for the OnEventMessageMetadataListener event.
      • removeOnEventMessageMetadataListener

        public boolean removeOnEventMessageMetadataListener​(VideoPlayerEvents.OnEventMessageMetadataListener listener)
        Removes an OnEventMessageMetadataListener.
        Parameters:
        listener - the listener to remove.
        Returns:
        true if the listener has been removed.