MediaEvent Class

MediaEvent Class

The MediaEvent class describes a container that developers can use to instruct the player to run specific blocks of code at specific moments of time. Objects extending and implementing this class can be added to the player's main queue and can also be attached to a specific MediaUnit object, for runtime triggering.

Inheritance Hierarchy

SystemObject
  Veeplay.mediaMediaTrackableObject
    Veeplay.media.eventsMediaEvent
      Veeplay.media.eventsMediaOverlay
      Veeplay.media.eventsMediaUnit
      Veeplay.media.eventsVastAdBreak

Namespace: Veeplay.media.events
Assembly: Veeplay (in Veeplay.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public abstract class MediaEvent : MediaTrackableObject

Public MustInherit Class MediaEvent
	Inherits MediaTrackableObject

public ref class MediaEvent abstract : public MediaTrackableObject

[<AbstractClassAttribute>]
type MediaEvent =  
    class
        inherit MediaTrackableObject
    end

The MediaEvent type exposes the following members.

Constructors

	Name	Description
	MediaEvent	Initializes a new instance of the MediaEvent class

Top

Methods

	Name	Description
	adjustForAbsoluteDuration
	adjustRelativeToDuration	Translates percentual values set via setStartPoint to actual time intervals in seconds, relative to a specified total duration.
	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.
	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
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	incrementStartAndEndPointsWithInterval	Shifts air-time for an overlay by a defined amount of time.
	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.
	onPreload	This method will be invoked on a different thread by the player, before the event start point, as set by the preTriggerInterval field.
	onTrigger	This code will be executed once the event is triggered by the player.
	onUnload	This method will be invoked by the player once the event has reached the end point and will be deallocated.
	onUpdate	This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
	preload
	setEndPoint	Sets the ending time point of the overlay.
	setStartPoint	Sets the starting time point of the overlay.
	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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	trigger
	unload
	updateState	Update the event state

Top

Fields

	Name	Description
	_absoluteDuration
	_endPoint
	_relativeEndPoint
	_relativeStartPoint
	_startPoint
	dynamicPosition
	loaded
	preloadInterval	Defines the number of seconds before the scheduled start point when the event should receive the preload call.
	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.
	repeatAfter	If this parameter is greater than 0, then the event will be retriggered by the MediaPlayer after the specific time interval (in seconds).
	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.
	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.)

Top

Events

	Name	Description
	StateChanged
	TimeoutEvent

Top

Reference

Veeplay.media.events Namespace