flash.events

# NetDataEvent - AS3

Package | flash.events
Class | public class NetDataEvent
Inheritance | NetDataEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

A NetStream object dispatches a NetDataEvent object when a data message is encountered in the media stream.

A NetDataEvent is dispatched for the following messages:

- onCuePoint
- onImageData
- onMetaData
- onPlayStatus (for code NetStream.Play.Complete)
- onTextData
- onXMPData

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | info : Object [read-only] A data object describing the message. | NetDataEvent
|  | target : Object [read-only] The event target. | Event
|  | timestamp : Number [read-only] The timestamp of the data message in the media stream. | NetDataEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NetDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, info:Object = null) Creates an event object that contains information about media data events. | NetDataEvent
|  | clone():Event [override] Creates a copy of an NetDataEvent object and sets the value of each property to match that of the original. | NetDataEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the NetDataEvent object. | NetDataEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | MEDIA_TYPE_DATA : String = "mediaTypeData" [static] The NetDataEvent.MEDIA_TYPE_DATA constant defines the value of the type property of the NetDataEvent object dispatched when a data message in the media stream is encountered by the NetStream object. | NetDataEvent

Property Detail

### info

property

`info:Object` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

A data object describing the message. The `info` object has two properties: `info.handler` and `info.args`. `info.handler` is the handler name, such as "onMetaData" or "onXMPData". `info.args` is an array of arguments.

Implementation
`public function get info():Object`

### timestamp

property

`timestamp:Number` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

The timestamp of the data message in the media stream.

Implementation
`public function get timestamp():Number`
Constructor Detail

### NetDataEvent

()
Constructor

`public function NetDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, info:Object = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

Creates an event object that contains information about media data events. Event objects are passed as parameters to Event listeners.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited `bubbles` property.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.
| `timestamp:Number` (default = `0`)`` — timestamp of the data message
| `info:Object` (default = `null`)`` — data message object

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

Creates a copy of an NetDataEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new NetDataEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

Returns a string that contains all the properties of the NetDataEvent object. The following format is used:

`[NetDataEvent type=value bubbles=value cancelable=value timestamp=value]`

Returns

| `String` — A string that contains all the properties of the NetMediaEvent object.

Constant Detail

### MEDIA_TYPE_DATA

Constant

`public static const MEDIA_TYPE_DATA:String = "mediaTypeData"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.3, AIR 2.7

The `NetDataEvent.MEDIA_TYPE_DATA` constant defines the value of the `type` property of the NetDataEvent object dispatched when a data message in the media stream is encountered by the NetStream object.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00