Returns the data for the event, which can differ based on the event type. See the event constants in this class for a description of the data object for each event type.

Constructor.

The OvpEvent.ASYNC_ERROR constant defines the value of the OvpEvent's type property, which indicates an OVP class has a received an AsyncErrorEvent.ASYNC_ERROR event. The event text is carried in the data object as a string.

The OvpEvent.BANDWIDTH constant defines the value of the OvpEvent's type property, which indicates the class has completed a bandwidth estimate. The bandwidth and latency values can be accessed via the data property, for example event.data.bandwidth and event.data.latency

See also

Closed caption event. The data property will be a Caption object.

See also

The OvpEvent.COMPLETE constant defines the value of the OvpEvent's type property, which indicates that the end of the stream has been reached. This event can only be used for streaming and (not progressive downloads) and is dispatched whenever the onPlayStatus callback function of the NetStream object issues a NetStream.Play.Complete code.

The RTMP protocol allows arbitrarily-named data messages to be embedded in both live and ondemand streams. Typically, to listen for these, a public callback function must be created on the client object associated with the NetStream. To avoid the rigidity of this system, with OVP you are able to subscribe to the DATA_MESSAGE event, which will carry the name and value associated with any non-standard data message. Standard data messages not included in this event (since they have their own custome events) include onMetaData, onCuePoint, onPlayStatus, onXMPData, onImageData, onTextData, onFI, onId3 and onLastSecond.

• data.name; // the name of the data message, as a String
• data.value; // sthe payload value of the dat message, as an object

The OvpEvent.DEBUG constant defines the value of the OvpEvent's type property, which indicates the class has a debug message for tranmission. The contents of the message are carried in the data object as a string.

The OvpEvent.ERROR constant defines the value of an error event's type property, which indicates that the class has encountered a run-time error. The data object will contain errorNumber and errorDescription properties.

See also

The OvpEvent.LOADED constant defines the value of the OvpEvent's type property, which indicates the class has successfully loaded external data, such as a MediaRSS feed. This event is fired before that data is parsed.

The OvpEvent.MP3_ID3 constant defines the value of an OvpEvent's type property, dispatched when the the class receives information about ID3 data embedded in an MP3 file. To trigger this event, first make a request to the getMp3Id3Info method.

See also

Mapped over from HDEVENT

The OvpEvent.NETSTREAM_CUEPOINT constant defines the value of an OvpEvent's type property, dispatched when an embedded cue point is reached while playing an FLV file. You can use this handler to trigger actions in your code when the video reaches a specific cue point, which lets you synchronize other actions in your application with video playback events. The following types of cue points can be embedded in an FLV file:

• A navigation cue point specifies a keyframe within the FLV file, and the cue point's time property corresponds to that exact keyframe. Navigation cue points are often used as bookmarks or entry points to let users navigate through the video file.
• An event cue point is specified by time, whether or not that time corresponds to a specific keyframe. An event cue point usually represents a time in the video when something happens that could be used to trigger other application events.

The OvpEvent.NETSTREAM_IMAGEDATA constant defines the value of an OvpEvent's type property, dispatched when the OvpNetStream class receives an image embedded in the H.264 file being played. The onImageData method is a callback like onMetaData that sends image data as a byte array through an AMF0 data channel. The image data can be in JPEG, PNG, or GIF formats. As the information is a byte array, this functionality is only supported for ActionScript 3.0 client SWFs. The info property of the event will hold the image data object and the imageData.data object holds the actual byte array.

The OvpEvent.NETSTREAM_METADATA constant defines the value of an OvpEvent's type property, dispatched when the OvpNetStream class receives descriptive information embedded in the FLV file being played. This event is triggered after a call to the NetStream.play() method, but before the video playhead has advanced. In many cases, the duration value embedded in FLV metadata approximates the actual duration, but is not exact. In other words, it does not always match the value of the NetStream.time property when the playhead is at the end of the video stream.

The OvpEvent.NETSTREAM_PLAYSTATUS constant defines the value of an OvpEvent's type property, dispatched when a NetStream object has completely played a stream, or when it switches to a different stream in a server-side playlist. This handler returns information objects that provide information in addition to what's returned by the netStatus event. You can use this handler to trigger actions in your code when a NetStream object has switched from one stream to another stream in a playlist (as indicated by the information object NetStream.Play.Switch) or when a NetStream object has played to the end (as indicated by the information object NetStream.Play.Complete).

The OvpEvent.NETSTREAM_TEXTDATA constant defines the value of an OvpEvent's type property, dispatched when the OvpNetStream class receives text data embedded in the H.264 file being played. The onTextData method is a callback like onMetaData that sends text data through an AMF0 data channel. The text data is always in UTF-8 format and can contain additional information about formatting based on the 3GP timed text specification. This functionality is fully supported in ActionScript 2.0 and 3.0 because it does not use a byte array.The info property of the event will hold the text data object and the textData.text object holds the actual text.

The OvpEvent.NETSTREAM_TEXTDATA constant defines the value of an OvpEvent's type property, dispatched when the NetStream receives information specific to Adobe Extensible Metadata Platform (XMP) embedded in the video being played. The associated event listener is triggered after a call to the NetStream.play() method, but before the video playhead has advanced. The data object passed in the event handling function has one data property, which is a string. The string is generated from a top-level UUID box which contains exactly one XML document represented as a null-terminated UTF-8 string.

Flash Media Live Encoder contains a special built-in handler, onFI, that subscribing clients can use in their ActionScript code to access timecode information. You can get timecode and system date and time information, if timecode and system date and time were embedded in the stream, by accessing the tc, sd, and st properties of the data object when handling this event:

• data.tc; // timecode string formatted hh:mm:ss:ff
• data.sd; // system Date string formatted as dd-mm-yy
• data.st; // system Time string formatted as hh:mm:ss.ms

Some FLV files have this callback embedded.

The OvpEvent.PARSED constant defines the value of the OvpEvent's type property, which indicates the class has successfully parsed some data, such as a Media RSS feed.

The OvpEvent.PROGRESS constant defines the value of the OvpEvent's type property, which indicates the class is actively playing a stream. This event is fired every progressInterval millseconds from when play is first called, to when close() is called. This event is designed to be an update interval to drive time and position displays which vary with the progress of the stream.

See also

The OvpEvent.STREAM_LENGTH constant defines the value of the OvpEvent's type property, which indicates the class has completed a stream length request. The streamLength value can be accessed via the data property, for example event.data.streamLength.

See also

The OvpEvent.SUBSCRIBE_ATTEMPT constant defines the value of the OvpEvent's type property, which indicates the class is making a new attempt to subscribe to a live stream. This will occur immediately after the first play request for a live stream, as well as after an OvpEvent.UNSUBSCRIBED event has been issued while the stream was still active. These resubscription attempts will occur roughly every 30 seconds until the liveStreamMasterTimeout period has been exceeded, after which an error event will be dispatched.

The OvpEvent.SUBSCRIBED constant defines the value of the OvpEvent's type property, which indicates the class has successfully subscribed to a live stream.

For dynamic streaming, dispatched when the NetStream object receives a "NetStream.Play.Transition" event meaning the server has acknowledged the switch request and is in the process of switching streams. The data object for the event will contain:

• data.nsInfo; // the info property from the NetStatusEvent object

For dynamic streaming, dispatched when either a manual switch has been requested or a switching rule has requested a switch to a new index. The data object for the event will contain these items:

• data.targetIndex; // The index we are trying to switch to.
• data.streamName; // The stream name we are trying to switch to.
• data.firstPlay; // True if this is the initial play request for the dynamic streaming profile.
• data.reason; // A textual description of the reason for the switch request.

The OvpEvent.TIMEOUT constant defines the value of an error event's type property, which indicates a timeout has occurred.

The OvpEvent.UNSUBSCRIBED constant defines the value of the OvpEvent's type property, which indicates the class has unsubscribed from a live stream. This may happen because the unsubscribe method was called by the parent or because the publisher of the stream ceased publication. In the latter case, the OvpConnection class will automatically attempt to resubscribe to the live stream. It will do this until the liveStreamMasterTimeout period has been exceeded, after which it will dispatch an error event.