org.osmf.utils

# OSMFSettings - AS3 OSMF

Package | org.osmf.utils
Class | public final class OSMFSettings
Inheritance | OSMFSettings Object

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.6

Runtime Versions: | Flash Player 10, AIR 1.5

Utility class which exposes all user-facing OSMF settings.

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
|  | enableStageVideo : Boolean = true [static] Controls OSMF’s use of StageVideo in your application. | OSMFSettings
|  | supportsStageVideo : Boolean [static] [read-only] Obtains whether the version of Flash Player installed on the user’s system supports StageVideo. | OSMFSettings

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | 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

### enableStageVideo

property

`public static var enableStageVideo:Boolean = true`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.6

Runtime Versions: | Flash Player 10, AIR 1.5

Controls OSMF’s use of StageVideo in your application. Setting this value to true causes OSMF to try to use StageVideo on systems where it is available. Setting the value to false disables the use of StageVideo and instructs OSMF to fallback to the normal Video API. Changes to this value affect any new media elements that are created, but changes have no effect on existing media elements. The default setting for this flag is true.

### supportsStageVideo

property

`supportsStageVideo:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.6

Runtime Versions: | Flash Player 10, AIR 1.5

Obtains whether the version of Flash Player installed on the user’s system supports StageVideo. If the installed version of Flash Player is equal to or greater than 10.2, StageVideo is supported, and the function returns true. If the installed version of Flash Player is lower than 10.2, StageVideo is not supported, and the function returns false.

Implementation
`public static function get supportsStageVideo():Boolean`

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