MediaOverlay Class |
Namespace: Veeplay.media.events
The MediaOverlay type exposes the following members.
Name | Description | |
---|---|---|
MediaOverlay | Initializes a new instance of the MediaOverlay class |
Name | Description | |
---|---|---|
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.) | |
cloneOverlay |
Creates a clone of the MediaOverlay object
| |
computeDimensions |
Compute overlay width and height
| |
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.) | |
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.) | |
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.) | |
preload | (Inherited from MediaEvent.) | |
removeOverlay | ||
setEndPoint |
Sets the ending time point of the overlay.
(Inherited from MediaEvent.) | |
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.) | |
_relativeEndPoint | (Inherited from MediaEvent.) | |
_relativeStartPoint | (Inherited from MediaEvent.) | |
_startPoint | (Inherited from MediaEvent.) | |
absoluteOffsetX |
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.
| |
absoluteOffsetY |
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.
| |
controller |
A reference to the overlay controller object. This is set by the player, on the overlay's initial render.
| |
dynamicPosition | (Inherited from MediaEvent.) | |
fadeInDuration |
The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.
| |
height |
The height of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total height (e.g.: "50%").
| |
loaded | (Inherited from MediaEvent.) | |
metadata |
A Dictionary containing the metadata associated with the overlay
| |
MetadataType | ||
parameters |
Overlay parameters. Implementation-specific to overlay controllers.
| |
parentUnit |
After being added to a MediaUnit object, a reference to this parent can be found here.
| |
position |
Describes the position the overlay should take when placed on-screen by the player.See MediaOverlayMediaOverlayPosition for available values.
| |
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.) | |
repeatAfter |
If this parameter is greater than 0, then the overlay will be re-shown by the MediaPlayer after the specific time interval (in seconds).
| |
shouldBeRemoved | ||
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.) | |
type | ||
width |
The width of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total width (e.g.: "50%").
| |
zIndex |
The order of the overlay in the current view stack.
|
Name | Description | |
---|---|---|
StateChanged | (Inherited from MediaEvent.) | |
TimeoutEvent | (Inherited from MediaEvent.) |