Strobe Media Playback SVN

/*****************************************************
*  
*  Copyright 2009 Adobe Systems Incorporated.  All Rights Reserved.
*  
*****************************************************
*  The contents of this file are subject to the Mozilla Public License
*  Version 1.1 (the "License"); you may not use this file except in
*  compliance with the License. You may obtain a copy of the License at
*  http://www.mozilla.org/MPL/
*   
*  Software distributed under the License is distributed on an "AS IS"
*  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
*  License for the specific language governing rights and limitations
*  under the License.
*   
*  
*  The Initial Developer of the Original Code is Adobe Systems Incorporated.
*  Portions created by Adobe Systems Incorporated are Copyright (C) 2009 Adobe Systems 
*  Incorporated. All Rights Reserved. 
*  
*****************************************************/
package org.osmf.events
{
	import flash.events.Event;
	
	import org.osmf.metadata.Metadata;
	
	/**
	 * A MediaElementEvent is dispatched when the properties of a MediaElement change.
	 *  
	 *  @langversion 3.0
	 *  @playerversion Flash 10
	 *  @playerversion AIR 1.5
	 *  @productversion OSMF 1.0
	 */
	public class MediaElementEvent extends Event
	{
		/**
		 * The MediaElementEvent.TRAIT_ADD constant defines the value of the type
		 * property of the event object for a traitAdd event.
		 * 
		 * @eventType traitAdd
		 *  
		 *  @langversion 3.0
		 *  @playerversion Flash 10
		 *  @playerversion AIR 1.5
		 *  @productversion OSMF 1.0
		 */
		public static const TRAIT_ADD:String = "traitAdd";
		
		/**
		 * The MediaElementEvent.TRAIT_REMOVE constant defines the value of the
		 * type property of the event object for a traitRemove event.
		 * 
		 * @eventType traitRemove
		 *  
		 *  @langversion 3.0
		 *  @playerversion Flash 10
		 *  @playerversion AIR 1.5
		 *  @productversion OSMF 1.0
		 */
		public static const TRAIT_REMOVE:String = "traitRemove";
		
		/**
		 * The MediaElementEvent.METADATA_ADD constant defines the value of the type
		 * property of the event object for a metadataAdd event.
		 * 
		 * @eventType metadataAdd
		 *  
		 *  @langversion 3.0
		 *  @playerversion Flash 10
		 *  @playerversion AIR 1.5
		 *  @productversion OSMF 1.0
		 */
		public static const METADATA_ADD:String = "metadataAdd";
		
		/**
		 * The MediaElementEvent.METADATA_REMOVE constant defines the value of the
		 * type property of the event object for a metadataRemove event.
		 * 
		 * @eventType metadataRemove
		 *  
		 *  @langversion 3.0
		 *  @playerversion Flash 10
		 *  @playerversion AIR 1.5
		 *  @productversion OSMF 1.0
		 */
		public static const METADATA_REMOVE:String = "metadataRemove";
		
		/**
		 * Constructor.
		 * 
		 * @param type Event type
		 * @param bubbles Specifies whether the event can bubble up the display
 		 * list hierarchy.
 		 * @param cancelable Specifies whether the behavior associated with the
 		 * event can be prevented. 
		 * @param traitType The MediaTraitType for the trait that was added or removed.  Null
		 * if type is not TRAIT_ADD or TRAIT_REMOVE.
		 * @param namespaceURL The namespace URL of the Metadata that was added or removed.
		 * Null if type is not METADATA_ADD or METADATA_REMOVE.
		 * @param metadata The Metadata that was added or removed. Null if type is not
		 * METADATA_ADD or METADATA_REMOVE.
		 *  
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10
 		 *  @playerversion AIR 1.5
 		 *  @productversion OSMF 1.0
 		 */
		public function MediaElementEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false, traitType:String=null, namespaceURL:String=null, metadata:Metadata=null)
		{
			super(type, bubbles, cancelable);

			_traitType = traitType;
			_namespaceURL = namespaceURL;
			_metadata = metadata;
		}
		
		/**
		 * @private
		 */
		override public function clone():Event
		{
			return new MediaElementEvent(type, bubbles, cancelable, traitType, namespaceURL, metadata);
		}
		
		/**
		 * The MediaTraitType for the trait that was added or removed.  Null
		 * if type is not TRAIT_ADD or TRAIT_REMOVE.
		 *  
		 *  @langversion 3.0
		 *  @playerversion Flash 10
		 *  @playerversion AIR 1.5
		 *  @productversion OSMF 1.0
		 */
		public function get traitType():String
		{
			return _traitType;
		}

		/**
		 * The namespace URL for the Metadata that was added or removed.  Null if
		 * type is not METADATA_ADD or METADATA_REMOVE.
		 **/
		public function get namespaceURL():String
		{
			return _namespaceURL;
		}
		
		/**
		 * The Metadata that was added or removed.  Null if type is not
		 * METADATA_ADD or METADATA_REMOVE.
		 **/
		public function get metadata():Metadata
		{
			return _metadata;
		}
		
		// Internals
		//
		
		private var _traitType:String;
		private var _namespaceURL:String;
		private var _metadata:Metadata;
	}
}