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
  content : String
[read-only] The raw content of the source tag of this timed metadata.
TimedMetadata
  id : String
[read-only] The identifier of this timed metadata.
TimedMetadata
  metadata : Metadata
[read-only] The extracted information from the source tag.
TimedMetadata
  name : String
[read-only] The name of the source tag of this timed metadata.
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 timed metadata.
TimedMetadata
Public Methods
 MethodDefined By
  
TimedMetadata(type:String, time:Number, id:String, name:String, content:String, metadata:Metadata)
Default constructor.
TimedMetadata
  
compareTo(timedMetadata:TimedMetadata):int
Comparison method between two timed metadata used for sorting purposes.
TimedMetadata
  
createID3(time:Number, metadataID3:Metadata):TimedMetadata
[static]
TimedMetadata
  
toString():String
Returns a string representation of the timed metadata.
TimedMetadata
Public Constants
 ConstantDefined By
  ASCENDING_SORT_FUNCTION : Function
[static] Sort function which can be used by any timed metadata collection which want to sort its content in ascending order.
TimedMetadata
Property Detail
contentproperty
content:String  [read-only]

The raw content of the source tag of this timed metadata.


Implementation
    public function get content():String
idproperty 
id:String  [read-only]

The identifier of this timed metadata.


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

The extracted information from the source tag.


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

The name of the source tag of this timed metadata.


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 timed metadata.


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

Default constructor.

Parameters
type:String — Timed metadata type.
 
time:Number — Timed metadata time.
 
id:String — Timed metadata unique identifier.
 
name:String — Tag name used to mark this timed metadata in the playlist. For ID3 tags, this value will be "ID3".
 
content:String — Timed metadata content. For ID3 tags, this value will represent the serialized byte array.
 
metadata:Metadata — Timed metadata processed information.
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.
createID3()method 
public static function createID3(time:Number, metadataID3:Metadata):TimedMetadata

Parameters

time:Number
 
metadataID3:Metadata

Returns
TimedMetadata
toString()method 
public function toString():String

Returns a string representation of the timed metadata.

Returns
String — a string containing the raw timed metadata information.
Constant Detail
ASCENDING_SORT_FUNCTIONConstant
public static const ASCENDING_SORT_FUNCTION:Function

Sort function which can be used by any timed metadata collection which want to sort its content in ascending order.