Click or drag to resize
MediaOverlay Fields

The MediaOverlay type exposes the following members.

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
See Also