IVideoNarrationPlayer

PropertiesMethodsEvents
Packageispring.presenter.player.video
Interfacepublic interface IVideoNarrationPlayer extends flash.events.IEventDispatcher

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The IVideoNarrationPlayer represents a video narration player providing video narration visualization and control facilities.

To obtain the IVideoNarrationPlayer interface associated with a presentation view use the videoNarrationPlayer property on the IPresentationView interface.

See also

ispring.presenter.player.IPresentationView.videoNarrationPlayer

Public Properties
PropertyDefined By
currentTrack : IVideoTrack
[read-only] Returns the IVideoTrack interface providing information about the current video track.
IVideoNarrationPlayer
currentTrackIndex : uint
[read-only] Returns an index of the currently playing video track.
IVideoNarrationPlayer
currentTrackResolution : IVideoResolution
[read-only] Returns the IVideoResolution interface providing information about the current video track resolution.
IVideoNarrationPlayer
displayObject : DisplayObject
[read-only] The flash.display.DisplayObject object visualizing the video narration tracks.
IVideoNarrationPlayer
Public Methods
MethodDefined By
 
changeVideoResolution(videoTrackIndex:uint, resolutionIndex:uint):void
Changes the current resolution of the video track with the specified index.
IVideoNarrationPlayer
 
resize(width:Number, height:Number):void
Resizes the narration player.
IVideoNarrationPlayer
Events
Event Summary Defined By
 
currentTrackChanged
Dispatched to notify a listener that the current track has been changed.IVideoNarrationPlayer
Property Detail
currentTrackproperty
currentTrack:IVideoTrack  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns the IVideoTrack interface providing information about the current video track. The null value is returned if no video track is currently playing.


Implementation
    public function get currentTrack():IVideoTrack

See also

ispring.presenter.presentation.narration.IVideoTrack
currentTrackIndexproperty 
currentTrackIndex:uint  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns an index of the currently playing video track. The uint.MAX_VALUE is returned if no video track is currently playing.


Implementation
    public function get currentTrackIndex():uint
currentTrackResolutionproperty 
currentTrackResolution:IVideoResolution  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns the IVideoResolution interface providing information about the current video track resolution. The null is returned if no video track is currently playing.


Implementation
    public function get currentTrackResolution():IVideoResolution

See also

ispring.presenter.player.video.IVideoResolution
displayObjectproperty 
displayObject:DisplayObject  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The flash.display.DisplayObject object visualizing the video narration tracks.


Implementation
    public function get displayObject():DisplayObject

See also

flash.display.DisplayObject
Method Detail
changeVideoResolution()method
public function changeVideoResolution(videoTrackIndex:uint, resolutionIndex:uint):void

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Changes the current resolution of the video track with the specified index. This method does nothing if the track is not a IStreamingVideoTrack.

Parameters

videoTrackIndex:uint — The index of the video track in the video narration tracks collection. See the IVideoTracks interface for more details.
 
resolutionIndex:uint — The index of the video resolution in the resolutions collection of a video track. Currently it must always be 0.


Throws
RangeError — Throws if the videoTrackIndex is out of range.
 
RangeError — Throws if the resolutionIndex is out of range.

See also

ispring.presenter.presentation.narration.IVideoTracks
resize()method 
public function resize(width:Number, height:Number):void

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Resizes the narration player.

Parameters

width:Number — A new width of the narration player in pixels.
 
height:Number — A new height of the narration player in pixels.

Event Detail
currentTrackChanged Event
Event Object Type: ispring.presenter.player.video.events.VideoNarrationPlayerEvent
VideoNarrationPlayerEvent.type property = ispring.presenter.player.video.events.VideoNarrationPlayerEvent.CURRENT_TRACK_CHANGED

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched to notify a listener that the current track has been changed.

The VideoNarrationPlayerEvent.CURRENT_TRACK_CHANGED constant defines the value of the type property of the event object for a currentTrackChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.




Tue Dec 4 2012, 06:27 PM +04:00