FLASHANTS Tutorial - FSCommand tutorial

FMProjector/FMPlayer Tutorial > fscommand Tutorial

Back link
	Home FMProjetor FMPlayer

Sample & Tutorial

Fundamental
- FSCommand Fundamental
- FMProjector Howto
- FMPlayer Howto
- Smartclips Howto
FSCommand Samples
- FSCommand Tutorial
- 1. Play video in Flash
- 2. Streaming&Overlap
- 3. Full screen video
- 4. Fast forward/backward
- 5. Synchronization
- 6. Embed PDF
- 7. Embed RealPlayer object
- 8. ASP interface
Smartclip Samples
- 9. Video w/ slider
-10. Read/write registry w/ sc
FSCommand Reference
- FAQ
- FSCommand Tutorial
- FSCommand fast track
Showcases
Support Forum
Submit yours
Anything done by you that can inspire and do help to others. It has better to be short, clear, and self-explained.

Contact
	Technical Support support@flashants.com Marketing & Sales sales@flashants.com Feedback & Suggestion feedback@flashants.com

commands are supported by FMProjector 1.5 or FMPlayer 1.1.6.3 above. commands are supported by FMProjector 1.5 above. Video PlayBack Control
	fas.control.play fas.control.GetPosition fas.control.GetPosition2 fas.control.SetPosition fas.control.Stop fas.control.Pause fas.control.Forward fas.control.Backward fas.control.GetCurMarker fas.control.GetMarkerCount fas.control.GetMarkerTime fas.control.SetMarker	Description Description Description Description Description Description Description Description Description Description Description Description
Video Clip Control
	fas.avclip.AutoPlay fas.avclip.PlayCount fas.avclip.Rect fas.avclip.XY fas.avclip.BufferingProgress fas.avclip.GetBufferingTime fas.avclip.SetBufferingTime fas.avclip.GetDuration fas.avclip.Load fas.avclip.Unload fas.avclip.VideoOnTop fas.avclip.DisplaySize fas.avclip.AutoSize fas.avclip.ClickToPlay fas.avclip.FullScreen fas.avclip.UseWMP6	Description Description Description Description Description Description Description Description Description Description Description Description Description Description Description Description
Event Control
	fas.event.OpenStateChange fas.event.PlayStateChange fas.event.NewStream fas.event.EndOfStream fas.event.NewBuffering fas.event.EndOfBuffering fas.event.VideoRectChange fas.event.ScriptCommand fas.event.Disconnect fas.event.Warning fas.event.Error fas.event.MarkerHit	Description Description Description Description Description Description Description Description Description Description Description Description
Clip Information
	fas.clipinfo.GetTitle fas.clipinfo.GetAuthor fas.clipinfo.GetCopyRight	Description Description Description
Audio Control
	fas.sound.SetVolume fas.sound.GetVolume fas.sound.SetMute fas.sound.GetMute fas.sound.SetBalance fas.sound.GetBalance fas.sound.GetVolume2 fas.sound.SetVolume2	Description Description Description Description Description Description Description Description
ActiveX Object Control (FMProjector only)
	fas.axobj.Rect fas.axobj.XY fas.axobj.OpenPdf fas.axobj.Open fas.axobj.Close fas.axobj.OpenCult3D	Description Description Description Description Description Description
Registry & Shell (FMProjector only)
	fas.reg.get fas.reg.set fas.shell.GetInitDir fas.shell.open fas.shell.getSWF	Description Description Description Description Description
Window Appearance Control (FMProjector only)
	fas.win.title fas.win.move fas.win.bkrgb fas.win.style fas.win.pos fas.win.maxmize fas.win.minimize fas.win.show fas.win.hide fas.win.OnTop fas.win.clickToMove	Description Description Description Description Description Description Description Description Description Description Description
FLASH Default fscommand for Standalone Player (FMProjector only)
	FULLSCREEN ALLOWSCALE SHOWMENU EXEC QUIT TRAPALLKEYS	Description Description Description Description Description Description

	Back to Top

fscommand Description


	fas.control.play
	Begin playback AV clip
	Argument: void
	Example:
		fscommand ("fas.control.play", "");
	<Back>

	fas.control.GetPosition
	Get the current payback position in the unit of mini sec into variable.
	Argument: int variable(1/100 second)
	Example:
		fscommand ("fas.control.GetPosition", "CurPos");
	<Back>

	fas.control.GetPosition2
	Get the current payback position in the format of "hh:mm:ss" into variable.
	Argument: string variable(hh:mm:ss)
	Example:
		fscommand ("fas.control.GetPosition2", "CurPos"); Note: CurPos is a string variable
	<Back>

	fas.control.SetPosition
	Set AV clip playback position.
	Argument: int new_position(1/100 second)
	Example:
		fscommand("fas.contro.SetPosition",100); fscommand("fas.contro.SetPosition",_root.VideoPos);
	<Back>

	fas.control.Stop
	Stop playing AV clip.
	Argument: void
	Example:
		fscommand ("fas.control.Stop", "");
	<Back>

	fas.control.Pause
	Pause playback.
	Argument: void
	Example:
		fscommand ("fas.control.Pause", "");
	<Back>

	fas.control.Forward
	Move forward.
	Argument: void
	Example:
		fscommand("fas.control.Forward","");
	<Back>

	fas.control.Backward
	Move backward.
	Argument: void
	Example:
		fscommand("fas.control.Backward","");
	<Back>

	fas.control.GetCurMarker
	Get the current marker number
	Argument: int variable
	Example:
		fscommand("fas.control.GetMarker","CurMarkerNum");
	<Back>

	fas.control.GetMarkerCount
	Get the marker count
	Argument: int variable
	Example:
		fscommand("fas.control.GetMarkerCount","MarkerCount");
	<Back>

	fas.control.GetMarkerTime
	Get the marker time into the variable mini-second.
	Argument: int #marker,variable(1/100 second)
	Example:
		fscommand("fas.control.GetMarkerTime","2,MarkerTime");
	<Back>

	fas.control.SetMarker
	Set marker
	Argument: Marker ID
	Example:
		fscommand("fas.control.SetMarker",2);
	<Back>

	fas.avclip.AutoPlay
	Set/Unset AV clip's autoplay mode
	Argument: TRUE/ FALSE
	Example:
		fscommand ("fas.avclip.AutoPlay", "TRUE");
	<Back>

	fas.avclip.PlayCount
	Set count of repeated playbacks.
	Argument: positive integer
	Example:
		fscommand ("fas.avclip.PlayCount", "3");
	<Back>

	fas.avclip.Rect
	Set video area with coordinates.
	Argument: left,top,right,bottom
	Example:
		fscommand ("fas.avclip.Rect", "0,0,320,240");
	<Back>

	fas.avclip.XY
	Set the video area's position base on the left and up corner.
	Argument: x,y
	Example:
		fscommand ("fas.avclip.XY", "10,20");
	<Back>

	fas.avclip.BufferingProgress
	Get the buffering progress.
	Argument: int variable(0~100)
	Example:
		fscommand ("fas.avclip.bufferingprogress", "/iholder/load:BufferProgress");
	<Back>

	fas.avclip.GetBufferingTime
	Get AV clip's buffering length in seconds.
	Argument: int variable(second)
	Example:
		fscommand ("fas.avclip.GetBufferingTime", "BufTime");
	<Back>

	fas.avclip.SetBufferingTime
	Set AV clip's buffering time.
	Argument: buffering time(second)
	Example:
		fscommand ("fas.avclip.SetBufferingTime", 5);
	<Back>

	fas.avclip.GetDuration
	Get the duration of AV clip into a variable.
	Argument: int variable(second)
	Example:
		fscommand ("fas.avclip.GetDuration", "Duration");
	<Back>

	fas.avclip.Load
	Load AV clip from URL
	Argument: URL string
	Example:
		fscommand ("fas.avclip.Load", "..\test.mpeg");
	<Back>

	fas.avclip.Unload
	Unload AV clip.
	Argument: void
	Example:
		fscommand ("fas.avclip.UnLoad", "");
	<Back>

	fas.avclip.VideoOnTop
	Set/Unset video playback on the top-most layer. Note: This command should be placed before fas.avclip.load.
	Argument: BOOL: TRUE/FALSE
	Example:
		fscommand("fas.avclip.VideoOnTop","TRUE");
	<Back>

	fas.avclip.DisplaySize
	Set Video display window size.
	Argument: CONSTANT:DefaultSize/FitToSize/ FullScreen/ DoubleSize/OneHalfScreen/HalfScreen
	Example:
		fscommand("fas.avclip.DisplaySize","FitToSize"); Note: This command only works when fas.avclip.AutoSize is false, and if this command is set to FitToSize, then video size is dependent on fas.avclip.rect.
	<Back>

	fas.avclip.AutoSize
	Enable/Disable Autosize.
	Argument: BOOL: TRUE/FALSE
	Example:
		fscommand("fas.avclip.Autosize","TRUE"); true:video size is original video clip size false: video size depends on fas.avclip.displaysize. (If displaysize is set to FitToSize, then video size is set by fas.avclip.rect)
	<Back>

	fas.avclip.ClickToPlay
	Enable/Disable click to pause/play.
	Argument: BOOL: TRUE/FALSE
	Example:
		fscommand("fas.avclip.ClickToPlay","TRUE");
	<Back>

	fas.avclip.FullScreen
	Enable/Disable video full screen mode.
	Argument: BOOL: TRUE/FALSE
	Example:
		fscommand("fas.avclip.FullScreen,"TRUE"); This command only works when fas.avclip.VideoOnTop is true AND fas.avclip.AutoSize is false.
	<Back>

	fas.avclip.UseWMP6
	Force to utilize WMP6.X to play video in VideoOnTop mode.
	Argument: BOOL: TRUE/FALSE
	Example:
		fscommand("fas.avclip.UseWMP6,"TRUE");
	<Back>

	fas.event.OpenStateChange
	Set the action function to be triggered by the following events and pass the relative string by statVariable: "0: Content file is closed." "1: Loading an Advanced Stream Redirector (ASX) file." "2: Loading an .nsc station file." "3: Locating the server." "4: Connecting to the server." "5: Opening or listening for the stream." "6: Content file is open."
	Argument: ActionLabel(optional), stateVariable
	Example:
		fscommand ("fas.event.OpenStateChange", ",OpenState"); fscommand ("fas.event.OpenStateChange", "_root.OpenStateAction,OpenState"); fscommand ("fas.event.OpenStateChange", _target add ".OpenStateAction,OpenState");
	<Back>

	fas.event.PlayStateChange
	Set the action function to be triggered by the following events. and pass the relative string by statVariable: "Stop" "Pause" "Playing" "Waiting" "ScanForward" "ScanReverse" "Closed"
	Argument: ActionLabel(optional), stateVariable
	Example:
		fscommand ("fas.event.PlayStateChange", ",PlayState"); fscommand ("fas.event.PlayStateChange", "/:PlayStateAction,PlayState"); fscommand ("fas.event.PlayStateChange", _target add ".PlayStateAction,PlayState");
	<Back>

	fas.event.NewStream
	Set the action function to be triggered by the event of new AV clip loaded.
	Argument: ActionLabel
	Example:
		fscommand ("fas.event.NEWSTREAM", "_root.NewStreamAction"); fscommand ("fas.event.NEWSTREAM", _target add ".NewStreamAction");
	<Back>

	fas.event.EndOfStream
	Set the action function to be triggered by the event of AV clip playback ends.
	Argument: ActionLabel
	Example:
		fscommand ("fas.event.EndOfStream", "_root.EndOfStreamAction"); fscommand ("fas.event.EndOfStream", _target add ".EndOfStreamAction");
	<Back>

	fas.event.NewBuffering
	Set the action function to be triggered by the event of AV clip begin buffering.
	Argument: ActionLabel
	Example:
		fscommand ("fas.event.NewBuffering", "_root.EventBuffering"); fscommand ("fas.event.NewBuffering", _target add ".EventBuffering");
	<Back>

	fas.event.EndOfBuffering
	Set the action function to be triggered by the event of AV clip end buffering.
	Argument: ActionLabel
	Example:
		fscommand ("fas.event.EndOfBuffering", "_root.BufferComplete"); fscommand ("fas.event.EndOfBuffering", _target add ".BufferComplete");
	<Back>

	fas.event.VideoRectChange
	Set the action function to be triggered by the event of video rectangle changed.
	Argument: ActionLabel,width,height
	Example:
		fscommand ("fas.event.VideoRectChange", "/:VideoRectangleChange,/:ClipWidth,/:ClipHeight"); fscommand ("fas.event.VideoRectChange", "_root.VideoRectangleChange,_root.ClipWidth,_root.ClipHeight"); fscommand ("fas.event.VideoRectChange", _target add ".VideoRectangleChange," add _target add ".ClipWidth," add _target add ".ClipHeight");
	<Back>

	fas.event.ScriptCommand
	Set the action function to be triggered by the events of script commands.
	Argument: ActionLabel,type,params
	Example:
		fscommand ("fas.event.ScriptCommand", "_root.scLabel,scType,scValue"); fscommand ("fas.event.ScriptCommand", _target add ".scLabel,scType,scValue");
	<Back>

	fas.event.Disconnect
	Set the action function to be triggered by the event of disconnect from server.
	Argument: ActionLabel
	Example:
		fscommand ("fas.event.Disconnect", _target add ".EventDSC");
	<Back>

	fas.event.Warning
	Set the action function to be triggered by the event of microsoft media player warning occurance.
	Argument: ActionLabel, description
	Example:
		fscommand ("fas.event.Warning", "_root.warnLabel,warnMsg");
	<Back>

	fas.event.Error
	Set the action function to be triggered by the event of microsoft media player error occurance.
	Argument: ActionLabel, description
	Example:
		fscommand ("fas.event.Error", "_root.errorLabel,errorMsg");
	<Back>

	fas.event.MarkerHit
	Set the action function to be triggered by the event of video marker hit.
	Argument: ActionLabel,makeId
	Example:
		fscommand("fas.event.MarkerHit","_root.LabelMarkerHit,_root.MarkerID");
	<Back>

	fas.clipinfo.GetTitle
	Get title from A/V clip.
	Argument: variable string
	Example:
		fscommand ("fas.clipinfo.GETTITLE", "ClipTitle");
	<Back>

	fas.clipinfo.GetAuthor
	Get author information from A/V clip.
	Argument: variable string
	Example:
		fscommand ("fas.clipinfo.GETAUTHOR", "ClipAuthor");
	<Back>

	fas.clipinfo.GetCopyRight
	Get copyright information from A/V clip.
	Argument: variable string¡@
	Example:
		fscommand ("fas.clipinfo.GETCopyright", "ClipCopyright");
	<Back>

	fas.sound.SetVolume
	Set audio volumn level.
	Argument: volume(0 ~ 100)
	Example:
		fscommand ("fas.sound.SetVolume", vol)
	<Back>

	fas.sound.GetVolume
	Get audio volumn level.
	Argument: variable(0 ~100)
	Example:
		fscommand ("fas.sound.GetVolume", "vol");
	<Back>

	fas.sound.SetMute
	Set/unset mute.
	Argument: TRUE/FALSE
	Example:
		fscommand ("fas.sound.SetMute", "FALSE");
	<Back>

	fas.sound.GetMute
	Get the mute status.
	Argument: bool variable(TRUE/FALSE)
	Example:
		fscommand ("fas.sound.GetMute", "Mute");
	<Back>

	fas.sound.SetBalance
	Set audio balance level
	Argument: balance(-100~100)
	Example:
		fscommand ("fas.sound.SetBalance", balance)
	<Back>

	fas.sound.GetBalance
	Get audio balance level.
	Argument: int variable(-100~100)
	Example:
		fscommand ("fas.sound.GetBalance", "balance");
	<Back>

	fas.sound.GetVolume2
	Get audio volume level.
	Argument: volume(-10000~0)
	Example:
		fscommand("fas.sound.GetVolume2","vol");
	<Back>

	fas.sound.SetVolume2
	Set audio valume level.
	Argument: volume(-10000~0)
	Example:
		fscommand("fas.sound.SetVolume2",vol);
	<Back>

	fas.axobj.Rect
	Set object rectangle area.
	Argument: int left,top,right,bottom
	Example:
		fscommand ("fas.axobj.Rect", "0,0,320,240");
	<Back>

	fas.axobj.XY
	Set object display position.
	Argument: int x,y
	Example:
		fscommand ("fas.axobj.XY", "10,20");
	<Back>

	fas.axobj.OpenPdf
	Open PDF object.
	Argument: left,top,right,bottom,fileName
	Example:
		fscommand ("fas.axobj.OpenPdf", "0,0,320,240,fileName");
	<Back>

	fas.axobj.Open
	Open activeX object in Flash.
	Argument: left,top,right,bottom,objTag
	Example:
		fscommand("fas.axobj.open", "0,0,320,240,<object classid=\"clsid:22D6F312-B0F6-11D0-94AB-0080C74C7E95\"> <param name=\"Filename\" value=\"test.avi\">");
	<Back>

	fas.axobj.Close
	Close activeX object.
	Argument:
	Example:
		fscommand("fas.axobj.close","");
	<Back>

	fas.axobj.OpenCult3D
	Open cult3D object.
	Argument: left,top,right,bottom,fileName
	Example:
		fscommand("fas.axobj.OpenCult3D","1,1,300,200,%INIT_DIR%3dObj.co");
	<Back>

	fas.reg.get
	Get a data entry from registry.
	Argument: registery key, value name, variable
	Example:
		fscommand("fas.reg.get","HKEY_CLASSES_ROOT \\CLSID\\{B801CA65-A1FC-11D0-85AD-444553540000} \\LocalServer32,,_root.Acrobat");
	<Back>

	fas.reg.set
	Set the value to registry key.
	Argument: registery key, value name, value
	Example:
		fscommand("fas.reg.set","HKEY_CURRENT_USER \\Software\\MyProgram,Secret,654321");
	<Back>

	fas.shell.GetInitDir
	Get the working directory
	Argument: String variable
	Example:
		fscommand("fas.shell.GetInitDir", "/:InitDir");
	<Back>

	fas.shell.Open
	Open shell command
	Argument: filename
	Example:
		fscommand("fas.shell.open","myfile.doc"); fscommand("fas.shell.open","mailto:support@flashants.com");
	<Back>

	fas.shell.GetSWF