org.osmf.elements

# ImageElement - AS3 OSMF

Package | org.osmf.elements
Class | public class ImageElement
Inheritance | ImageElement LoadableElementBase MediaElement EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

ImageElement is a media element specifically created for presenting still images. It can load and present any PNG, GIF, or JPG image.

The basic steps for creating and using an ImageElement are:

1. Create a new URLResource pointing to the URL of image to be loaded.
2. Create the new ImageElement, passing the URLResource as a parameter.
3. Create a new MediaPlayer.
4. Assign the ImageElement to the MediaPlayer's `media` property.
5. Get the DisplayObject from the MediaPlayer's `displayObject` property, and add it to the display list. Note that the `displayObject` property may not be immediately available, in which case you can listen for the MediaPlayer's `displayObjectChange` event.
6. When done with the ImageElement, set the MediaPlayer's `media` property to null, and remove the DisplayObject from the display list.

View the examples

Related API Elements

org.osmf.elements.ImageLoader
org.osmf.media.MediaElement
org.osmf.media.MediaPlayer
org.osmf.media.URLResource

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | container : IMediaContainer [read-only] The media container that this element uses. | MediaElement
|  | metadataNamespaceURLs : Vector.<String> [read-only] A Vector containing the namespace URLs for all Metadata objects stored within this MediaElement. | MediaElement
|  | resource : MediaResourceBase The media resource that this media element operates on. | MediaElement
|  | smoothing : Boolean Specifies whether the image should be smoothed when it is scaled. | ImageElement
|  | traitTypes : Vector.<String> [read-only] A Vector of MediaTraitType values representing the trait types on this media element. | MediaElement

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | loader : LoaderBase The LoaderBase used by this element to load resources. | LoadableElementBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ImageElement(resource:URLResource = null, loader:ImageLoader = null) Constructor. | ImageElement
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | addMetadata(namespaceURL:String, metadata:Metadata):void Adds a Metadata object to this MediaElement under the specified namespace URL. | MediaElement
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | getMetadata(namespaceURL:String):Metadata Returns the Metadata object that is stored under this MediaElement with the specified namespace URL. | MediaElement
|  | getTrait(type:String):org.osmf.traits:MediaTraitBase Returns the media trait of the specified type. | MediaElement
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hasTrait(type:String):Boolean Determines whether this media element has a media trait of the specified type. | MediaElement
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | removeMetadata(namespaceURL:String):Metadata Removes the Metadata object that was stored under this MediaElement with the specified namespace URL. | MediaElement
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addTrait(type:String, instance:org.osmf.traits:MediaTraitBase):void Adds a new media trait to this media element. | MediaElement
|  | createLoadTrait(resource:MediaResourceBase, loader:LoaderBase):org.osmf.traits:LoadTrait Subclasses can override this method to return a custom LoadTrait subclass. | LoadableElementBase
|  | processLoadingState():void Subclasses can override this method to do processing when the media element enters the LOADING state. | LoadableElementBase
|  | processReadyState():void Subclasses can override this method to do processing when the media element enters the READY state. | LoadableElementBase
|  | processUnloadingState():void Subclasses can override this method to do processing when the media element enters the UNLOADING state. | LoadableElementBase
|  | removeTrait(type:String):org.osmf.traits:MediaTraitBase Removes a media trait from this media element. | MediaElement
|  | setupTraits():void Sets up the traits for this media element. | MediaElement

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | containerChange | Dispatched when the element's container property changed. | MediaElement
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | mediaError | Dispatched when an error which impacts the operation of the media element occurs. | MediaElement
|  | mediaInfo | Dispatched when a info which impacts the operation of the media element is available. | MediaElement
|  | metadataAdd | Dispatched when a Metadata object has been added to this media element. | MediaElement
|  | metadataRemove | Dispatched when a Metadata object has been removed from this media element. | MediaElement
|  | traitAdd | Dispatched when a trait is added to the media element. | MediaElement
|  | traitRemove | Dispatched when a trait is removed from the media element. | MediaElement

Property Detail

### smoothing

property

`smoothing:Boolean`

Specifies whether the image should be smoothed when it is scaled. The default value is false.

Implementation
`public function get smoothing():Boolean`
`public function set smoothing(value:Boolean):void`
Constructor Detail

### ImageElement

()
Constructor

`public function ImageElement(resource:URLResource = null, loader:ImageLoader = null)`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `resource:URLResource` (default = `null`)`` — URLResource that points to the image source that the ImageElement will use.
| `loader:ImageLoader` (default = `null`)`` — ImageLoader used to load the image. If null, the ImageLoader will be created.

Examples How to use this example
ImageElementExample.as
Copy

    package
    {
        import flash.display.Sprite;
        import flash.display.StageAlign;
        import flash.display.StageScaleMode;

        import org.osmf.elements.ImageElement;
        import org.osmf.elements.VideoElement;
        import org.osmf.media.MediaPlayer;
        import org.osmf.media.MediaPlayerSprite;
        import org.osmf.media.URLResource;

        public class ImageElementExample extends Sprite
        {
            public function ImageElementExample()
            {
                super();

                stage.scaleMode = StageScaleMode.NO_SCALE;
                stage.align = StageAlign.TOP_LEFT;

                var mediaPlayerSprite:MediaPlayerSprite = new MediaPlayerSprite();
                var imageElement:ImageElement = new ImageElement();
                imageElement.resource = new URLResource("http://mediapm.edgesuite.net/strobe/content/test/train.jpg");

                addChild(mediaPlayerSprite);
                mediaPlayerSprite.media = imageElement;
            }
        }
    }

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