ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.media 

H264VideoStreamSettings  - AS3

Packageflash.media
Classpublic class H264VideoStreamSettings
InheritanceH264VideoStreamSettings Inheritance VideoStreamSettings Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

The H264VideoStreamSettings class enables specifying video compression settings for each NetStream. Properties will be validated once Camera is attached to NetStream and compression has started.


Public Properties
 PropertyDefined By
 Inheritedbandwidth : int
[read-only] Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second.
VideoStreamSettings
  codec : String
[override] [read-only] Video codec used for compression.
H264VideoStreamSettings
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedfps : Number
[read-only] The maximum frame rate at which the video frames are encoded, in frames per second.
VideoStreamSettings
 Inheritedheight : int
[read-only] The current encoded height, in pixels.
VideoStreamSettings
 InheritedkeyFrameInterval : int
[read-only] The number of video frames transmitted in full (called keyframes or IDR frames) instead of being interpolated by the video compression algorithm.
VideoStreamSettings
  level : String
[read-only] Level used for H.264/AVC encoding.
H264VideoStreamSettings
  profile : String
[read-only] Profile used for H.264/AVC encoding.
H264VideoStreamSettings
 Inheritedquality : int
[read-only] The required level of picture quality, as determined by the amount of compression being applied to each video frame.
VideoStreamSettings
 Inheritedwidth : int
[read-only] The current encoded width, in pixels.
VideoStreamSettings
Public Methods
 MethodDefined By
  
H264VideoStreamSettings()
Creates a setting object that specifies to use H.264/AVC codec for video compression.
H264VideoStreamSettings
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setKeyFrameInterval(keyFrameInterval:int):void
The number of video frames transmitted in full (called keyframes or Instantaneous Decoding Refresh (IDR) frames) instead of being interpolated by the video compression algorithm.
VideoStreamSettings
 Inherited
setMode(width:int, height:int, fps:Number):void
Sets the resolution and frame rate used for video encoding.
VideoStreamSettings
  
setProfileLevel(profile:String, level:String):void
Set profile and level for video encoding.
H264VideoStreamSettings
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setQuality(bandwidth:int, quality:int):void
Sets maximum amount of bandwidth per second or the required picture quality that the current outgoing video feed can use.
VideoStreamSettings
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

codec

property
codec:String  [read-only] [override]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

Video codec used for compression.



Implementation
    override public function get codec():String

level

property 
level:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

Level used for H.264/AVC encoding. To set the desired value for this property, please use setProfileLevel() method. This property can be increased by H.264 codec if the selected level is not high enough for the specified resolution and frame rate.



Implementation
    public function get level():String

profile

property 
profile:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

Profile used for H.264/AVC encoding. To set the desired value for this property, please use setProfileLevel() method.



Implementation
    public function get profile():String
Constructor Detail

H264VideoStreamSettings

()Constructor
public function H264VideoStreamSettings()

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

Creates a setting object that specifies to use H.264/AVC codec for video compression.

Method Detail

setProfileLevel

()method
public function setProfileLevel(profile:String, level:String):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11, AIR 3

Set profile and level for video encoding. Possible values for profile are H264Profile.BASELINE and H264Profile.MAIN. Default value is H264Profile.BASELINE. Other values are ignored and results in an error. Please see H264Profile class for more information. Supported levels are 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, and 5.1. Level may be increased if required by resolution and frame rate. Please see H264Level class for more information.

Parameters

profile:String — The requested encoder profile as a String. Please see H264Profile class for possible values.
 
level:String — The requested encoder level as a String. Please see H264Level class for possible values.

Throws
Error — If invalid profile or level is specified.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy