FLVPlayback

Kind of class:class
Inherits from:MovieClip
Classpath:mx.video.FLVPlayback
File last modified:Tuesday, 18 December 2007, 16:09:31

Event dispatched when FLVPlayback.BUFFERING state
entered. This state is typically entered immediately after
play() is called or the corresponding control is
clicked, before the playing state is entered. Event Object has
properties state and playheadTime.

Event has property vp, index number of VideoPlayer to which this
event applies. See activeVideoPlayerIndex and visibleVideoPlayerIndex.

"stateChange" event will also be dispatched.

See also:
Component metadata:
    Event
    "buffering"

    Summary


    Constructor
    Class properties
    Instance properties
    Instance methods

    Constructor

    FLVPlayback

    function FLVPlayback (
    )

    constructor

    Class properties

    ACTIONSCRIPT

    static ACTIONSCRIPT = "actionscript"
    (read)

    Constant passed into findCuePoint or findNearestCuePoint type parameter.

    ALL

    static ALL = "all"
    (read)

    Constant passed into findCuePoint or findNearestCuePoint type parameter.

    BUFFERING

    static BUFFERING:String = "buffering"
    (read)

    State constant. State entered immediately after
    play() or load() is called.

    This is a responsive state.

    See also:

    CONNECTION_ERROR

    static CONNECTION_ERROR:String = "connectionError"
    (read)

    State constant. Stream attempted to load was unable to load
    for some reason. Could be no connection to server, stream not
    found, etc.

    This is a unresponsive state.

    See also:

    DISCONNECTED

    static DISCONNECTED:String = "disconnected"
    (read)

    State constant. This is the state when the VideoPlayer is
    constructed and when the stream is closed by a call to
    close() or timed out on idle.

    This is a responsive state.

    See also:

    EVENT

    static EVENT = "event"
    (read)

    Constant passed into findCuePoint or findNearestCuePoint type parameter.

    FLV

    static FLV = "flv"
    (read)

    Constant passed into findCuePoint or findNearestCuePoint type parameter.

    LOADING

    static LOADING:String = "loading"
    (read)

    State constant. State entered immediately after
    play() or load() is called or
    after contentPath property is set.

    This is a unresponsive state.

    See also:

    PAUSED

    static PAUSED:String = "paused"
    (read)

    State constant. FLV is loaded, but play is paused.
    This state is entered when pause() is
    called or when load() is called.

    This is a responsive state.

    See also:

    PLAYING

    static PLAYING:String = "playing"
    (read)

    State constant. FLV is loaded and is playing.
    This state is entered when play()is called.

    This is a responsive state.

    See also:

    REWINDING

    static REWINDING:String = "rewinding"
    (read)

    State constant. State entered during a autorewind triggered
    by a stop. After rewind is complete, the state will be
    STOPPED.

    This is a unresponsive state.

    See also:

    SEEK_TO_PREV_OFFSET_DEFAULT

    static private SEEK_TO_PREV_OFFSET_DEFAULT:Number = 1
    (read)

    SEEKING

    static SEEKING:String = "seeking"
    (read)

    State constant. State entered after seek()is called and also while user is scrubbing with seek bar.

    This is a unresponsive state.

    See also:

    shortVersion

    static shortVersion:String = "1.0.2"
    (read)

    STOPPED

    static STOPPED:String = "stopped"
    (read)

    State constant. FLV is loaded and play is stopped. This state
    is entered when stop() is called and when the
    playhead reaches the end of the stream.

    This is a responsive state.

    See also:

    version

    static version:String = "1.0.2.7"
    (read)

    VP_DEPTH_OFFSET

    static private VP_DEPTH_OFFSET:Number = 100
    (read)

    Instance properties

    __forceNCMgr

    private __forceNCMgr:NCManager
    (read)

    __height

    private __height:Number
    (read)

    __width

    private __width:Number
    (read)

    _activeVP

    private _activeVP:Number
    (read)

    _aspectRatio

    private _aspectRatio:Boolean
    (read)

    _autoPlay

    private _autoPlay:Boolean
    (read)

    _autoRewind

    private _autoRewind:Boolean
    (read)

    _autoSize

    private _autoSize:Boolean
    (read)

    _backButton

    private _backButton:MovieClip
    (read)

    _bufferingBar

    private _bufferingBar:MovieClip
    (read)

    _bufferingBarHides

    private _bufferingBarHides:Boolean
    (read)

    _bufferTime

    private _bufferTime:Number
    (read)

    _contentPath

    private _contentPath:String
    (read)

    _cpMgr

    private _cpMgr:Array
    (read)

    _cuePoints

    private _cuePoints:Array
    (read)

    _firstStreamReady

    private _firstStreamReady:Boolean
    (read)

    _firstStreamShown

    private _firstStreamShown:Boolean
    (read)

    _forwardButton

    private _forwardButton:MovieClip
    (read)

    _idleTimeout

    private _idleTimeout:Number
    (read)

    _isLive

    private _isLive:Boolean
    (read)

    _muteButton

    private _muteButton:MovieClip
    (read)

    _origHeight

    private _origHeight:Number
    (read)

    _origWidth

    private _origWidth:Number
    (read)

    _pauseButton

    private _pauseButton:MovieClip
    (read)

    _playButton

    private _playButton:MovieClip
    (read)

    _playheadUpdateInterval

    private _playheadUpdateInterval:Number
    (read)

    _playPauseButton

    private _playPauseButton:MovieClip
    (read)

    _preSeekTime

    private _preSeekTime:Number
    (read)

    _progressInterval

    private _progressInterval:Number
    (read)

    _scaleX

    private _scaleX:Number
    (read)

    _scaleY

    private _scaleY:Number
    (read)

    _seekBar

    private _seekBar:MovieClip
    (read)

    _seekBarInterval

    private _seekBarInterval:Number
    (read)

    _seekBarScrubTolerance

    private _seekBarScrubTolerance:Number
    (read)

    _seekToPrevOffset

    private _seekToPrevOffset:Number
    (read)

    _skin

    private _skin:String
    (read)

    _skinAutoHide

    private _skinAutoHide:Boolean
    (read)

    _stopButton

    private _stopButton:MovieClip
    (read)

    _topVP

    private _topVP:Number
    (read)

    _totalTime

    private _totalTime:Number
    (read)

    _transform

    private _transform:Object
    (read)

    _uiMgr

    private _uiMgr:UIManager
    (read)

    _visibleVP

    private _visibleVP:Number
    (read)

    _volume

    private _volume:Number
    (read)

    _volumeBar

    private _volumeBar:MovieClip
    (read)

    _volumeBarInterval

    private _volumeBarInterval:Number
    (read)

    _volumeBarScrubTolerance

    private _volumeBarScrubTolerance:Number
    (read)

    _vp

    private _vp:Array
    (read)

    _vpState

    _vpState:Array
    (read)

    activeVideoPlayerIndex

    activeVideoPlayerIndex:Number
    (read,write)

    Use activeVideoPlayerIndex to manage multiple FLV streams. Sets
    which VideoPlayer instance is affected by most
    other APIs. Default is 0. Does not make the
    VideoPlayer visible, to do this use
    visibleVideoPlayerIndex.

    A new VideoPlayer is created the first time
    activeVideoPlayerIndex is set to a given number. When
    the new VideoPlayer is created, its properties are set to the
    value of the default VideoPlayer (

    activeVideoPlayerIndex ==
0
    ) except for contentPath, totalTime and isLive, which
    are always set to the default values (empty string, 0 and
    false, respectively), autoPlay which is always false (default
    is true for the default VideoPlayer, aka 0), and height and
    width which match those of the visibleVideoPlayerIndex. Note that
    the cuePoints property will have no effect, just as it would
    have no effect on a subsequent load into the default
    VideoPlayer.

    APIs that control volume, positioning, dimensions,
    visibility and UI controls are always global and their behavior
    is NOT affected by setting activeVideoPlayerIndex. The
    APIs unaffected are: backButton, bufferingBar,
    bufferingBarHidesAndDisablesOthers, forwardButton, height,
    muteButton, pauseButton, playButton, playPauseButton, scaleX,
    scaleY, seekBar, seekBarInterval, seekBarScrubTolerance,
    seekToPrevOffset, skin, transform, stopButton, visible, volume,
    volumeBar, volumeBarInterval, volumeBarScrubTolerance, width,
    x, y, setSize(), setScale()

    APIs that control dimensions do interact with
    visibleVideoPlayerIndex, however. See that property
    for more on that.

    APIs that target specific VideoPlayer depending on setting
    of activeVideoPlayerIndex: all the rest!

    When listening for events, you will get all events for all
    VideoPlayers. To distinguish which VideoPlayer the vent is for
    use the events vp property, a Number corresponding
    to the number set in activeVideoPlayerIndex and
    visibleVideoPlayerIndex. All events have this property EXCEPT for
    "resize" and "volumeUpdate" which are not specific to a VideoPlayer
    but are global for the FLVPlayback instance.

    For example, to load a second FLV in the background, set
    activeVideoPlayerIndex to 1 and call load().
    When you are ready to show this one and hide the other one, set
    visibleVideoPlayerIndex to 1.

    See also:
    Component metadata:
      Bindable

      addEventListener

      addEventListener:Function
      (read)

      autoPlay

      autoPlay:Boolean
      (read,write)

      Determines whether the FLV is played immediately when
      contentPath property is set or if we wait. Even if
      autoPlay is false, we do load the content immediately.

      If set between loads of new FLVs, has no effect until
      next set of contentPath.

      See also:
      Component metadata:
        Inspectable
        defaultValue:
        true

        autoRewind

        autoRewind:Boolean
        (read,write)

        Determines whether the FLV is rewound to the first frame
        when play stops, either by calling stop() or by
        reaching the end of the stream. Meaningless for live streams.

        Component metadata:
          Inspectable
          defaultValue:
          true

          autoSize

          autoSize:Boolean
          (read,write)

          Determines whether the instance is automatically resized to
          the source dimensions. If this is set from false to true after
          an FLV has been loaded, an automatic resize will start
          immediately.

          See also:
          Component metadata:
            Inspectable
            defaultValue:
            false

            backButton

            backButton:MovieClip
            (read,write)

            back button control. Clicking calls
            seekToPrevNavCuePoint().

            See also:

            •

            bitrate

            bitrate:Number
            (read,write)

            Get the bandwidth. Numerical Value in bits per second.

            When streaming from FCS, can provide SMIL file that
            describes how to switch between multiple streams based on
            bandwidth. Bandwidth is automatically detected by FCS server
            and if this value is set, it will be ignored.

            When doing http progressive download, can use the same SMIL
            format, but must set the bitrate as there is no automatic
            detection.

            boundingBox_mc

            public boundingBox_mc:MovieClip
            (read)

            bounding box movie clip inside of component on stage

            buffering

            buffering:Boolean
            (read)

            If state is buffering. Read only.

            bufferingBar

            bufferingBar:MovieClip
            (read,write)

            buffering bar control. Displays when in loading or
            buffering type state.

            bufferingBarHidesAndDisablesOthers

            bufferingBarHidesAndDisablesOthers:Boolean
            (read,write)

            If true, we hide and disable certain controls when the
            buffering bar is displayed. The seek bar will be hidden, the
            play, pause, play/pause, forward and back buttons would be
            disabled. Default is false. This only has effect if there
            is a buffering bar control.

            bufferTime

            bufferTime:Number
            (read,write)

            Sets number of seconds to buffer in memory before playing
            back stream. For slow connections streaming over rtmp, it is
            important to increase this from the default. Default is
            0.1

            Component metadata:
              Inspectable
              defaultValue:
              0.1

              bytesLoaded

              bytesLoaded:Number
              (read)

              property bytesLoaded, read only. Returns -1 when there
              is no stream, when the stream is FCS or if the information
              is not yet available. Return value only useful for HTTP
              download.

              Component metadata:
                Bindable
                ChangeEvent
                "progress"

                bytesTotal

                bytesTotal:Number
                (read)

                property bytesTotal, read only. Returns -1 when there
                is no stream, when the stream is FCS or if the information
                is not yet available. Return value only useful for HTTP
                download.

                Component metadata:
                  Bindable
                  ChangeEvent
                  "progress"

                  contentPath

                  contentPath:String
                  (read,write)

                  URL that determines FLV to stream and how to stream it.
                  URL can be http URL to an FLV, rtmp URL to a stream or
                  http URL to an XML file.

                  If set via component inspector or property inspector, the
                  loading and/or playing of FLV starts on next "enterFrame" event.
                  Delay is to allow time to set isLive, autoPlay and cuePoints
                  properties, among others, which effect loading, as well as to
                  allow ActionScript on frame one to effect the FLVPlayback
                  component before it starts playing.

                  If set via ActionScript, it immediately calls
                  VideoPlayer.load() if autoPlay is
                  false or VideoPlayer.play() if
                  autoPlay is true. Also sends properties
                  totalTime and isLive into those
                  VideoPlayer APIs, so be sure to set those BEFORE
                  setting this property.

                  See also:
                  Component metadata:
                    Bindable
                    Inspectable
                    type:
                    "Video Content Path"

                    cuePoints

                    cuePoints:Array
                    (write)

                    Write only Array that describes ActionScript cue points and
                    disabled embedded FLV cue points. This API is created
                    specifically to be used by the component inspector and
                    will not work if set in any other way. Its value only
                    has an effect on the first FLV loaded, and only if it
                    is loaded by setting the contentPath property in the
                    component inspector or property inspector.

                    To add, remove, enable or disable cue points with
                    ActionScript, use use addASCuePoint(),
                    removeASCuePoint(),
                    setFLVCuePointEnabled().

                    See also:
                    Component metadata:
                      Inspectable
                      type:
                      "Video Cue Points"

                      dispatchEvent

                      dispatchEvent:Function
                      (read)

                      dispatchQueue

                      dispatchQueue:Function
                      (read)

                      forwardButton

                      forwardButton:MovieClip
                      (read,write)

                      height

                      height:Number
                      (read,write)

                      Height of video

                      See also:
                      Component metadata:
                        Bindable
                        ChangeEvent
                        "resize"

                        idleTimeout

                        idleTimeout:Number
                        (read,write)

                        Property idleTimeout, which is amount of time in
                        milliseconds before connection is idle (playing is paused
                        or stopped) before connection to the FCS server is
                        terminated. Has no effect to HTTP download of FLV.

                        If set when stream already idle, restarts idle timeout with
                        new value.

                        isLive

                        isLive:Boolean
                        (read,write)

                        Whether stream is live. This property only matters when
                        streaming from FVSS or FCS; value is ignored when doing
                        http download.

                        If set between loads of new FLVs, has no effect until
                        next set of contentPath.

                        See also:
                        Component metadata:
                          Inspectable
                          defaultValue:
                          false

                          isRTMP

                          isRTMP:Boolean
                          (read)

                          True if stream is RTMP download (streaming from Flash
                          Communication Server), read only.
                          See also:

                          maintainAspectRatio

                          maintainAspectRatio:Boolean
                          (read,write)

                          Determines whether video aspect ratio is maintained. If
                          this is set from false to true and autoSize is
                          false after an FLV has been loaded, an automatic resize will
                          start immediately.

                          See also:
                          Component metadata:
                            Inspectable
                            defaultValue:
                            true

                            metadata

                            metadata:Object
                            (read)

                            Read only. Metadata info packet received in onMetaData
                            callback, if available. Ready when "metadataReceived" event
                            dispatched.

                            See also:

                            metadataLoaded

                            metadataLoaded:Boolean
                            (read)

                            Read only. True if metadata packet has been encountered and
                            processed OR if it is clear that it will not be. Use this to
                            check if useful information can be retreived from there various
                            cue point APIs (findCuePoint, findNearestCuePoint,
                            findNextCuePointWithName, isFLVCuePointEnabled) for FLV
                            embedded cue points.

                            See also:

                            muteButton

                            muteButton:MovieClip
                            (read,write)

                            mute button control.

                            ncMgr

                            ncMgr:INCManager
                            (read)

                            Access to instance of the class implementing
                            INCManager. Read only.

                            One use case for this is that a custom
                            INCManager implementation may require custom
                            initialization.

                            VideoPlayer#ncMgr

                            pauseButton

                            pauseButton:MovieClip
                            (read,write)

                            pause button control.

                            paused

                            paused:Boolean
                            (read)

                            If state is paused. Read only.
                            Component metadata:
                              Bindable
                              ChangeEvent
                              "paused"
                              "stateChange"

                              playButton

                              playButton:MovieClip
                              (read,write)

                              play button control.

                              playheadPercentage

                              playheadPercentage:Number
                              (read,write)

                              Gets the percentage played.
                              Returns a number between 0 and 100.

                              Seeks to a percentage of the way through the file.
                              Takes a number between 0 and 100.

                              Throws:
                              • VideoError if percent is invalid or if totalTime is
                                undefined, null or <= 0
                              See also:

                              playheadTime

                              playheadTime:Number
                              (read,write)

                              The current playhead time in seconds. Setting does a seek
                              and has all the restrictions of a seek.

                              The event "playheadUpdate" is dispatched when the playhead
                              time changes, including every .25 seconds while the FLV is
                              playing.

                              Returns:
                              • The playhead position, measured in seconds since the start. Will return a fractional value.
                              See also:
                              Component metadata:
                                Bindable
                                ChangeEvent
                                "playheadUpdate"

                                playheadUpdateInterval

                                playheadUpdateInterval:Number
                                (read,write)

                                Property playheadUpdateInterval, which is amount of time
                                in milliseconds between each "playheadUpdate" event.

                                If set when stream is playing, will restart timer.

                                See also:

                                playing

                                playing:Boolean
                                (read)

                                If state is playing. Read only.
                                Component metadata:
                                  Bindable
                                  ChangeEvent
                                  "playing"
                                  "stateChange"

                                  playPauseButton

                                  playPauseButton:MovieClip
                                  (read,write)

                                  play/pause button control

                                  preferredHeight

                                  preferredHeight:Number
                                  (read)

                                  property preferredHeight, get only. Gives the height of the
                                  source FLV. This information is not valid immediately upon
                                  calling play() or load(). It is
                                  ready when the "ready" event fires.

                                  Returns:
                                  • The preferred height of the display.
                                    This is the height of the source FLV.
                                  See also:
                                  Component metadata:
                                    Bindable
                                    ChangeEvent
                                    "metadataReceived"

                                    preferredWidth

                                    preferredWidth:Number
                                    (read)

                                    property preferredWidth, get only. Gives the width of the
                                    source FLV. This information is not valid immediately upon
                                    calling play() or load(). It is
                                    ready when the "ready" event fires.

                                    Returns:
                                    • The preferred width of the display.
                                      This is the width of the source FLV.
                                    See also:
                                    Component metadata:
                                      Bindable
                                      ChangeEvent
                                      "metadataReceived"

                                      preview_mc

                                      private preview_mc:MovieClip
                                      (read)

                                      progressInterval

                                      progressInterval:Number
                                      (read,write)

                                      Property progressInterval, which is amount of time
                                      in milliseconds between each "progress" event.

                                      If set when stream is playing, will restart timer.

                                      See also:

                                      removeEventListener

                                      removeEventListener:Function
                                      (read)

                                      scaleX

                                      scaleX:Number
                                      (read,write)

                                      100 is standard scale
                                      See also:
                                      Component metadata:
                                        Bindable
                                        ChangeEvent
                                        "resize"

                                        scaleY

                                        scaleY:Number
                                        (read,write)

                                        100 is standard scale
                                        See also:
                                        Component metadata:
                                          Bindable
                                          ChangeEvent
                                          "resize"

                                          scrubbing

                                          scrubbing:Boolean
                                          (read)

                                          True if user is currently scrubbing with the seek bar. read only

                                          seekBar

                                          seekBar:MovieClip
                                          (read,write)

                                          seek bar control

                                          seekBarInterval

                                          seekBarInterval:Number
                                          (read,write)

                                          Determines how often check the seek bar handle location when
                                          scubbing, in milliseconds. Default is 250.
                                          See also:

                                          seekBarScrubTolerance

                                          seekBarScrubTolerance:Number
                                          (read,write)

                                          Determines how far user can move scrub bar before an update
                                          will occur. Specified in percentage from 1 to 100. Set to 0
                                          to indicate no scrub tolerance--always update position on
                                          seekBarInterval regardless of how far user has moved handle.
                                          Default is 5.

                                          See also:

                                          seekToPrevOffset

                                          seekToPrevOffset:Number
                                          (read,write)

                                          when seekToPrevNavCuePoint compares its time against the
                                          previous cue point, it uses this delta to be sure that if you
                                          are just ahead of a cue point, you can hop over it to the
                                          previous and not get stuck going to the same one over and over
                                          if you are playing. In seconds

                                          skin

                                          skin:String
                                          (read,write)

                                          Skin swf

                                          Component metadata:
                                            Inspectable
                                            type:
                                            "Video Skin"

                                            skinAutoHide

                                            skinAutoHide:Boolean
                                            (read,write)

                                            Whether to hide the skin when the mouse is not over the video.
                                            Defaults to false.

                                            Component metadata:
                                              Inspectable
                                              defaultValue:
                                              false

                                              state

                                              state:String
                                              (read)

                                              Get state. Read only. Set with load(),
                                              play(), stop(),
                                              pause() and seek().

                                              Descriptive constants for values are defined.

                                              See also:
                                              Component metadata:
                                                Bindable
                                                ChangeEvent
                                                "stateChange"

                                                stateResponsive

                                                stateResponsive:Boolean
                                                (read)

                                                Read only. Gets whether state is responsive,
                                                i.e. whether controls should be enabled in the current
                                                state.

                                                See also:

                                                stopButton

                                                stopButton:MovieClip
                                                (read,write)

                                                stop button control.

                                                stopped

                                                stopped:Boolean
                                                (read)

                                                If state is stopped. Read only.
                                                Component metadata:
                                                  Bindable
                                                  ChangeEvent
                                                  "stateChange"
                                                  "stopped"

                                                  totalTime

                                                  totalTime:Number
                                                  (read,write)

                                                  property totalTime.

                                                  When streaming from FCS and using the default
                                                  NCManager, this will be determined
                                                  automatically using server side APIs and that value will
                                                  override anything set through this property or gathered
                                                  from metadata. The property is ready for read when the
                                                  STOPPED or PLAYING state is reached after setting the
                                                  contentPath property. When live streaming
                                                  from FCS, this property is meaningless.

                                                  With HTTP download, this property will be determined
                                                  automatically if the FLV has metadata embedded, otherwise
                                                  it must be set explicitly or it will be 0. If it is set
                                                  explicitly than the metadata value in the stream will be
                                                  ignored.

                                                  When this is set, the setting takes effect for the next
                                                  FLV loaded by setting contentPath, it will have no effect
                                                  on a flv that has already been loaded. Also, reading this
                                                  property will not return the new value passed in until an
                                                  flv is loaded.

                                                  Playback will still work if this is never set (either
                                                  explicitly or automatically), but it may cause problems
                                                  with seek controls.

                                                  Returns:
                                                  • The total running time of the FLV in seconds
                                                  See also:
                                                  Component metadata:
                                                    Bindable
                                                    ChangeEvent
                                                    "metadataReceived"
                                                    Inspectable
                                                    defaultValue:
                                                    0

                                                    transform

                                                    transform:Object
                                                    (read,write)

                                                    Provides direct access to the
                                                    Sound.setTransform() and
                                                    Sound.getTransform() APIs. to expose more sound
                                                    control. Must set property for changes to take effect, get
                                                    property just to get a copy of the current settings to tweak.

                                                    See also:

                                                    version_1_0_2

                                                    version_1_0_2:String
                                                    (read,write)

                                                    read only, only included to appear in the CI
                                                    Component metadata:
                                                      Inspectable
                                                      defaultValue:
                                                      ""

                                                      visible

                                                      visible:Boolean
                                                      (read,write)

                                                      visibleVideoPlayerIndex

                                                      visibleVideoPlayerIndex:Number
                                                      (read,write)

                                                      Use visibleVideoPlayerIndex to manage multiple FLV streams.
                                                      qSets which VideoPlayer instance is visible and
                                                      audible--only one at a time can be, the rest are hidden and
                                                      muted. Default is 0. Does not make the VideoPlayertargeted by most APIs, for that useactiveVideoPlayerIndex

                                                      APIs that control dimensions interact with this property.
                                                      All that set the dimensions (setScale, setSize, set width, set
                                                      height, set scaleX, set scaleY) effect all VideoPlayers.
                                                      However, depending on whether autoSize or maintaintAspectRatio
                                                      are set on those VideoPlayers, they may have different
                                                      dimensions. So APIs that get the dimensions (get width, get
                                                      height, get scaleX, get scaleY) get the dimensions of the
                                                      visible VideoPlayer only, and while other VideoPlayers may
                                                      have the same dimensions, they may not.

                                                      To get the dimensions of various VideoPlayers when they are
                                                      not visible, listen for the "resize" event and cache the size
                                                      value yourself.

                                                      Does not have any implications for visibility of the
                                                      component as a whole, just which VideoPlayer is visible when
                                                      the component is visible. To set visibility for the entire
                                                      component, use visible property.

                                                      See also:

                                                      volume

                                                      volume:Number
                                                      (read,write)

                                                      Volume control in range from 0 to 100.

                                                      Returns:
                                                      • The most recent volume setting
                                                      See also:
                                                      Component metadata:
                                                        Bindable
                                                        ChangeEvent
                                                        "volumeUpdate"
                                                        Inspectable
                                                        defaultValue:
                                                        100

                                                        volumeBar

                                                        volumeBar:MovieClip
                                                        (read,write)

                                                        volume control

                                                        volumeBarInterval

                                                        volumeBarInterval:Number
                                                        (read,write)

                                                        Determines how often check the volume bar handle location
                                                        when scubbing, in milliseconds. Default is 250.
                                                        See also:

                                                        volumeBarScrubTolerance

                                                        volumeBarScrubTolerance:Number
                                                        (read,write)

                                                        Determines how far user can move scrub bar before an update
                                                        will occur. Specified in percentage from 1 to 100. Set to 0
                                                        to indicate no scrub tolerance--always update volume on
                                                        volumeBarInterval regardless of how far user has moved handle.
                                                        Default is 0.

                                                        See also:

                                                        width

                                                        width:Number
                                                        (read,write)

                                                        Width of video

                                                        See also:
                                                        Component metadata:
                                                          Bindable
                                                          ChangeEvent
                                                          "resize"

                                                          x

                                                          x:Number
                                                          (read,write)

                                                          Component metadata:
                                                            Bindable

                                                            y

                                                            y:Number
                                                            (read,write)

                                                            Component metadata:
                                                              Bindable

                                                              Instance methods

                                                              _scrubFinish

                                                              function _scrubFinish (
                                                              ) : Void

                                                              Called by UIManager when seekbar scrubbing finishes

                                                              _scrubStart

                                                              function _scrubStart (
                                                              ) : Void

                                                              Called by UIManager when seekbar scrubbing starts

                                                              addASCuePoint

                                                              function addASCuePoint (
                                                              timeOrCuePoint:Object, name:String, parameters:Object) : Number

                                                              Add an ActionScript cue point.

                                                              Cue point information is wiped out when contentPath property
                                                              is set, so to set cue point info for the next FLV to be loaded,
                                                              set contentPath first.

                                                              It is legal to add multiple AS cue points with the same
                                                              name and time. When removeASCuePoint is called with this
                                                              name and time, all will be removed.

                                                              Parameters:
                                                              timeOrCuePoint:
                                                              If Object, then object describing the cue
                                                              point. Must have a name:String and time:Number (in seconds)
                                                              property. May have a parameters:Object property that holds
                                                              name/value pairs. May have type:String set to "actionscript",
                                                              if it is missing or set to something else it will be set
                                                              automatically. If the Object does not conform to these
                                                              conventions, a VideoError will be thrown.

                                                              If Number, then time for new cue point to be added
                                                              and name parameter must follow.

                                                              name :
                                                              Name for cuePoint if timeOrCuePoint parameter
                                                              is a Number.
                                                              parameters :
                                                              Optional parameters for cuePoint if
                                                              timeOrCuePoint parameter is a Number.
                                                              Returns:
                                                              • The cuePoint Object added. Read only: edits to this
                                                                Object will effect "cuePoint" event dispatch.
                                                              Throws:
                                                              See also:

                                                              bringVideoPlayerToFront

                                                              function bringVideoPlayerToFront (
                                                              index:Number) : Void

                                                              Brings VideoPlayer to the front of the stack of VideoPlayers.
                                                              Useful for custom transitions between VideoPlayers.

                                                              closeVideoPlayer

                                                              function closeVideoPlayer (
                                                              index:Number) : VideoPlayer

                                                              Close VideoPlayer with given index. Closes NetStream and
                                                              deletes VideoPlayer. If the closed video player is the active
                                                              or visible VideoPlayer, then active and/or visible VideoPlayer
                                                              will be set to the default player (with index 0). You cannot
                                                              close the default player, and trying to will throw an error.

                                                              createLivePreviewMovieClip

                                                              private function createLivePreviewMovieClip (
                                                              ) : Void

                                                              Creates live preview placeholder

                                                              createUIManager

                                                              private function createUIManager (
                                                              ) : Void

                                                              Creates UIManager and sets any properties that need setting

                                                              createVideoPlayer

                                                              private function createVideoPlayer (
                                                              index:Number) : Void

                                                              Creates and configures VideoPlayer movie clip

                                                              doContentPathConnect

                                                              private function doContentPathConnect (
                                                              ) : Void

                                                              Called on onEnterFrame to initiate loading the new
                                                              contentPath url. We delay to give the user time to set other
                                                              vars as well. Only done this way when contentPath set from the
                                                              component inspector or property inspector, not when set with AS.
                                                              See also:

                                                              findCuePoint

                                                              function findCuePoint (
                                                              timeNameOrCuePoint:Object, type:String) : Object

                                                              Find the cue point at the given time and/or with given name.
                                                              Which type of cue points searched is determined by optional
                                                              type parameter. Default is to search all cue
                                                              points. Note that disabled cue points are also included in the
                                                              search, use isFLVCuePointEnabled. How the cue points are
                                                              searched depends on the type of the first argument.

                                                              Parameters:
                                                              timeNameOrCuePoint:
                                                              If String, then name of cue point to
                                                              search for. Return the first cue point with this name, or null
                                                              if no match.

                                                              If Number, time of cue point to search for. Only first
                                                              three decimal places of time used for search, any more than
                                                              that will be rounded. Returns the first cue point with this
                                                              time (If there are multiples with same time, which is only
                                                              possible with ActionScript cue points, then the one with the
                                                              first name alphabetically will be returned.) Returns null if
                                                              no match.

                                                              If Object, then cuepoint object containing time and/or name
                                                              properties for search. If name is undefined or null, then
                                                              search behaves same as described above for time only search.
                                                              If time is undefined, null or less than 0, then search behaves
                                                              same as described above for name only search. If both time
                                                              and name are defined and a cue point exists with both that
                                                              time and name, then it is returned, otherwise null is returned.

                                                              If time is null, undefined or less than 0 and name is null
                                                              or undefined, a VideoError is thrown.

                                                              type :
                                                              determines what class of cue points is searched.
                                                              possible values are "all", "navigation", "event", "flv",
                                                              "actionscript". There are constants defined for each of these.
                                                              Returns:
                                                              • null if no match was found, otherwise
                                                                copy of cuePoint object with additional properties:
                                                                • array - the array of cue points that was
                                                                  searched. Treat this array as read only as adding, removing or
                                                                  editing objects within it can cause cue points to
                                                                  malfunction.
                                                                • index - the index into the array for the
                                                                  returned cuepoint.
                                                              See also:

                                                              findNearestCuePoint

                                                              function findNearestCuePoint (
                                                              timeNameOrCuePoint:Object, type:String) : Object

                                                              Find the cue point at or near the given time and/or with
                                                              given name. Which type of cue points searched is determined by
                                                              optional type parameter. Default is to search all
                                                              cue points. Note that disabled cue points are also included in
                                                              the search, use isFLVCuePointEnabled. How the cue points are
                                                              searched depends on the type of the first argument.

                                                              Parameters:
                                                              timeNameOrCuePoint:
                                                              If String, then name of cue point to
                                                              search for. Return the first cue point with this name, or null
                                                              if no match.

                                                              If Number, time of cue point to search for. Only first
                                                              three decimal places of time used for search, any more than
                                                              that will be rounded. If there is an exact time match, returns
                                                              the first cue point with this time (If there are multiples with
                                                              same time, which is only possible with ActionScript cue points,
                                                              then the one with the first name alphabetically will be
                                                              returned.) If the specific time is not found then the closest
                                                              time earlier than that is returned. If there is no cue point
                                                              earlier than time, the first cue point is returned. If there
                                                              are no cue points, null is returned.

                                                              If Object, then cuepoint object containing time and/or name
                                                              properties for search. If name is undefined or null, then
                                                              search behaves same as described above for time only search.
                                                              If time is undefined, null or less than 0, then search behaves
                                                              same as described above for name only search. If both time
                                                              and name are defined and a cue point exists with both that
                                                              time and name, then it is returned. If there is no exact
                                                              match, then the cue point with that exact name and with the
                                                              closest time earlier than that is returned. If there is
                                                              no cue point with that name earlier than that time, then
                                                              the first cue point with that name is returned. If there
                                                              are no cue points with that name, null is returned.

                                                              If time is null, undefined or less than 0 and name is null
                                                              or undefined, a VideoError is thrown.

                                                              type :
                                                              determines what class of cue points is searched.
                                                              possible values are "all", "navigation", "event", "flv",
                                                              "actionscript". There are constants defined for each of these.
                                                              Returns:
                                                              • null if no match was found, otherwise
                                                                copy of cuePoint object with additional properties:
                                                                • array - the array of cue points that was
                                                                  searched. Treat this array as read only as adding, removing or
                                                                  editing objects within it can cause cue points to
                                                                  malfunction.
                                                                • index - the index into the array for the
                                                                  returned cuepoint.
                                                              See also: