DynamicStreamingResource

Package	org.osmf.net
Class	public class DynamicStreamingResource
Inheritance	DynamicStreamingResource StreamingURLResource URLResource MediaResourceBase Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

DynamicStreamingResource encapsulates multiple representations of a piece of media, such that the player application can dynamically switch from one representation to another. Typically (though not always), each representation is encoded at a different bitrate, and the player application switches between representations based on changes to the client's available bandwidth.

This class provides an object representation of a dynamic streaming resource without any knowledge or assumption of any file format, such as SMIL, Media RSS, F4M, etc.

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alternativeAudioStreamItems : Vector.<StreamingItem> Vector containing all alternative audio items associated with the current streaming resource.	StreamingURLResource
		clipEndTime : Number Optional end time of the streaming resource.	StreamingURLResource
		clipStartTime : Number Optional start time of the streaming resource.	StreamingURLResource
		connectionArguments : Vector.<Object> Optional set of arguments that will be supplied when making a connection to the source of the stream.	StreamingURLResource
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		drmContentData : ByteArray Content metadata for DRM-encrypted content.	StreamingURLResource
		host : String [read-only] A URL representing the host of the dynamic streaming resource.	DynamicStreamingResource
		initialIndex : int The preferred starting index.	DynamicStreamingResource
		mediaType : String The MediaType, if any, of this resource.	MediaResourceBase
		metadataNamespaceURLs : Vector.<String> [read-only] A Vector containing the namespace URLs for all Metadata objects within this resource.	MediaResourceBase
		mimeType : String The MIME type, if any, of this resource.	MediaResourceBase
		streamItems : Vector.<DynamicStreamingItem> Vector of DynamicStreamingItems.	DynamicStreamingResource
		streamType : String The StreamType for this resource.	StreamingURLResource
		url : String [read-only] The URL of the resource.	URLResource
		urlIncludesFMSApplicationInstance : Boolean Indicates, for RTMP streaming URLs, whether the URL includes the FMS application instance or not.	StreamingURLResource

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DynamicStreamingResource(host:String, streamType:String = null) Constructor.	DynamicStreamingResource
		addMetadataValue(namespaceURL:String, value:Object):void Adds a metadata value to this resource.	MediaResourceBase
		getMetadataValue(namespaceURL:String):Object Retrieves a metadata value from this resource.	MediaResourceBase
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		removeMetadataValue(namespaceURL:String):Object Removes a metadata value from this resource.	MediaResourceBase
		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

Property Detail

host

property

host:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

A URL representing the host of the dynamic streaming resource.

Implementation
public function get host():String

initialIndex

property

initialIndex:int

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The preferred starting index.

Implementation
public function get initialIndex():int
public function set initialIndex(value:int):void

Throws

RangeError — If the index is out of range. From OSMF 2.0 upwards you can set the initialIndex through a metadata as well, using the RESOURCE_INITIAL_INDEX key. This metadata can be added to any media resource, such as an URLResource, and it will be used to set the initial index when the DynamicStreamingResource is created. For example, having resource as a URLResource you can set the initialIndex in the following way: resource.addMetadata(MetadataNamespaces.RESOURCE_INITIAL_INDEX, 1); The RESOURCE_INITIAL_INDEX metadata accepts integers, and will adjust the value to fit into the streamItems range. This means that if the specified value is negative it will be adjusted to 0, and if it is larger than the available streamItems, then it will be adjusted to the greatest streamItem index.

streamItems

property

streamItems:Vector.<DynamicStreamingItem>

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Vector of DynamicStreamingItems. Each item represents a different bitrate stream.

Implementation
public function get streamItems():Vector.<DynamicStreamingItem>
public function set streamItems(value:Vector.<DynamicStreamingItem>):void

Constructor Detail

()

Constructor

public function DynamicStreamingResource(host:String, streamType:String = null)

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Parameters

	`host:String` — A URL representing the host of the dynamic streaming resource.

	`streamType:String` (default = `null`) — The type of the stream. If null, defaults to StreamType.RECORDED.

Examples How to use this example

DynamicStreamingResourceExample.as

Copy

package
{
    import flash.display.Sprite;
    import flash.display.StageAlign;
    import flash.display.StageScaleMode;
    
    import org.osmf.elements.VideoElement;
    import org.osmf.media.MediaPlayerSprite;
    import org.osmf.net.DynamicStreamingItem;
    import org.osmf.net.DynamicStreamingResource;
    
    public class DynamicStreamingResourceExample extends Sprite
    {
        public function DynamicStreamingResourceExample()
        {
            super();
            
            stage.scaleMode = StageScaleMode.NO_SCALE;
            stage.align = StageAlign.TOP_LEFT;
            
            var mediaPlayerSprite:MediaPlayerSprite = new MediaPlayerSprite();
            var videoElement:VideoElement = new VideoElement();
            var dynResource:DynamicStreamingResource = new DynamicStreamingResource("rtmp://cp67126.edgefcs.net/ondemand");
            
            dynResource.streamItems = Vector.<DynamicStreamingItem>(
                [     new DynamicStreamingItem("mp4:mediapm/ovp/content/demo/video/elephants_dream/elephants_dream_768x428_24.0fps_408kbps.mp4", 408, 768, 428)
                    , new DynamicStreamingItem("mp4:mediapm/ovp/content/demo/video/elephants_dream/elephants_dream_768x428_24.0fps_608kbps.mp4", 608, 768, 428)
                    , new DynamicStreamingItem("mp4:mediapm/ovp/content/demo/video/elephants_dream/elephants_dream_1024x522_24.0fps_908kbps.mp4", 908, 1024, 522)
                    , new DynamicStreamingItem("mp4:mediapm/ovp/content/demo/video/elephants_dream/elephants_dream_1024x522_24.0fps_1308kbps.mp4", 1308, 1024, 522)
                    , new DynamicStreamingItem("mp4:mediapm/ovp/content/demo/video/elephants_dream/elephants_dream_1280x720_24.0fps_1708kbps.mp4", 1708, 1280, 720)
                ]);
            
            videoElement.resource = dynResource;
            
            addChild(mediaPlayerSprite);
            mediaPlayerSprite.media = videoElement;    
        }    
    }
}

DynamicStreamingResource - AS3 OSMF

Classes x

host

initialIndex

streamItems

DynamicStreamingResource

org.osmf.net DynamicStreamingResource - AS3 OSMF		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples