APSMediaPlayer

java.lang.Object
- com.appscend.hub.KRHub
- - com.appscend.media.APSMediaPlayer

All Implemented Interfaces:

APSMediaEventStateListener, APSMediaEventTimeoutListener, VolumeChangedInterface
```
public class APSMediaPlayer
extends KRHub
implements VolumeChangedInterface, APSMediaEventStateListener, APSMediaEventTimeoutListener
```
The APSMediaPlayer handles playback and rendering of APSMediaUnits and APSMediaOverlays.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`APSMediaPlayer.FullscreenOrientationBehaviour`
`static class`	`APSMediaPlayer.MPMovieFinishReason`
`static class`	`APSMediaPlayer.MPMoviePlaybackState`

Field Summary

Fields
Modifier and Type	Field and Description
`APSMediaUnit`	`_currentUnit`
`static java.lang.String`	`APSMoviePlayerControlsDisplayedNotification` Posted when the video controls bar becomes visible
`static java.lang.String`	`APSMoviePlayerControlsHiddenNotification` Posted when the video controls bar becomes hidden
`static java.lang.String`	`APSMoviePlayerStatusChangedNotification` Posted when the media player playback state has changed.
`static java.lang.String`	`APSMoviePlayerWasTappedNotification` Posted when the user taps on the media player surface
`HandlerThread`	`handlerThread`
`static java.lang.String`	`kAPSMediaPlayerDRMPluginsGroup`
`static java.lang.String`	`kAPSMediaPlayerFrameworkExtensionsGroup`
`static java.lang.String`	`kAPSMediaPlayerOverlayControllersGroup` The group name that overlay controllers must use when registering with the player.

Fields inherited from class com.appscend.hub.KRHub
kKRDefaultAdapterGroup

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOverlays(java.util.ArrayList<APSMediaOverlay> overlays)` Enqueues a series of overlays to be triggered in the current media unit.
`void`	`addTrackingEventListener(APSMediaPlayerTrackingEventListener listener)` Registers an event listener for receiving player events.
`void`	`back()` Proceeds to the previous unit in the playlist .
`void`	`computeSurfaceSize()` Recalculate the rendering surface size
`APSMediaOverlay`	`controlsOverlay()` Generates an APSMediaOverlay object for displaying the built-in controls on screen, based on the settings of the unit.
`int`	`currentPlaybackTime()` Returns the current playback time.
`APSMediaUnit`	`currentUnit()` Returns a copy of the currently playing media unit.
`int`	`duration()` Returns the current unit's video clip total duration.
`void`	`emitEvent(java.util.ArrayList<java.lang.String> urls, java.lang.String event, APSMediaTrackingEvents.MediaEventType type, Bundle additionalInfo, APSMediaEvent sourceEvent)` Sends an APSMediaTrackingEvent to all registered listeners
`void`	`enterFullscreen()`
`void`	`exitFullscreen()` Make the player exit full-screen mode
`void`	`finish()` Tears down all player resources, causing any currently playing units to stop and any tracking events to be issued.
`void`	`fireClickTrackingBeacons()` Request the firing of the click tracking beacons in case a non-standard ad overlay is used
`APSMediaPlayerActionDelegate`	`getActionDelegate()`
`Activity`	`getActivity()` Returns a reference to the Activity the player was initialized with.
`java.lang.String`	`getAdvertisingIdentifier()`
`java.lang.String`	`getAdvertisingIdentifierType()`
`long`	`getCachedPlaybackTime()`
`java.lang.String`	`getCurrentPlayingUrl()`
`Handler`	`getHandler()` Returns a reference to a Handler for posting tasks to the UI thread.
`okhttp3.OkHttpClient`	`getHttpClient()` The Veeplay SDK uses OkHttp for sending tracking requests back to the VAST enabled ad-servers.
`HTTPErrorsListener`	`getHttpErrorsListener()`
`static APSMediaPlayer`	`getInstance()` Returns the singleton `APSMediaPlayer` instance, creating it if necessary.
`int`	`getMainViewHeight()`
`int`	`getMainViewWidth()`
`RelativeLayout`	`getOverlayContainer()`
`java.lang.String`	`getPackageName()`
`java.util.List<APSMediaEvent>`	`getPlaylist()`
`RegulationInformation`	`getRegulationInformation()`
`Size`	`getSize()`
`java.lang.String`	`getUserAgent()`
`Location`	`getUserLocation()`
`java.lang.String`	`getYoutubeApiKey()` Getter for the YouTube API key, used by OverlayControllers to provide native YouTube integration
`void`	`hideControls()`
`void`	`hideHud()` Hides the player "loading" activity indicator.
`void`	`init(Activity activity, boolean statusBarVisible)` Initialize the Veeplay SDK.
`void`	`insertMediaUnits(java.util.ArrayList<APSMediaUnit> mediaUnits)` Inserts new media units after the current one, in the current playlist.
`boolean`	`isAllowConditionalAds()`
`boolean`	`isCurrentlyInFullscreenOverlayActivity()`
`boolean`	`isFullscreen()` Returns a boolean value specifing if the player is currently in fullscreen (read-only).
`boolean`	`isGoogleCastEnabled()` Check if Google Cast support is enabled
`static boolean`	`isInitialized()` Checks if the player was already previously initialized
`boolean`	`isLeaveFullscreenOnStop()`
`boolean`	`isPaused()`
`boolean`	`isPlaying()` Returns a Boolean value specifing if the player is currently playing a playlist of units (read-only).
`boolean`	`isPreferExoPlayer2()`
`boolean`	`isPreferGoogleIma()` Check if the Google IMA SDK is enabled (replacing Veeplay VAST parser)
`boolean`	`isPreferMediaPlayerRenderer()`
`boolean`	`isProcessing()` Returns a Boolean value specifing if the player is currently rendering a playlist of units (read-only).
`boolean`	`isRestrictRootedAccess()`
`boolean`	`isSecureSurfaceView()` Check if the surface view is secured from capture
`boolean`	`isSeeking()` Method for checking if the player is currently doing a seek operation
`boolean`	`isStreamingUrl(java.lang.String url)` Method for determining if an URL represents a stream or not
`boolean`	`isViewable()` Checks if the Veeplay container is currently on-screen and un-obscured by any other views
`void`	`loadStatePlayable()` Once the active renderer has started playback, this method handles the triggering of the correct tracking events, as well as starting the internal state timer.
`void`	`log(java.lang.String message)` Posts a message to LogCat
`boolean`	`movieSourceTypeIsLiveStream()`
`void`	`next()` Proceeds to the next unit in the playlist and sends an exit event.
`void`	`notifySeekFinished()` Used by renderers to notify that they have completed a seek operation.
`void`	`onActivityPaused()` Signals that the bound activity has entered the "paused" state
`void`	`onActivityResumed()` Signals that the bound activity has entered the "resumed" state
`void`	`onEventStateChanged(APSMediaEvent event, APSMediaEvent.APSMediaEventState newEventState)` A listener for the current state of the events in the current unit.
`void`	`onEventTimeout(APSMediaEvent event)` A handler for APSMediaEvents that timeout during their preloading
`boolean`	`openURL(java.lang.String url)` Instructs the player that a new URL needs to be interpreted and executed.
`void`	`orientationWillChange()` Signals to the player that the orientation of the device is changing
`void`	`pause()` Pauses playback of the current unit.
`void`	`performPostTapAction()` Call this method in the onActivityResult callback of the activity linked to the player.
`void`	`play()` Starts playback of the current unit.
`int`	`playableDuration(int duration)` Returns the current unit's video clip playable duration (the time interval that has already buffered and is ready for playback).
`void`	`playAlreadySetMediaUnits()`
`APSMediaPlayer.MPMoviePlaybackState`	`playbackState()` Returns the current unit's playback state.
`void`	`playbackStateChanged(APSMediaPlayer.MPMoviePlaybackState newState, boolean track)`
`void`	`playbackStateChanged(APSMediaPlayer.MPMoviePlaybackState newState, boolean track, Bundle additionalInfo)` Method for transitioning the player between various playback states (paused / playing / seeking, for example)
`IVeeplayRenderer`	`player()` All Veeplay renderers (MediaPlayer, ExoPlayer, GoogleCast or any custom renderer) implement the common interface IVeeplayRenderer
`void`	`playerTapped()` Signals to that the player view was tapped (for example for hiding the on-screen controls)
`void`	`playMediaUnits(java.util.ArrayList<APSMediaEvent> mediaUnits)` Sets and begins playback of an array of media units.
`void`	`playVideo(java.lang.String url)` With a currently running content unit, start playback of another stream
`void`	`removeAllTrackingEventListeners()` Removes all currently registered listeners.
`void`	`removeMediaUnits(java.util.List<APSMediaEvent> units)` Removes a list of media units from the playlist
`void`	`removeTrackingEventListener(APSMediaPlayerTrackingEventListener listener)` Removes a registered event listener.
`void`	`replaceCurrentUnitWithUnits(java.util.ArrayList<APSMediaUnit> units)` Replaces the currently playing APSMediaUnit with a collection of media units.
`void`	`resetDisplayedOverlays()` Repositions all currently displayed overlays
`void`	`resumePlay()` Restarts playback
`void`	`seekTo(int pos)` Sets the current playback time.
`void`	`setActionDelegate(APSMediaPlayerActionDelegate actionDelegate)`
`void`	`setAdvancedViewabilityTracking(boolean isEnabled)` Enable more advanced viewability tracking that takes the entire hierarchy into account
`void`	`setAdvertisingIdentifier(java.lang.String advertisingIdentifier)`
`void`	`setAdvertisingIdentifierType(java.lang.String advertisingIdentifierType)`
`void`	`setAllowConditionalAds(boolean allowConditionalAds)`
`void`	`setAutoPauseWhenNotVisible(boolean isEnabled)` Automatically pause playback if the player container is not viewable
`void`	`setCurrentlyInFullscreenOverlayActivity(boolean currentlyInFullscreenOverlayActivity)`
`void`	`setFullscreenOrientationBehaviour(APSMediaPlayer.FullscreenOrientationBehaviour fullscreenOrientationBehaviour)`
`void`	`setGoogleCastEnabled()` Enable Google Cast Media Route Button in all content units automatically
`void`	`setHttpErrorsListener(HTTPErrorsListener httpErrorsListener)`
`void`	`setInlineModeParent(ViewGroup parent)`
`void`	`setLeaveFullscreenOnStop(boolean leaveFullscreenOnStop)`
`void`	`setMediaUnits(java.util.ArrayList<APSMediaEvent> mediaUnits)` Sets new units to the playlist, clearing any old ones.
`void`	`setMute(boolean toMute)` Mutes or unmutes audio playback.
`void`	`setPlayableDuration(int duration)` Method for setting the currently buffered duration
`void`	`setPlayExternalOverlaysFullscreen(boolean fullscreenMode)`
`void`	`setPreferExoPlayer2(boolean preferExoPlayer2)`
`void`	`setPreferGoogleIma(boolean preferGoogleIma)` Enable or disable Google IMA VAST parser support.
`void`	`setPreferMediaPlayerRenderer(boolean preferMediaPlayer)`
`void`	`setRegulationInformation(RegulationInformation regulationInformation)`
`void`	`setRestrictRootedAccess(boolean restrictRootedAccess)`
`void`	`setSecureSurfaceView(boolean is_secure)` Method for preventing the player SurfaceView from being captured in a screenshot or on unsecure screens.
`void`	`setSize(int width, int height)` Sets the size of the main player container.
`void`	`setUserAgent(java.lang.String newUserAgent)`
`void`	`setUserLocation(Location userLocation)`
`void`	`setVolume(float volume)` Set the current playback audio volume.
`void`	`setYouTubeApiKey(java.lang.String apiKey)` Method for setting the YouTube API key (useful only if there are any YouTubeOverlayControllers used).
`boolean`	`shouldAutoplay()` Checks if currentUnit is not null
`void`	`showControls()`
`void`	`showHud()` Shows the player "loading" activity indicator.
`void`	`skip()` Proceeds to the next unit in the playlist and sends a skip event.
`void`	`step()` Silently proceeds to the next unit in the playlist.
`void`	`stop()` Stops playback of the current unit.
`void`	`switchRenderer()` Method for switching the current renderer to the next highest priority rendererer.
`void`	`toggleFullscreen()` Toggle the current fullscreen status.
`void`	`trackforEvent(java.util.ArrayList<java.lang.String> urls, java.lang.String event, APSMediaTrackingEvents.MediaEventType type, APSMediaEvent sourceEvent)`
`void`	`trackforEvent(java.util.ArrayList<java.lang.String> urls, java.lang.String event, APSMediaTrackingEvents.MediaEventType type, APSMediaEvent sourceEvent, boolean emitEvent)`
`void`	`trackforEvent(java.util.ArrayList<java.lang.String> urls, java.lang.String event, APSMediaTrackingEvents.MediaEventType type, APSMediaEvent sourceEvent, boolean emitEvent, Bundle additionalInfo)` Sends tracking information to one or more servers.
`void`	`unitFinished(APSMediaPlayer.MPMovieFinishReason reason)` Handles the tear-down of the currently playing unit when it finishes (either because of unit completion, or because an error has occured or the unit is being skipped).
`void`	`userPinched(float scale)` Handle a pinch action on the player view, toggling full screen mode on.
`ViewGroup`	`viewController()` The container `View` of the player.
`void`	`volumeChanged(int volume)` Detects changes in the current system audio volume and triggers any relevant VAST events.

Methods inherited from class com.appscend.hub.KRHub
adapterForType, adapterForTypeInGroup, adaptersForGroup, registerAdapter, registerAdapterInGroup, registerClass, registerClassInGroup

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

- Field Detail
  - kAPSMediaPlayerOverlayControllersGroup
```
public static final java.lang.String kAPSMediaPlayerOverlayControllersGroup
```
    The group name that overlay controllers must use when registering with the player.
    
    See Also:
    
    Constant Field Values
  - kAPSMediaPlayerFrameworkExtensionsGroup
```
public static final java.lang.String kAPSMediaPlayerFrameworkExtensionsGroup
```
    See Also:
    
    Constant Field Values
  - kAPSMediaPlayerDRMPluginsGroup
```
public static final java.lang.String kAPSMediaPlayerDRMPluginsGroup
```
    See Also:
    
    Constant Field Values
  - APSMoviePlayerWasTappedNotification
```
public static final java.lang.String APSMoviePlayerWasTappedNotification
```
    Posted when the user taps on the media player surface
    
    See Also:
    
    Constant Field Values
  - APSMoviePlayerControlsDisplayedNotification
```
public static final java.lang.String APSMoviePlayerControlsDisplayedNotification
```
    Posted when the video controls bar becomes visible
    
    See Also:
    
    Constant Field Values
  - APSMoviePlayerControlsHiddenNotification
```
public static final java.lang.String APSMoviePlayerControlsHiddenNotification
```
    Posted when the video controls bar becomes hidden
    
    See Also:
    
    Constant Field Values
  - APSMoviePlayerStatusChangedNotification
```
public static final java.lang.String APSMoviePlayerStatusChangedNotification
```
    Posted when the media player playback state has changed. You can immediately get the new state using the playbackState method of the APSMediaPlayer instance.
    
    See Also:
    
    Constant Field Values
  - _currentUnit
```
public APSMediaUnit _currentUnit
```
  - handlerThread
```
public final HandlerThread handlerThread
```
- Method Detail
  - isProcessing
```
public boolean isProcessing()
```
    Returns a Boolean value specifing if the player is currently rendering a playlist of units (read-only).
  - getInstance
```
public static APSMediaPlayer getInstance()
```
    Returns the singleton APSMediaPlayer instance, creating it if necessary.
    
    Returns:
    
    The shared APSMediaPlayer instance
  - getActivity
```
public Activity getActivity()
```
    Returns a reference to the Activity the player was initialized with.
    
    Returns:
    
    a reference to the Activity the player was initialized with.
  - getHandler
```
public Handler getHandler()
```
    Returns a reference to a Handler for posting tasks to the UI thread.
    
    Returns:
    
    a Handler reference
  - controlsOverlay
```
public APSMediaOverlay controlsOverlay()
```
    Generates an APSMediaOverlay object for displaying the built-in controls on screen, based on the settings of the unit.
    
    Returns:
    
    a fully configured controls APSMediaOverlay object.
  - userPinched
```
public void userPinched(float scale)
```
    Handle a pinch action on the player view, toggling full screen mode on.
    
    Parameters:
    
    scale - the scale at which the pinch gesture was performed
  - isFullscreen
```
public boolean isFullscreen()
```
    Returns a boolean value specifing if the player is currently in fullscreen (read-only).
  - toggleFullscreen
```
public void toggleFullscreen()
```
    Toggle the current fullscreen status.
  - enterFullscreen
```
public void enterFullscreen()
```
  - setInlineModeParent
```
public void setInlineModeParent(ViewGroup parent)
```
  - exitFullscreen
```
public void exitFullscreen()
```
    Make the player exit full-screen mode
  - init
```
public void init(Activity activity,
                 boolean statusBarVisible)
```
    Initialize the Veeplay SDK. This should be done as early as possible in the Activity lifecycle. Init should be always called when starting the application or if finish() was previously called and the player should be reused.
    
    Parameters:
    
    activity - the Activity the player is bound to
    
    statusBarVisible - whether the height of the OS status bar should be taken into account when layouting
  - playerTapped
```
public void playerTapped()
```
    Signals to that the player view was tapped (for example for hiding the on-screen controls)
  - showControls
```
public void showControls()
```
  - hideControls
```
public void hideControls()
```
  - log
```
public void log(java.lang.String message)
```
    Posts a message to LogCat
    
    Parameters:
    
    message - The message to be posted
  - trackforEvent
```
public void trackforEvent(java.util.ArrayList<java.lang.String> urls,
                          java.lang.String event,
                          APSMediaTrackingEvents.MediaEventType type,
                          APSMediaEvent sourceEvent)
```
  - trackforEvent
```
public void trackforEvent(java.util.ArrayList<java.lang.String> urls,
                          java.lang.String event,
                          APSMediaTrackingEvents.MediaEventType type,
                          APSMediaEvent sourceEvent,
                          boolean emitEvent)
```
  - trackforEvent
```
public void trackforEvent(java.util.ArrayList<java.lang.String> urls,
                          java.lang.String event,
                          APSMediaTrackingEvents.MediaEventType type,
                          APSMediaEvent sourceEvent,
                          boolean emitEvent,
                          Bundle additionalInfo)
```
    Sends tracking information to one or more servers. All specified URLs will be requested via GET. See APSMediaTrackingEventsAPSMediaTrackingEvents for a list of supported event types.
    
    Parameters:
    
    urls - An array of String objects that should be pinged.
    
    event - A descriptive text of the events.
    
    type - The tracked event type. See APSMediaTrackingEvents.
    
    sourceEvent - The APSMediaUnit or APSMediaOverlay that triggered this event
  - getCurrentPlayingUrl
```
public java.lang.String getCurrentPlayingUrl()
```
    Returns:
    
    The URL currently being played by the player
  - shouldAutoplay
```
public boolean shouldAutoplay()
```
    Checks if currentUnit is not null
    
    Returns:
    
    _currentUnit.shouldAutoplay if currentUnit in not null, else returns true
  - currentUnit
```
public APSMediaUnit currentUnit()
```
    Returns a copy of the currently playing media unit.
    
    Returns:
    
    An APSMediaUnit object representing the current unit.
  - openURL
```
public boolean openURL(java.lang.String url)
```
    Instructs the player that a new URL needs to be interpreted and executed. This method will first ask the actionDelegate to respond to the given URL. If the actionDelegate declines to respond and the URL has a web scheme such as ('http:// or 'https://') then an in-app web browser window will be displayed modally.
    
    Parameters:
    
    url - The URL that needs to be loaded.
  - performPostTapAction
```
public void performPostTapAction()
```
    Call this method in the onActivityResult callback of the activity linked to the player. The resultCode received when returning from the Veeso Web Browser is always 999
  - playMediaUnits
```
public void playMediaUnits(java.util.ArrayList<APSMediaEvent> mediaUnits)
```
    Sets and begins playback of an array of media units.
    
    Parameters:
    
    mediaUnits - An array of APSMediaUnit objects.
  - playAlreadySetMediaUnits
```
public void playAlreadySetMediaUnits()
```
  - setSize
```
public void setSize(int width,
                    int height)
```
    Sets the size of the main player container.
    
    Parameters:
    
    width - in pixels
    
    height - in pixels
  - getSize
```
public Size getSize()
```
  - viewController
```
public ViewGroup viewController()
```
    The container View of the player.
  - player
```
public IVeeplayRenderer player()
```
    All Veeplay renderers (MediaPlayer, ExoPlayer, GoogleCast or any custom renderer) implement the common interface IVeeplayRenderer
    
    Returns:
    
    a reference to the currently active renderer
  - playbackStateChanged
```
public void playbackStateChanged(APSMediaPlayer.MPMoviePlaybackState newState,
                                 boolean track)
```
  - playbackStateChanged
```
public void playbackStateChanged(APSMediaPlayer.MPMoviePlaybackState newState,
                                 boolean track,
                                 Bundle additionalInfo)
```
    Method for transitioning the player between various playback states (paused / playing / seeking, for example)
    
    Parameters:
    
    newState - the new playback state the player is transitioning into
    
    track - whether to send tracking requests to relevant ad-servers or not.
  - playbackState
```
public APSMediaPlayer.MPMoviePlaybackState playbackState()
```
    Returns the current unit's playback state.
    
    Returns:
    
    The current playback state.
  - pause
```
public void pause()
```
    Pauses playback of the current unit.
  - resumePlay
```
public void resumePlay()
```
    Restarts playback
  - isPaused
```
public boolean isPaused()
```
    Returns:
    
    true if the playback is currently paused, false otherwise
  - play
```
public void play()
          throws LicenseInvalidException,
                 RootedPhoneException
```
    Starts playback of the current unit.
    
    Throws:
    
    LicenseInvalidException
    
    RootedPhoneException
  - stop
```
public void stop()
```
    Stops playback of the current unit.
  - currentPlaybackTime
```
public int currentPlaybackTime()
```
    Returns the current playback time.
    
    Returns:
    
    The current playback time.
  - playableDuration
```
public int playableDuration(int duration)
```
    Returns the current unit's video clip playable duration (the time interval that has already buffered and is ready for playback).
    
    Parameters:
    
    duration - - if the current video is shown through an overlay, this parameter will be multiplied by the result of the playableDuration method invoked on the overlay controller. Can be 0 in other cases;
    
    Returns:
    
    The video playable duration.
  - seekTo
```
public void seekTo(int pos)
```
    Sets the current playback time.
    
    Parameters:
    
    pos - The playback time to be set in ms.
  - duration
```
public int duration()
```
    Returns the current unit's video clip total duration.
    
    Returns:
    
    The video total duration.
  - isPlaying
```
public boolean isPlaying()
```
    Returns a Boolean value specifing if the player is currently playing a playlist of units (read-only).
  - movieSourceTypeIsLiveStream
```
public boolean movieSourceTypeIsLiveStream()
```
  - skip
```
public void skip()
```
    Proceeds to the next unit in the playlist and sends a skip event.
  - back
```
public void back()
```
    Proceeds to the previous unit in the playlist .
  - loadStatePlayable
```
public void loadStatePlayable()
```
    Once the active renderer has started playback, this method handles the triggering of the correct tracking events, as well as starting the internal state timer.
  - unitFinished
```
public void unitFinished(APSMediaPlayer.MPMovieFinishReason reason)
```
    Handles the tear-down of the currently playing unit when it finishes (either because of unit completion, or because an error has occured or the unit is being skipped). Progress to the next unit is triggered automatically.
    
    Parameters:
    
    reason - the reason the unit is being teared down
  - volumeChanged
```
public void volumeChanged(int volume)
```
    Detects changes in the current system audio volume and triggers any relevant VAST events.
    
    Specified by:
    
    volumeChanged in interface VolumeChangedInterface
    
    Parameters:
    
    volume - the current audio volume value
  - finish
```
public void finish()
```
    Tears down all player resources, causing any currently playing units to stop and any tracking events to be issued. Once finish is called, the player should be re-initialized before further use.
  - next
```
public void next()
```
    Proceeds to the next unit in the playlist and sends an exit event.
  - step
```
public void step()
```
    Silently proceeds to the next unit in the playlist. Used in cases such as midroll adbreaks triggering.
  - resetDisplayedOverlays
```
public void resetDisplayedOverlays()
```
    Repositions all currently displayed overlays
  - orientationWillChange
```
public void orientationWillChange()
```
    Signals to the player that the orientation of the device is changing
  - showHud
```
public void showHud()
```
    Shows the player "loading" activity indicator.
  - hideHud
```
public void hideHud()
```
    Hides the player "loading" activity indicator.
  - isStreamingUrl
```
public boolean isStreamingUrl(java.lang.String url)
```
    Method for determining if an URL represents a stream or not
    
    Parameters:
    
    url - the url to be used for determination
  - setYouTubeApiKey
```
public void setYouTubeApiKey(java.lang.String apiKey)
```
    Method for setting the YouTube API key (useful only if there are any YouTubeOverlayControllers used). Should be called before playing any YouTube units.
    
    Parameters:
    
    apiKey - - The Youtube API key obtained for the Google API Dashboard
  - getYoutubeApiKey
```
public java.lang.String getYoutubeApiKey()
```
    Getter for the YouTube API key, used by OverlayControllers to provide native YouTube integration
    
    Returns:
    
    The currently set YouTube API key
  - addTrackingEventListener
```
public void addTrackingEventListener(APSMediaPlayerTrackingEventListener listener)
```
    Registers an event listener for receiving player events.
    
    Parameters:
    
    listener - - An instance of a class implementing the APSMediaPlayerTrackingEventListener interface
  - removeTrackingEventListener
```
public void removeTrackingEventListener(APSMediaPlayerTrackingEventListener listener)
```
    Removes a registered event listener.
    
    Parameters:
    
    listener - - An instance of a class implementing the APSMediaPlayerTrackingEventListener interface
  - removeAllTrackingEventListeners
```
public void removeAllTrackingEventListeners()
```
    Removes all currently registered listeners.
  - getOverlayContainer
```
public RelativeLayout getOverlayContainer()
```
    Returns:
    
    a reference to the RelativeLayout containing the overlays
  - emitEvent
```
public void emitEvent(java.util.ArrayList<java.lang.String> urls,
                      java.lang.String event,
                      APSMediaTrackingEvents.MediaEventType type,
                      Bundle additionalInfo,
                      APSMediaEvent sourceEvent)
```
    Sends an APSMediaTrackingEvent to all registered listeners
    
    Parameters:
    
    urls - any associated tracking URLs
    
    event - the VAST string name of the event
    
    type - the APSMediaTrackingEvent.MediaEventType value for the event to notify
    
    additionalInfo - a collection of additional information to relay (for example the current playback time for a progress event)
  - onEventStateChanged
```
public void onEventStateChanged(APSMediaEvent event,
                                APSMediaEvent.APSMediaEventState newEventState)
```
    A listener for the current state of the events in the current unit. Detects preloaded events and queues their triggering.
    
    Specified by:
    
    onEventStateChanged in interface APSMediaEventStateListener
    
    Parameters:
    
    event - the event that has changed state
    
    newEventState - the state the event has transitioned to
  - onEventTimeout
```
public void onEventTimeout(APSMediaEvent event)
```
    A handler for APSMediaEvents that timeout during their preloading
    
    Specified by:
    
    onEventTimeout in interface APSMediaEventTimeoutListener
    
    Parameters:
    
    event - the event that has encountered the timeout
  - replaceCurrentUnitWithUnits
```
public void replaceCurrentUnitWithUnits(java.util.ArrayList<APSMediaUnit> units)
```
    Replaces the currently playing APSMediaUnit with a collection of media units. Useful for unpacking the ad breaks inside of a MediaUnit into a series of playable APSMediaUnits.
    
    Parameters:
    
    units - an ArrayList of units to replace the current unit with.
  - insertMediaUnits
```
public void insertMediaUnits(java.util.ArrayList<APSMediaUnit> mediaUnits)
```
    Inserts new media units after the current one, in the current playlist.
    
    Parameters:
    
    mediaUnits - An array of APSMediaUnit objects to be inserted into the playlist after the current unit.
  - setMediaUnits
```
public void setMediaUnits(java.util.ArrayList<APSMediaEvent> mediaUnits)
```
    Sets new units to the playlist, clearing any old ones.
    
    Parameters:
    
    mediaUnits - An array of APSMediaUnit objects to create a new playlist.
  - addOverlays
```
public void addOverlays(java.util.ArrayList<APSMediaOverlay> overlays)
```
    Enqueues a series of overlays to be triggered in the current media unit.
    
    Parameters:
    
    overlays - the overlays to be inserted into the queue
  - setSecureSurfaceView
```
public void setSecureSurfaceView(boolean is_secure)
```
    Method for preventing the player SurfaceView from being captured in a screenshot or on unsecure screens. Defaults to true. This method should be called before calling init()
    
    Parameters:
    
    is_secure - use true in order to secure the SurfaceView
  - isSecureSurfaceView
```
public boolean isSecureSurfaceView()
```
    Check if the surface view is secured from capture
    
    Returns:
    
    true if the surface view is running in protected mode
  - setPlayableDuration
```
public void setPlayableDuration(int duration)
```
    Method for setting the currently buffered duration
    
    Parameters:
    
    duration - the currently playable duration
  - getMainViewWidth
```
public int getMainViewWidth()
```
    Returns:
    
    the current width of the main view container
  - getMainViewHeight
```
public int getMainViewHeight()
```
    Returns:
    
    the current height of the main view container
  - playVideo
```
public void playVideo(java.lang.String url)
```
    With a currently running content unit, start playback of another stream
    
    Parameters:
    
    url - the stream URL
  - computeSurfaceSize
```
public void computeSurfaceSize()
```
    Recalculate the rendering surface size
  - onActivityPaused
```
public void onActivityPaused()
```
    Signals that the bound activity has entered the "paused" state
  - onActivityResumed
```
public void onActivityResumed()
```
    Signals that the bound activity has entered the "resumed" state
  - switchRenderer
```
public void switchRenderer()
```
    Method for switching the current renderer to the next highest priority rendererer. Useful if, for example, a Google Cast device was just connected.
  - setGoogleCastEnabled
```
public void setGoogleCastEnabled()
```
    Enable Google Cast Media Route Button in all content units automatically
  - isGoogleCastEnabled
```
public boolean isGoogleCastEnabled()
```
    Check if Google Cast support is enabled
  - getPlaylist
```
public java.util.List<APSMediaEvent> getPlaylist()
```
    Returns:
    
    a list of the currently queued media units
  - removeMediaUnits
```
public void removeMediaUnits(java.util.List<APSMediaEvent> units)
```
    Removes a list of media units from the playlist
    
    Parameters:
    
    units - the list of units to be removed
  - notifySeekFinished
```
public void notifySeekFinished()
```
    Used by renderers to notify that they have completed a seek operation.
  - isSeeking
```
public boolean isSeeking()
```
    Method for checking if the player is currently doing a seek operation
    
    Returns:
    
    true if the player is currently seeking
  - getHttpClient
```
public okhttp3.OkHttpClient getHttpClient()
```
    The Veeplay SDK uses OkHttp for sending tracking requests back to the VAST enabled ad-servers.
    
    Returns:
    
    The OkHttp client instance used for tracking requests
  - isInitialized
```
public static boolean isInitialized()
```
    Checks if the player was already previously initialized
    
    Returns:
    
    true if the player is initialized
  - setMute
```
public void setMute(boolean toMute)
```
    Mutes or unmutes audio playback.
    
    Parameters:
    
    toMute - - true for muting audio, false for unmute
  - setVolume
```
public void setVolume(float volume)
```
    Set the current playback audio volume.
    
    Parameters:
    
    volume - - a float between 0f and 1f
  - setFullscreenOrientationBehaviour
```
public void setFullscreenOrientationBehaviour(APSMediaPlayer.FullscreenOrientationBehaviour fullscreenOrientationBehaviour)
```
  - isViewable
```
public boolean isViewable()
```
    Checks if the Veeplay container is currently on-screen and un-obscured by any other views
    
    Returns:
    
    true or false
  - getCachedPlaybackTime
```
public long getCachedPlaybackTime()
```
  - isCurrentlyInFullscreenOverlayActivity
```
public boolean isCurrentlyInFullscreenOverlayActivity()
```
  - setCurrentlyInFullscreenOverlayActivity
```
public void setCurrentlyInFullscreenOverlayActivity(boolean currentlyInFullscreenOverlayActivity)
```
  - setUserAgent
```
public void setUserAgent(java.lang.String newUserAgent)
```
  - getUserAgent
```
public java.lang.String getUserAgent()
```
  - getActionDelegate
```
public APSMediaPlayerActionDelegate getActionDelegate()
```
  - setActionDelegate
```
public void setActionDelegate(APSMediaPlayerActionDelegate actionDelegate)
```
  - isPreferMediaPlayerRenderer
```
public boolean isPreferMediaPlayerRenderer()
```
  - setPreferMediaPlayerRenderer
```
public void setPreferMediaPlayerRenderer(boolean preferMediaPlayer)
```
  - isRestrictRootedAccess
```
public boolean isRestrictRootedAccess()
```
  - setRestrictRootedAccess
```
public void setRestrictRootedAccess(boolean restrictRootedAccess)
```
  - isPreferExoPlayer2
```
public boolean isPreferExoPlayer2()
```
  - setPreferExoPlayer2
```
public void setPreferExoPlayer2(boolean preferExoPlayer2)
```
  - getUserLocation
```
public Location getUserLocation()
```
  - setUserLocation
```
public void setUserLocation(Location userLocation)
```
  - getAdvertisingIdentifier
```
public java.lang.String getAdvertisingIdentifier()
```
  - setAdvertisingIdentifier
```
public void setAdvertisingIdentifier(java.lang.String advertisingIdentifier)
```
  - getAdvertisingIdentifierType
```
public java.lang.String getAdvertisingIdentifierType()
```
  - setAdvertisingIdentifierType
```
public void setAdvertisingIdentifierType(java.lang.String advertisingIdentifierType)
```
  - getRegulationInformation
```
public RegulationInformation getRegulationInformation()
```
  - setRegulationInformation
```
public void setRegulationInformation(RegulationInformation regulationInformation)
```
  - getPackageName
```
public java.lang.String getPackageName()
```
  - isAllowConditionalAds
```
public boolean isAllowConditionalAds()
```
  - setAllowConditionalAds
```
public void setAllowConditionalAds(boolean allowConditionalAds)
```
  - getHttpErrorsListener
```
public HTTPErrorsListener getHttpErrorsListener()
```
  - setHttpErrorsListener
```
public void setHttpErrorsListener(HTTPErrorsListener httpErrorsListener)
```
  - isLeaveFullscreenOnStop
```
public boolean isLeaveFullscreenOnStop()
```
  - setLeaveFullscreenOnStop
```
public void setLeaveFullscreenOnStop(boolean leaveFullscreenOnStop)
```
  - setPlayExternalOverlaysFullscreen
```
public void setPlayExternalOverlaysFullscreen(boolean fullscreenMode)
```
  - isPreferGoogleIma
```
public boolean isPreferGoogleIma()
```
    Check if the Google IMA SDK is enabled (replacing Veeplay VAST parser)
    
    Returns:
    
    true if Google IMA is selected
  - setPreferGoogleIma
```
public void setPreferGoogleIma(boolean preferGoogleIma)
```
    Enable or disable Google IMA VAST parser support.
    
    Parameters:
    
    preferGoogleIma - true if Google IMA should be used, false for Veeplay VAST parser
  - fireClickTrackingBeacons
```
public void fireClickTrackingBeacons()
```
    Request the firing of the click tracking beacons in case a non-standard ad overlay is used
  - setAdvancedViewabilityTracking
```
public void setAdvancedViewabilityTracking(boolean isEnabled)
```
    Enable more advanced viewability tracking that takes the entire hierarchy into account
    
    Parameters:
    
    isEnabled - - true if the advanced mode should be enabled, false otherwise
  - setAutoPauseWhenNotVisible
```
public void setAutoPauseWhenNotVisible(boolean isEnabled)
```
    Automatically pause playback if the player container is not viewable
    
    Parameters:
    
    isEnabled - - true if auto-pause should be enabled, false otherwise

Class APSMediaPlayer

Nested Class Summary

Field Summary

Fields inherited from class com.appscend.hub.KRHub

Method Summary

Methods inherited from class com.appscend.hub.KRHub

Methods inherited from class java.lang.Object

Field Detail

kAPSMediaPlayerOverlayControllersGroup

kAPSMediaPlayerFrameworkExtensionsGroup

kAPSMediaPlayerDRMPluginsGroup

APSMoviePlayerWasTappedNotification

APSMoviePlayerControlsDisplayedNotification

APSMoviePlayerControlsHiddenNotification

APSMoviePlayerStatusChangedNotification

_currentUnit

handlerThread

Method Detail

isProcessing

getInstance

getActivity

getHandler

controlsOverlay

userPinched

isFullscreen

toggleFullscreen

enterFullscreen

setInlineModeParent

exitFullscreen

init

playerTapped

showControls

hideControls

log

trackforEvent

trackforEvent

trackforEvent

getCurrentPlayingUrl

shouldAutoplay

currentUnit

openURL

performPostTapAction

playMediaUnits

playAlreadySetMediaUnits

setSize

getSize

viewController

player

playbackStateChanged

playbackStateChanged

playbackState

pause

resumePlay

isPaused

play

stop

currentPlaybackTime

playableDuration

seekTo

duration

isPlaying

movieSourceTypeIsLiveStream

skip

back

loadStatePlayable

unitFinished

volumeChanged

finish

next

step

resetDisplayedOverlays

orientationWillChange

showHud

hideHud

isStreamingUrl

setYouTubeApiKey

getYoutubeApiKey

addTrackingEventListener

removeTrackingEventListener

removeAllTrackingEventListeners