Click or drag to resize
MediaUnit Class
The MediaUnit class represents a clip that's ready to be rendered by the player. A media unit also references an list of MediaOverlay objects, defining the overlays connected to the unit.
Inheritance Hierarchy

Namespace: Veeplay.media.events
Assembly: Veeplay (in Veeplay.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class MediaUnit : MediaEvent

The MediaUnit type exposes the following members.

Constructors
  NameDescription
Public methodMediaUnit
Initializes a new instance of the MediaUnit class
Top
Methods
  NameDescription
Public methodaddEvent
Public methodaddOverlay
Adds an MediaOverlay object to the unit, to be rendered together.
Public methodadjustForAbsoluteDuration (Inherited from MediaEvent.)
Public methodadjustRelativeToDuration
Translates percentual values set via setStartPoint to actual time intervals in seconds, relative to a specified total duration.
(Inherited from MediaEvent.)
Public methodclearOverlays
Removes all currently connected overlays.
Public methodcopyWithZone
Public methoddynamicEvents
Public methodendPoint
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.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodevents
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodgetState
Get the current event state
(Inherited from MediaEvent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodincrementStartAndEndPointsWithInterval
Shifts air-time for an overlay by a defined amount of time.
(Inherited from MediaEvent.)
Public methodinitWithURL
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodneedsToBeAdjustedRelativeToDuration
Determines if an overlay has start points, end points or duration relative to the unit duration.
(Inherited from MediaEvent.)
Public methodonPreload (Overrides MediaEventonPreload.)
Public methodonTrigger (Overrides MediaEventonTrigger.)
Public methodonUnload (Overrides MediaEventonUnload.)
Public methodonUpdate (Overrides MediaEventonUpdate.)
Public methodoverlays
Returns an list containing all MediaOverlay objects currently connected to the unit.
Public methodpreload (Inherited from MediaEvent.)
Public methodsetEndPoint
Sets the ending time point of the overlay.
(Inherited from MediaEvent.)
Public methodsetEvents
Connects an list of MediaEvent objects to the current unit (for example VastAdBreak objects)
Public methodsetOverlays
Connects an list of MediaOverlay objects to the current unit.
Public methodsetStartPoint
Sets the starting time point of the overlay.
(Inherited from MediaEvent.)
Public methodstartPoint
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodtrigger (Inherited from MediaEvent.)
Public methodunload (Inherited from MediaEvent.)
Public methodupdateState
Update the event state
(Inherited from MediaEvent.)
Top
Fields
  NameDescription
Protected field_absoluteDuration (Inherited from MediaEvent.)
Protected field_endPoint (Inherited from MediaEvent.)
Public field_positionedDynamicEvents
Protected field_relativeEndPoint (Inherited from MediaEvent.)
Protected field_relativeStartPoint (Inherited from MediaEvent.)
Protected field_startPoint (Inherited from MediaEvent.)
Public fieldcanReplay
Defines whether the player can replay the current unit or not after it has ended in the playlist.
Public fieldcontrolsDisplay
Defines how the controls bar will be displayed for the unit. See MediaUnitMediaControlsDisplay for possible values.
Public fieldcontrolsParameters
The configuration for the controls bar overlay. Construct this using the configureFromDictionary() method of MediaBuilder.
Public fieldcontrolStyle
Used to set the style of the controls
Public fielddebug
Toggle to enable logs.
Public fielddisplayFirstFrame
Specifies if the first frame of the unit should be displayed until the unit is played
Public fielddynamicPosition (Inherited from MediaEvent.)
Public fieldinitialPlaybackTime
Initial video playback time in seconds.
Protected fieldloaded (Inherited from MediaEvent.)
Public fieldmanager
The associated registered unit manager of this unit (for example the Marlin Unit Manager for DRM encoding.)
Public fieldmetadata
A Dictionary containing the metadata associated with the unit.
Public fieldmidcontentAdMinimumFinalOffset
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.
Public fieldmidcontentAdMinimumInitialOffset
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.
Public fieldmidcontentAdMinimumSpacing
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.
Public fieldpinchToFullscreen
Defines if pinch-to-fullscreen should be allowed.
Public fieldplayed
Public fieldpreloadInterval
Defines the number of seconds before the scheduled start point when the event should receive the preload call.
(Inherited from MediaEvent.)
Public fieldpreloadPoint
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.)
Public fieldrenderer
The renderer associated with this unit.
Public fieldrepeatAfter
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.)
Public fieldseekHandling
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`.
Public fieldshouldAutoplay
Defines if the unit should start playing as soon as it loads or wait for a play command.
Public fieldsourceAdBreak
Public fieldtimeout
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.)
Public fieldtrackingURLs
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.)
Public fieldurl
The video clip URL.
Top
Events
  NameDescription
Public eventStateChanged (Inherited from MediaEvent.)
Public eventTimeoutEvent (Inherited from MediaEvent.)
Top
See Also