Packagecom.adobe.mediacore.metadata
Classpublic final class TimedMetadata
InheritanceTimedMetadata Inheritance Object

Raw representation of the timed metadata inserted into a media stream. Custom packagers can add additional metadata to an existing stream to signal the presence of special media sections ( ad placement opportunities, black-outs etc).



Public Properties
 PropertyDefined By
  id : String
[read-only] The metadata id.
TimedMetadata
  metadata : Metadata
[read-only] The metadata inserted into the stream.
TimedMetadata
  name : String
[read-only] The name of the tag as it is present in the manifest file.
TimedMetadata
  time : Number
[read-only] The time position where this metadata was inserted into the stream.
TimedMetadata
  type : String
[read-only] The type of this TimedMetadata
TimedMetadata
Public Methods
 MethodDefined By
  
TimedMetadata(id:String, type:String, time:Number, name:String, metadata:Metadata)
Default constructor.
TimedMetadata
  
compareTo(timedMetadata:TimedMetadata):int
Comparison method between two timed metadata used for sorting purposes.
TimedMetadata
Public Constants
 ConstantDefined By
  TAG : String = TAG
[static] Default TimedMetadata type
TimedMetadata
Property Detail
idproperty
id:String  [read-only]

The metadata id. In the case of cues this is the cue id.


Implementation
    public function get id():String
metadataproperty 
metadata:Metadata  [read-only]

The metadata inserted into the stream.


Implementation
    public function get metadata():Metadata
nameproperty 
name:String  [read-only]

The name of the tag as it is present in the manifest file. In the case of cues this will be "cue".


Implementation
    public function get name():String
timeproperty 
time:Number  [read-only]

The time position where this metadata was inserted into the stream.


Implementation
    public function get time():Number
typeproperty 
type:String  [read-only]

The type of this TimedMetadata


Implementation
    public function get type():String
Constructor Detail
TimedMetadata()Constructor
public function TimedMetadata(id:String, type:String, time:Number, name:String, metadata:Metadata)

Default constructor.

Parameters
id:String — The metadata id. In the case of cues this is the cue id.
 
type:String — The type of this TimedMetadata
 
time:Number — The time position where this metadata was inserted into the stream (in milliseconds)
 
name:String — The name of the tag as it is present in the manifest file. In the case of cues this will be "cue".
 
metadata:Metadata — The metadata inserted into the stream.
Method Detail
compareTo()method
public function compareTo(timedMetadata:TimedMetadata):int

Comparison method between two timed metadata used for sorting purposes.

Parameters

timedMetadata:TimedMetadata — the timed metadata object used for comparing

Returns
int — -1 if the current metadata is placed earlier in the stream, 0 if both metadata are placed at the same time in stream and 1 if the current metadata is placed later in the stream.
Constant Detail
TAGConstant
public static const TAG:String = TAG

Default TimedMetadata type