APSMediaUnit

java.lang.Object
- com.appscend.media.APSMediaTrackableObject
- - com.appscend.media.events.APSMediaEvent
  - - com.appscend.media.events.APSMediaUnit

```
public class APSMediaUnit
extends APSMediaEvent
```
The APSMediaUnit class represents a clip that's ready to be rendered by the player. A media unit also references an array of APSMediaOverlay objects, defining the overlays connected to the unit.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`APSMediaUnit.APSHandleSeekEvent` Specifies how the unit should handle seeking through multiple ad breaks.
`static class`	`APSMediaUnit.APSMediaControlsDisplay` Specifies how the controls bar should be displayed for a media unit.

Nested classes/interfaces inherited from class com.appscend.media.events.APSMediaEvent
APSMediaEvent.APSMediaEventState

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`_positionedDynamicEvents`
`java.util.ArrayList<APSMediaUnit>`	`buffet` An array of other media units to be played instead of the current one, should an error be encountered.
`boolean`	`canReplay` Defines whether the player can replay the current unit or not after it has ended in the playlist.
`APSMediaUnit.APSMediaControlsDisplay`	`controlsDisplay` Defines how the controls bar will be displayed for the unit.
`java.util.HashMap<java.lang.String,java.lang.Object>`	`controlsParameters` The configuration for the controls bar overlay.
`static <any>`	`CREATOR`
`boolean`	`debug` Toggle to enable logs.
`int`	`initialPlaybackTime` Initial video playback time in seconds.
`java.lang.String`	`manager` The associated registered unit manager of this unit (for example the Marlin Unit Manager for DRM encoding.
`java.util.HashMap<java.lang.String,java.lang.Object>`	`metadata` A HashMap containing the metadata associated with the unit.
`int`	`midcontentAdMinimumFinalOffset` For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free.
`int`	`midcontentAdMinimumInitialOffset` For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch.
`int`	`midcontentAdMinimumSpacing` For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches.
`boolean`	`pinchToFullscreen` Defines if pinch-to-fullscreen should be allowed.
`boolean`	`played`
`java.lang.String`	`renderer` The renderer associated with this unit.
`APSMediaUnit.APSHandleSeekEvent`	`seekHandling` Defines how mid content ads should be handled when the user has skipped over several batches.
`boolean`	`shouldAutoplay` Defines if the unit should start playing as soon as it loads or wait for a play command.
`APSVastAdBreak`	`sourceAdBreak`
`java.lang.String`	`subtitlesUrl` The URL of an SubRip subtitles file to be sideloaded
`java.lang.String`	`url` The video clip URL.

Fields inherited from class com.appscend.media.events.APSMediaEvent
dynamicPosition, loaded, preloadInterval, preloadPoint, repeatAfter, timeout

Fields inherited from class com.appscend.media.APSMediaTrackableObject
trackingURLs

Constructor Summary

Constructors
Modifier Constructor and Description

APSMediaUnit()

protected APSMediaUnit(Parcel in)

Constructors
Modifier	Constructor and Description
	`APSMediaUnit()`
`protected`	`APSMediaUnit(Parcel in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvent(APSMediaEvent event)`
`void`	`addOverlay(APSMediaOverlay overlay)` Adds an `APSMediaOverlay` object to the unit, to be rendered together.
`void`	`clearOverlays()` Removes all currently connected overlays.
`APSMediaUnit`	`copyWithZone()`
`int`	`describeContents()`
`java.util.ArrayList<APSMediaEvent>`	`dynamicEvents()`
`java.util.ArrayList<APSMediaEvent>`	`events()`
`void`	`initWithURL(java.lang.String url)`
`void`	`onPreload()` This method will be invoked on a different thread by the player, before the event start point, as set by the preTriggerInterval field.
`void`	`onTrigger()` This code will be executed once the event is triggered by the player.
`void`	`onUnload()` This method will be invoked by the player once the event has reached the end point and will be deallocated.
`void`	`onUpdate()` This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
`java.util.ArrayList<APSMediaOverlay>`	`overlays()` Returns an array containing all `APSMediaOverlay` objects currently connected to the unit.
`void`	`setEvents(java.util.ArrayList<java.lang.Object> events)` Connects an array of APSMediaEvent objects to the current unit (for example APSVastAdBreak objects)
`void`	`setOverlays(java.util.ArrayList<java.lang.Object> overlays)` Connects an array of `APSMediaOverlay` objects to the current unit.
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class com.appscend.media.events.APSMediaEvent
adjustForAbsoluteDuration, adjustRelativeToDuration, endPoint, getState, incrementStartAndEndPointsWithInterval, needsToBeAdjustedRelativeToDuration, preload, registerEventStateListener, registerTimeoutListener, setEndPoint, setStartPoint, startPoint, trigger, unload, unregisterEventStateListener, unregisterEventTimeoutListener, updateState

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

- Field Detail
  - url
```
public java.lang.String url
```
    The video clip URL.
  - subtitlesUrl
```
public java.lang.String subtitlesUrl
```
    The URL of an SubRip subtitles file to be sideloaded
  - initialPlaybackTime
```
public int initialPlaybackTime
```
    Initial video playback time in seconds.
  - controlsDisplay
```
public APSMediaUnit.APSMediaControlsDisplay controlsDisplay
```
    Defines how the controls bar will be displayed for the unit. See APSMediaControlsDisplay for possible values.
  - controlsParameters
```
public java.util.HashMap<java.lang.String,java.lang.Object> controlsParameters
```
    The configuration for the controls bar overlay. Construct this using the configurationFromDictionary: method of APSMediaPlayerControlsOverlayController.
  - buffet
```
public java.util.ArrayList<APSMediaUnit> buffet
```
    An array of other media units to be played instead of the current one, should an error be encountered. The unit at index 0 has the highest priority.
  - metadata
```
public java.util.HashMap<java.lang.String,java.lang.Object> metadata
```
    A HashMap containing the metadata associated with the unit.
  - pinchToFullscreen
```
public boolean pinchToFullscreen
```
    Defines if pinch-to-fullscreen should be allowed.
  - debug
```
public boolean debug
```
    Toggle to enable logs.
  - shouldAutoplay
```
public boolean shouldAutoplay
```
    Defines if the unit should start playing as soon as it loads or wait for a play command.
  - played
```
public boolean played
```
  - canReplay
```
public boolean canReplay
```
    Defines whether the player can replay the current unit or not after it has ended in the playlist.
  - manager
```
public java.lang.String manager
```
    The associated registered unit manager of this unit (for example the Marlin Unit Manager for DRM encoding.
  - seekHandling
```
public APSMediaUnit.APSHandleSeekEvent seekHandling
```
    Defines how mid content ads should be handled when the user has skipped over several batches. Use this parameter to instruct the player to render: only the first ad batch, only the last ad batch or all passed ad batches. Defaults to `APSHandleSeekEventPlayLastBreak`.
  - midcontentAdMinimumInitialOffset
```
public int midcontentAdMinimumInitialOffset
```
    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch. Defaults to 300 seconds.
  - midcontentAdMinimumFinalOffset
```
public int midcontentAdMinimumFinalOffset
```
    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free. Defaults to 300 seconds.
  - midcontentAdMinimumSpacing
```
public int midcontentAdMinimumSpacing
```
    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches. Defaults to 300 seconds.
  - renderer
```
public java.lang.String renderer
```
    The renderer associated with this unit. By default, the ExoPlayer renderer is used in 4.1+ and MediaPlayer for 4.0.x
  - _positionedDynamicEvents
```
public boolean _positionedDynamicEvents
```
  - sourceAdBreak
```
public APSVastAdBreak sourceAdBreak
```
  - CREATOR
```
public static final <any> CREATOR
```
- Constructor Detail
  - APSMediaUnit
```
public APSMediaUnit()
```
  - APSMediaUnit
```
protected APSMediaUnit(Parcel in)
```
- Method Detail
  - initWithURL
```
public void initWithURL(java.lang.String url)
```
  - addOverlay
```
public void addOverlay(APSMediaOverlay overlay)
```
    Adds an APSMediaOverlay object to the unit, to be rendered together.
    
    Parameters:
    
    overlay - The APSMediaPlayer object to be connected to the unit.
  - addEvent
```
public void addEvent(APSMediaEvent event)
```
  - setOverlays
```
public void setOverlays(java.util.ArrayList<java.lang.Object> overlays)
```
    Connects an array of APSMediaOverlay objects to the current unit.
    
    Parameters:
    
    overlays - An array of APSMediaOverlay objects to be connected to the unit.
  - setEvents
```
public void setEvents(java.util.ArrayList<java.lang.Object> events)
```
    Connects an array of APSMediaEvent objects to the current unit (for example APSVastAdBreak objects)
  - clearOverlays
```
public void clearOverlays()
```
    Removes all currently connected overlays.
  - overlays
```
public java.util.ArrayList<APSMediaOverlay> overlays()
```
    Returns an array containing all APSMediaOverlay objects currently connected to the unit.
    
    Returns:
    
    An array of APSMediaOverlay objects.
  - events
```
public java.util.ArrayList<APSMediaEvent> events()
```
  - dynamicEvents
```
public java.util.ArrayList<APSMediaEvent> dynamicEvents()
```
  - copyWithZone
```
public APSMediaUnit copyWithZone()
```
  - onPreload
```
public void onPreload()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked on a different thread by the player, before the event start point, as set by the preTriggerInterval field.
    
    Specified by:
    
    onPreload in class APSMediaEvent
  - onTrigger
```
public void onTrigger()
```
    Description copied from class: APSMediaEvent
    
    This code will be executed once the event is triggered by the player.
    
    Specified by:
    
    onTrigger in class APSMediaEvent
  - onUnload
```
public void onUnload()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked by the player once the event has reached the end point and will be deallocated.
    
    Specified by:
    
    onUnload in class APSMediaEvent
  - onUpdate
```
public void onUpdate()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
    
    Specified by:
    
    onUpdate in class APSMediaEvent
  - describeContents
```
public int describeContents()
```
    Overrides:
    
    describeContents in class APSMediaEvent
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
    Overrides:
    
    writeToParcel in class APSMediaEvent

Class APSMediaUnit

Nested Class Summary

Nested classes/interfaces inherited from class com.appscend.media.events.APSMediaEvent

Field Summary

Fields inherited from class com.appscend.media.events.APSMediaEvent

Fields inherited from class com.appscend.media.APSMediaTrackableObject

Constructor Summary

Method Summary

Methods inherited from class com.appscend.media.events.APSMediaEvent

Methods inherited from class java.lang.Object

Field Detail

url

subtitlesUrl

initialPlaybackTime

controlsDisplay

controlsParameters

buffet

metadata

pinchToFullscreen

debug

shouldAutoplay

played

canReplay

manager

seekHandling

midcontentAdMinimumInitialOffset

midcontentAdMinimumFinalOffset

midcontentAdMinimumSpacing

renderer

_positionedDynamicEvents

sourceAdBreak

CREATOR

Constructor Detail

APSMediaUnit

APSMediaUnit

Method Detail

initWithURL

addOverlay

addEvent

setOverlays

setEvents

clearOverlays

overlays

events

dynamicEvents

copyWithZone

onPreload

onTrigger

onUnload

onUpdate

describeContents

writeToParcel