AS3 SWC flash video component.
| videosPath:String
(Optional) The path of the directory where the flv videos resides.
|
| videosXml:String
(Optional) An xml document that contains the videos which are to be loaded.
|
| globalVolume:Number (0 - 100)
(Optional) The global volume defines the max volume that can be set in the player. |
| videoVolume:Number (0 - 100)
(Optional) The volume of the current video.
|
| videoSmoothing:Boolean
(Optional) Anti-aliasing parameter.
|
| maxScreenWidth:Number
(Optional) The max width of the video when previewed in full-screen mode.
|
| fullVideoAlignment:String ("top", "middle", bottom)
(Optional) Vertical alignment of the video when previewed in full-screen mode.
|
| streamForcedPercent:Number (0 - 100)
(Optional) A percent of the video preload which forces the stream to start playing.
|
| streamSafePercent:Number (0 - 100)
(Optional) A percent that is added to the optimal download percent.
|
| stepTime:Number
(Optional) The amount of seconds that the play-head jumps when playInTime() is invoked
|
| videoRepeat:Boolean
(Optional) Parameter that enables the current video to repeat.
|
|
setVideoItem(videoUrl:String, addToList:Boolean = true, toplay:Boolean = true, toLoad:Boolean = true, infoObj:Object = null)
Load and play an flv video.
|
|
Return the current playing video object
|
|
loadMedia(mediaItem:Object)
Loads a video object.
|
|
Start playing of the current video stream.
|
|
Clears the video screen.
|
|
setFullScreen(toSet:Boolean)
Sets the player into a full-screen mode.
|
|
seekInMedia(seekPct:Number)
Seeks to the desired time. This function accepts a number which represents a percent of the play-head position.
|
|
Plays the the current video.
|
|
Stops the current video.
|
|
Pauses the current video.
|
|
playInTime(dir:String)
Moves the play-head to the desired direction. The amount of seconds is defined by the public property "stepTime".
|
|
Plays the next video item in the current playlist
|
|
Plays the previous video item in the current playlist.
|
|
createPlaylist(playlistTitle:String, playlistDesc:String)
Create a new playlist.
|
|
loadPlaylist(plId:Number)
Load playlist.
|
|
deletePlaylist(playlistId:Number)
Delete the playlist located by its id.
|
|
Delete all playlists.
|
|
Returns an array of all the created playlists.
|
|
setItemInQueue(item)
Sets the chosen item in the playing queue
|
|
Shuffles the items in the current playlist.
|
|
getPlaylistItem(playlistId:Number, playlistItemId:Number)
Return a video item object.
|
|
getPlaylistItems(playlistId:Number)
Returns an array of all items in the selected playlist.
|
|
playNextItem(playDir:String)
Plays the next item in the playlist stack, defined by the direction parameter.
|
|
Returns the current playlist.
|
|
Returns the loaded videos XML.
|
|
mergePlaylists(deleteRest:Boolean, baseListId:Number, secondListId:Number, ... listsId)
Merges the specified playlist, with option to delete the rest playlist.
|
|
Return a number that represents the player version.
|
|
Fired when videos xml has loaded.
|
|
Fired each time when the volume has been updated.
|
|
Fired when video stops.
|
|
Fired when video starts playing.
|
|
This event is fired when the queue stack gets to its end.
|
|
Fired when the video riches the end of its duration.
|
|
If the stream couldn't be located this event is fired.
|
|
On successful connection.
|
|
This event holds an object that has the current status of the video player.
|
|
Fired when the components is added to stage
|
|
Fired when the component has been removed from the stage.
|
|
This event holds an object with information about the current stream.
|
|
Fired on every cue point, if any. This events holds an "info" object that has the following properties: time, name, type
|
|
Fired when "onMetaData" function has been invoked.
|
|
Fired when the contructor is initialized.
|
public var videosPath:String
SupraVideoPro.videosPath = "../videos/";
public var videosXml:String
URL of the XML document that contains the video items.
SupraVideoPro.videosXml = "../xml/videos.xml";
public var globalVolume:Number
SupraVideoPro.globalVolume = 100;
public var videoVolume:String
SupraVideoPro.videoVolume = 50;
public var videoSmoothing:Boolean
SupraVideoPro.videoSmoothing = true;
public var maxScreenWidth:Number
SupraVideoPro.maxScreenWidth = 500;
public var fullVideoAlignment:String
SupraVideoPro.fullVideoAlignment = "middle";
public var streamForcedPercent:Number
SupraVideoPro.streamForcedPercent = 20;
public var streamSafePercent:Number
SupraVideoPro.streamSafePercent = 10;
public var stepTime:String
SupraVideoPro.stepTime = 2000;
public var videoRepeat:Boolean
SupraVideoPro.videoRepeat = false;
public function setVideoItem(videoUrl:String, addToList:Boolean = true, toplay:Boolean = true, toLoad:Boolean = true, infoObj:Object = null):MediaPlaylistItem
Registers an event listener.
videoUrl:String — The url of the video stream.
addToList:Boolean — This parameter defines if the video object is going to be added in the current playlist.
toplay:Boolean — Determines whether the video stream will be played after successful load.toLoad:Boolean — Determines whether the video will start streaming or just be loaded in the playlist.infoObj:Object — Object that should have the following parameters: {itemTitle: "", itemAuthor: "", itemYear: ""}public function getCurrentPlayItem():MediaPlaylistItem
Return the current playing item which is an object of type MediaPlaylistItem having the following parameters:
mediaItemUrl:String — The url of the video stream. mediaItemToPlay:Boolean —Determines whether the video stream will be played after successful load.mediaItemInfoObject:Object — This is the info object that has the following parameters: {itemTitle: "", itemAuthor: "", itemYear: ""}mediaItemId:String — The id of the added video item.public function loadMedia(mediaItem:MediaPlaylistItem):Void
Loads video item.
mediaItem:MediaPlaylistItem — Object that has the following parameters: {mediaItemUrl:String, mediaItemToPlay:Boolean, mediaItemInfoObject:Object, mediaItemId:String}.
public function startToPlay():void
Forces the loaded video stream to start playing.
public function flushVideo():Void
Clears the video screen.
public function setFullScreen():Void
Set the video player into a full-screen mode.
public function seekInMedia(seekPct:Number):Void
Moves the play-head to the desired play percent.
seekPct:Number — The percent amount.
public function playMedia():Void
Plays the current video stream.
public function stopMedia():Void
Stops playing the current video stream.
public function pauseMedia():Void
Pause the current video stream.
public function playInTime(dir:String):Void
Moves the play-head in depending the chosen direction for a certain amount of milliseconds defined by the public parameter "stepTime".
dir:String — The value should be "+" or "-" depending of which direction the play-head should move, backwards or forward respectively.. public function nextMediaItem():Void
Loads the next video from the playlist stack.
public function prevMediaItem():Boolean
Loads the previous video from the playlist stack
public function createPlaylist(playlistTitle:String, playlistDesc:String):MediaPlaylist
Creates a new playlist.
playlistTitle:String — The title of the new playlist.playlistDesc:String —The description of the new playlist.MediaPlaylist object
public function loadPlaylist(playlistId:Number):Void
Loads playlist by id.
playlistId:Number — The playlist id.public function deletePlaylist(playlistId:Number):Void
Deletes the playlist with the id provided as an argument.
playlistId:Number — The playlist id.public function deleteAllPlaylists():void
Deletes all the saved playlists.
public function getPlaylists():Array
Returns an array of all the playlists
Arraypublic function setItemInQueue(item:MediaPlaylistItem):void
Sets the item in the play stack
item:MediaPlaylistItem — The item object.public function shuffleItems():void
Shuffles the items of the current playlist.
public function getPlaylistItem(playlistId:Number, playlistItemId:Number):MediaPlaylistItem
Returns the desired playlist item.
playlistId:Number — The id of the playlist that contains the video item.
playlistItemId:Number — The id of the video playlist item.item:MediaPlaylistItem — The item object.public function getPlaylistItems(playlistId:Number):Array
Returns all the items in the specified playlist.
playlistId:Number — The id of the playlist that contains the video item. Array— The array of video items.public function playNextItem(dir:String):void
Plays the next item from the playlist stack. The direction is defined by the passed function argument.
dir:String — The value must be "+" or "-".
public function getCurrentPlaylist():MediaPlaylist
Returns the current playlist.
MediaPlaylist— The playlist object..
public function getLoadedXml():XML
Returns the loaded XML.
XML— The loaded videos XMLpublic function mergePlaylists(deleteRest:Boolean, baseListId:Number, secondListId:Number, ... listsId):void
Merges the specified playlists ids.
deleteRest:Boolean — This parameter defines whether the rest of the playlists after the merging should be deleted.baseListId:Number —The playlist that will merge all the other playlists..secondListId:Number — The second playlist.public function getPlayerVersion():String
Returns the verison of the component.
String— The current version stamp code of the component.No propertiesvol:NumberNo propertiesNo propertiesNo propertiesNo propertiesNo propertiesNo propertiesplayerStatusObj.playerPlaying;
playerStatusObj.playerVersion;
playerStatusObj.videoRepeat;
playerStatusObj.videoPaused;
playerStatusObj.currentPlaylist;
playerStatusObj.globalVolume;
playerStatusObj.currentVideoDuration;
playerStatusObj.currentVideoTime;
playerStatusObj.videoSmoothing;
playerStatusObj.videosPath;
playerStatusObj.currentMediaItem.mediaItemUrl;
playerStatusObj.currentMediaItem.mediaItemToPlay;
playerStatusObj.currentMediaItem.mediaItemId;
playerStatusObj.currentMediaItem.mediaItemInfoObject.itemTitle;
playerStatusObj.currentMediaItem.mediaItemInfoObject.itemAuthor;
playerStatusObj.currentMediaItem.mediaItemInfoObject.itemYear;
playerStatusObj.currentMediaItem.mediaItemInfoObject.thumbUrl;
No propertiesNo propertiesstreamStatus.totalBytes;
streamStatus.totalLoadedBytes;
streamStatus.optimalSpeed;
streamStatus.currentSpeed;
streamStatus.bytesLeft;
streamStatus.timeLeft;
streamStatus.dynamicLoadPercentLimit;
streamStatus.safePercent;
streamStatus.forcedPercent;
streamStatus.loadedPercents;info.time;
info.name;
info.type;
metaDataObj;
No properties© 2009 SupravisionMedia. All rights reserved.