MediaUnit Class |
Namespace: Veeplay.media.events
The MediaUnit type exposes the following members.
Name | Description | |
---|---|---|
addEvent | ||
addOverlay |
Adds an MediaOverlay object to the unit, to be rendered together.
| |
adjustForAbsoluteDuration | (Inherited from MediaEvent.) | |
adjustRelativeToDuration |
Translates percentual values set via setStartPoint to actual time intervals in seconds, relative to a specified total duration.
(Inherited from MediaEvent.) | |
clearOverlays |
Removes all currently connected overlays.
| |
copyWithZone | ||
dynamicEvents | ||
endPoint |
The time interval (in seconds) when the player needs to remove the overlay.
Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip's duration is available.
(Inherited from MediaEvent.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
events | ||
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
getState |
Get the current event state
(Inherited from MediaEvent.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
incrementStartAndEndPointsWithInterval |
Shifts air-time for an overlay by a defined amount of time.
(Inherited from MediaEvent.) | |
initWithURL | ||
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
needsToBeAdjustedRelativeToDuration |
Determines if an overlay has start points, end points or duration relative to the unit duration.
(Inherited from MediaEvent.) | |
onPreload | (Overrides MediaEventonPreload.) | |
onTrigger | (Overrides MediaEventonTrigger.) | |
onUnload | (Overrides MediaEventonUnload.) | |
onUpdate | (Overrides MediaEventonUpdate.) | |
overlays |
Returns an list containing all MediaOverlay objects currently connected to the unit.
| |
preload | (Inherited from MediaEvent.) | |
setEndPoint |
Sets the ending time point of the overlay.
(Inherited from MediaEvent.) | |
setEvents |
Connects an list of MediaEvent objects to the current unit (for example VastAdBreak objects)
| |
setOverlays |
Connects an list of MediaOverlay objects to the current unit.
| |
setStartPoint |
Sets the starting time point of the overlay.
(Inherited from MediaEvent.) | |
startPoint |
The time interval (in seconds) when the player needs to display the overlay.
Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip's duration is available.
(Inherited from MediaEvent.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
trigger | (Inherited from MediaEvent.) | |
unload | (Inherited from MediaEvent.) | |
updateState |
Update the event state
(Inherited from MediaEvent.) |
Name | Description | |
---|---|---|
_absoluteDuration | (Inherited from MediaEvent.) | |
_endPoint | (Inherited from MediaEvent.) | |
_positionedDynamicEvents | ||
_relativeEndPoint | (Inherited from MediaEvent.) | |
_relativeStartPoint | (Inherited from MediaEvent.) | |
_startPoint | (Inherited from MediaEvent.) | |
canReplay |
Defines whether the player can replay the current unit or not after it has ended in the playlist.
| |
controlsDisplay |
Defines how the controls bar will be displayed for the unit. See MediaUnitMediaControlsDisplay for possible values.
| |
controlsParameters |
The configuration for the controls bar overlay. Construct this using the configureFromDictionary() method of MediaBuilder.
| |
controlStyle |
Used to set the style of the controls
| |
debug |
Toggle to enable logs.
| |
displayFirstFrame |
Specifies if the first frame of the unit should be displayed until the unit is played
| |
dynamicPosition | (Inherited from MediaEvent.) | |
initialPlaybackTime |
Initial video playback time in seconds.
| |
loaded | (Inherited from MediaEvent.) | |
manager |
The associated registered unit manager of this unit (for example the Marlin Unit Manager for DRM encoding.)
| |
metadata |
A Dictionary containing the metadata associated with the unit.
| |
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.
| |
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.
| |
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.
| |
pinchToFullscreen |
Defines if pinch-to-fullscreen should be allowed.
| |
played | ||
preloadInterval |
Defines the number of seconds before the scheduled start point when the event
should receive the preload call.
(Inherited from MediaEvent.) | |
preloadPoint |
Set by the player to the current playback time in seconds, after the current event
begins preloading. Defaults to -1 if the event did not start preloading.
(Inherited from MediaEvent.) | |
renderer |
The renderer associated with this unit.
| |
repeatAfter |
If this parameter is greater than 0, then the event will be retriggered by the
MediaPlayer after the specific time interval (in seconds).
(Inherited from MediaEvent.) | |
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`.
| |
shouldAutoplay |
Defines if the unit should start playing as soon as it loads or wait for a play command.
| |
sourceAdBreak | ||
timeout |
Defines the maximum number of seconds the event is allowed to live once it has been
pretriggered, without setting the loaded property to true.
(Inherited from MediaEvent.) | |
trackingURLs |
This dictionary defines all URLs that need to be notified of specific events from the object's lifecycle. The keys are event constants, as defined in MediaPlayer (Inherited from MediaTrackableObject.) | |
url |
The video clip URL.
|
Name | Description | |
---|---|---|
StateChanged | (Inherited from MediaEvent.) | |
TimeoutEvent | (Inherited from MediaEvent.) |