Click or drag to resize
MediaOverlay Class
MediaOverlay describes any overlay that the MediaPlayer instance needs to render during playback.
Inheritance Hierarchy

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

The MediaOverlay type exposes the following members.

Constructors
  NameDescription
Public methodMediaOverlay
Initializes a new instance of the MediaOverlay class
Top
Methods
  NameDescription
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 methodcloneOverlay
Creates a clone of the MediaOverlay object
Public methodcomputeDimensions
Compute overlay width and height
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.)
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.)
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 methodpreload (Inherited from MediaEvent.)
Public methodremoveOverlay
Public methodsetEndPoint
Sets the ending time point of the overlay.
(Inherited from MediaEvent.)
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.)
Protected field_relativeEndPoint (Inherited from MediaEvent.)
Protected field_relativeStartPoint (Inherited from MediaEvent.)
Protected field_startPoint (Inherited from MediaEvent.)
Public fieldabsoluteOffsetX
The overlay's absolute horizontal offset in pixels, relative to the current origin. The current origin is determined by the overlay's position parameter, while the positive direction is always toward the center of the player surface.
Public fieldabsoluteOffsetY
The overlay's absolute vertical offset in pixels, relative to the current origin. The current origin is determined by the overlay's position parameter, while the positive direction is always toward the center of the player surface.
Public fieldcontroller
A reference to the overlay controller object. This is set by the player, on the overlay's initial render.
Public fielddynamicPosition (Inherited from MediaEvent.)
Public fieldfadeInDuration
The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.
Public fieldheight
The height of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total height (e.g.: "50%").
Protected fieldloaded (Inherited from MediaEvent.)
Public fieldmetadata
A Dictionary containing the metadata associated with the overlay
Public fieldStatic memberMetadataType
Public fieldparameters
Overlay parameters. Implementation-specific to overlay controllers.
Public fieldparentUnit
After being added to a MediaUnit object, a reference to this parent can be found here.
Public fieldposition
Describes the position the overlay should take when placed on-screen by the player.See MediaOverlayMediaOverlayPosition for available values.
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 fieldrepeatAfter
If this parameter is greater than 0, then the overlay will be re-shown by the MediaPlayer after the specific time interval (in seconds).
Public fieldshouldBeRemoved
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 fieldtype
Public fieldwidth
The width of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total width (e.g.: "50%").
Public fieldzIndex
The order of the overlay in the current view stack.
Top
Events
  NameDescription
Public eventStateChanged (Inherited from MediaEvent.)
Public eventTimeoutEvent (Inherited from MediaEvent.)
Top
See Also