| Package | flash.media |
| Class | public class VideoStreamSettings |
| Inheritance | VideoStreamSettings  Object |
| Subclasses | H264VideoStreamSettings |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
Note The mode and quality settings of the Camera attached to a NetStream object
override the video stream settings assigned to a NetStream instance.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| bandwidth : int [read-only]
Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second. | VideoStreamSettings | ||
| codec : String [read-only]
Video codec used for compression. | VideoStreamSettings | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| fps : Number [read-only]
The maximum frame rate at which the video frames are encoded, in frames per second. | VideoStreamSettings | ||
| height : int [read-only]
The current encoded height, in pixels. | VideoStreamSettings | ||
| keyFrameInterval : 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 | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| quality : int [read-only]
The required level of picture quality, as determined by the amount of compression being applied to each video
frame. | VideoStreamSettings | ||
| width : int [read-only]
The current encoded width, in pixels. | VideoStreamSettings | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a setting object that specifies to use Sorenson Spark video codec for compresion. | VideoStreamSettings | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
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 | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
bandwidth | property |
bandwidth:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second.
To set this property, use the setQuality() method.
Implementation
public function get bandwidth():intRelated API Elements
codec | property |
fps | property |
fps:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The maximum frame rate at which the video frames are encoded, in frames per second.
To set a desired value for this property, use the setMode() method.
This value is validated once Camera is attached to NetStream.
Implementation
public function get fps():NumberRelated API Elements
height | property |
height:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The current encoded height, in pixels. To set a desired value for this property,
use the setMode() method. This value is validated once Camera is attached
to NetStream and compression has started.
Implementation
public function get height():intRelated API Elements
keyFrameInterval | property |
keyFrameInterval:int [read-only] | Language Version: | ActionScript #see |
| Runtime Versions: | Flash Player 11, AIR 3 |
The number of video frames transmitted in full (called keyframes or IDR frames) instead of
being interpolated by the video compression algorithm. To set a value for
this property, use the setKeyFrameInterval() method.
Implementation
public function get keyFrameInterval():intquality | property |
quality:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The required level of picture quality, as determined by the amount of compression being applied to each video
frame. This value ranges from 1 (lowest quality, maximum compression) to 100 (highest quality, small compression).
To set this property, use the setQuality() method.
Implementation
public function get quality():intRelated API Elements
width | property |
width:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The current encoded width, in pixels. To set a desired value for this property,
use the setMode() method. This value is validated once Camera is attached
to NetStream and compression has started.
Implementation
public function get width():intRelated API Elements
VideoStreamSettings | () | Constructor |
public function VideoStreamSettings()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 11, AIR 3 |
Creates a setting object that specifies to use Sorenson Spark video codec for compresion.
setKeyFrameInterval | () | method |
public function setKeyFrameInterval(keyFrameInterval:int):void| Language Version: | ActionScript #see |
| Runtime Versions: | Flash Player 11, AIR 3 |
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.
The default value is 15, which means that every 15th frame is a keyframe. A value of 1 means that every frame is a keyframe.
The allowed values are 1 through 300. Set to -1 to use the same value as specified for Camera object. This value
is capped by Camera value.
Note This feature will be supported in future releases of Flash Player and AIR, for now, Camera
parameters are used.
Parameters
keyFrameInterval:int — A value that specifies which video frames are transmitted in full
(as keyframes or IDR frames) instead of being interpolated by the video compression algorithm.
|
Mon Nov 28 2011, 06:48 AM -08:00