Contents
		The FeMedia Object
		Methods Properties Equates
		The Templates
		Overview
		Useful References
		Summary of callback events

File Explorer Classes - FeMedia

Formerly known as the Media file type / object, the FeMedia Object is used to display video files, and play sound files.

FeMedia - Methods

Quick Reference

EventCallback

GetInfo

HideControl

Init

Kill

Load

Navigate

Pause

Play

Reload

Stop

UnhideControl

Update




EventCallback     ( long EventID, string Parm1, string Parm2, string Parm3, string Parm4 ) ( To do ) Handles events fired by the MediaPlayer object.  Each time the MediaPlayer object (ocx) fires an event, this virtual method is called, so you can embed code in this virtual method to deal with those events. TIP: See the FeMedia_VideoCallbacks or FeMedia_SoundCallbacks procedures in the feabc.app example application to see this method being used. EventID can be one of the following equates (better documentation will follow in subsequent releases) fe:MedEvt_DVDNotify fe:MedEvt_EndOfStream fe:MedEvt_KeyDown fe:MedEvt_KeyUp fe:MedEvt_KeyPress fe:MedEvt_MouseMove fe:MedEvt_MouseDown fe:MedEvt_MouseUp fe:MedEvt_Click fe:MedEvt_DblClick fe:MedEvt_OpenStateChange fe:MedEvt_PlayStateChange fe:MedEvt_ScriptCommand fe:MedEvt_Buffering fe:MedEvt_Error fe:MedEvt_MarkerHit fe:MedEvt_Warning fe:MedEvt_NewStream fe:MedEvt_Disconnect fe:MedEvt_PositionChange fe:MedEvt_DisplayModeChange fe:MedEvt_ReadyStateChange

GetInfo     ( <string pPropertyName> ) ThisViewer1.GetInfo() ThisViewer1.GetInfo('MedDuration') This method sort of has the "opposite effect" to the Update method, in that it "updates" certain properties according to their current state at the moment in time when you call the GetInfo method.  If you pass a property name in the optional pPropertyName parameter (see example above), then only that property will be updated.  If you do not pass a property name, then all properties will be updated. MedDuration MedFileName MedMoreInfo MedRepeatTimes MedAllowZoomChange MedZoom MedVolume MedMute MedSoundCard MedCurrentPosition MedStartPosition MedEndPosition MedShowPositionControls MedShowInfoWindow MedShowToolbar MedEnableToolbar MedShowSlideBar MedEnableSlideBar MedShowGotoBar MedPlayRate MedAutoStart MedAutoRewind MedInfo_FileName MedInfo_Title MedInfo_Author MedInfo_Copyright MedInfo_Rating MedInfo_Description MedAutoResize MedRightClick

HideControl     ( ) ThisViewer.HideControl () Hides the File Explorer viewer control.  Note: ?feControl{prop:hide} = true will not work.

Init     ( long ParentControl, <string LoadPath>, long Handle1=0, long Handle2=0, byte SkipCallbacks=false ) ,byte,proc ThisViewer.Init (?feControl) ThisViewer.Init (?feControl, 'www.CapeSoft.com',,,true) Handles initialization for the object, must be called before you call any other methods. The ParentControl parameter is your File Explorer window control. Four of the five parameters are optional. The LoadPath parameter will load a document into the object once initialization is complete The Handle1 and Handle2 parameters should not be passed. The SkipCallbacks parameter determines whether the object will be initialized with callback function support. This method returns a byte indicating success (1) or failure (0). NOTE:  You can choose the version of Media Player to load in order to load newer version. Set the feMedia.MPVersionNumber property before the call to the Init method: feMedia.MPVersionNumber = 6   ! Loads the older Media Player 6/7 feMedia.MPVersionNumber = 10 ! Loads the new Media Player 9 and greater.

Kill     ( ) ThisViewer.Kill() Handles the "closing down" of an object.  Must be called (typically) as the window which hosts the object is closed.

Load     ( string CurrentPath, <long CurrentControl> ) ,byte,proc ThisViewer.Load ('c:\test.avi') Loads a document ( passed as the CurrentPath parameter ) into the Media Viewer control. If the CurrentControl parameter is omitted, the control which you passed in the Init method is used. Returns a byte indicating success (1) or failure (0).

Navigate     ( byte Location, <short PageNumber>, <string Optionals> ) ThisViewer1.Navigate (1)   ! Goto first page ThisViewer1.Navigate (5, 3)  ! Goto page 3 ThisViewer1.Navigate (3, 0, 50) Use this method to navigate within a loaded file.  The Location parameter can be one of the following: 1  - Goto the beginning of the loaded file 2  - Goto the previous page, or back one "step" or "frame" 3  - Goto the next page, or forward one "step" or "frame" 4  - Goto the end of the loaded file 5  - Goto a specific "PageNumber"  ( if you use this parameter, pass the page number as the second [optional] parameter - as shown below in example 2 ) NOTE: If you are using location 2 or 3 for a Media Player object, the Navigate method will in effect take you to the previous or next frame of the loaded movie.  In reality you actually jump forward or backward by a preset number of milliseconds, giving the impression that you are jumping frames.  The default number of milliseconds is 100 (i.e. a tenth of a second).  If you would rather use another time frame, you can pass the number of milliseconds as the Optionals third parameter.  Example 3 shows how to jump forward to the next "frame", where the next frame is 50 milliseconds after the current frame, not the 100 millisecond default:

Pause     ( ) ,byte,proc ThisViewer.Pause() Pauses the loaded file. Returns a byte indicating success (1) or failure (0).

Play     ( ) ,byte,proc ThisViewer.Play() Plays the loaded file. Returns a byte indicating success (1) or failure (0).

Reload     ( <long CurrentControl> ) ThisViewer.Reload() This method reloads the last document which you loaded into the object.  If you omit the CurrentControl parameter, the same control which you used in the Init method is used.

Stop     ( ) ,byte,proc ThisViewer.Stop() Stops the loaded file. Returns a byte indicating success (1) or failure (0).

UnhideControl     ( ) ThisViewer.UnhideControl () Unhides the File Explorer viewer control.  Note: ?feControl{prop:hide} = false will not work.

Update     ( string Property, string PropValue ) ,byte,proc ThisViewer.Update() Stops the loaded file. Returns a byte indicating success (1) or failure (0). Use this method to update various "properties" / "values" for the object.  Some times these "values" are actual properties of the File Explorer class, sometimes not.  The reason you use this method and don't just change the properties "directly" is because using this method results in the changes being implemented "immediately", and not for instance only coming into effect the next time you load a document into the object which is often the "default" behavior. The Property parameter can be one of the following: MedRepeatTimes MedAllowZoomChange MedZoom MedVolume MedMute MedCurrentPosition MedStartPosition MedEndPosition MedShowPositionControls MedShowInfoWindow MedShowToolbar MedEnableToolbar MedShowSlideBar MedEnableSlideBar MedShowGotoBar MedPlayRate MedAutoStart MedAutoRewind MedAutoResize MedRightClick

FeMedia - Properties (alphabetical)

MedAllowZoomChange (Byte)	If the user right-clicks on a media file while it is playing, he is presented with a number of options which he can set (run-time).  One of these options is the current "zoom" setting.  This property (MedAllowZoomChange) sets whether the user can change the zoom setting from that popup window at run-time.  A value of '1' enables setting the zoom property, and a value of '2' disables it (for reasons I won't go into).  If you do not set any value it defaults to enabled.  See the GetInfo and Update methods.
MedAutoResize (Byte)	If you set this to true (1), then the Media Viewer object will resize itself each time you load a file, so that the object (ocx) is only large enough to "fit" the file.  The top-left corner remains constant.  By default this is set to 0.  You can either set this property "directly" before you call the Load method, or once the file has loaded using the Update method.  Also works with the GetInfo method.
MedAutoRewind (Byte)	Set this to True (1) to automatically rewind Media files once they have finished playing.  Set it "directly" before calling the Load method, or set it once a file is open using the Update method.  Also works with the GetInfo method.
MedAutoStart (Byte)	Set this to True (1) to automatically start playing media files once you load them.  Set it "directly" before calling the Load method, or set it once a file is open using the Update method.  Also works with the GetInfo method.
MedCurrentPosition (Long)	Holds the current "position" within the playing file.  For a 15 second clip this starts with 0.0 and ends on 15.0.  Use the GetInfo and Update methods.
MedDuration (String)	Holds the expected duration (in seconds to 1 decimal place).  Note, if you are playing the file at anything other than a PlayRate of 100%, the MedDuration property will need to be adjusted in your calculations, as it returns the duration assuming the PlayRate will be 100%.  See the GetInfo method.
MedEnableSlideBar (Byte)	Sets whether the SlideBar is enabled or disabled for the control.  Use the Update or GetInfo methods.  Valid values are true (1) or false (0).
MedEnableToolbar (Byte)	Sets whether the Toolbar is enabled or disabled for the control.  Use the Update or GetInfo methods.  Valid values are true (1) or false (0).
MedEndPosition (Long)	The default end position for a clip of 15 seconds would be 15.0 (i.e. the end of the track).  You can set this to a lesser value if you want to end before then.  Use the GetInfo or Update methods.
MedFileName (String)	Use the GetInfo or Update methods.  It returns something like "c:\files\file1.avi", being the name of the file currently loaded.
MedInfo_Author (String)	This property holds the name of the author for the loaded file, if available.  Use the GetInfo method.
MedInfo_Copyright (String)	This property holds copyright info for the loaded file, if available.  Use the GetInfo method.
MedInfo_Description (String)	This property holds a description of the loaded media file, if available.  Use the GetInfo method.
MedInfo_FileName (String)	This property holds the current filename (including path) of the loaded file.  Use the GetInfo method.
MedInfo_Rating (String)	This property holds rating information for the loaded file, if available.  Use the GetInfo method.
MedInfo_Title (String)	This property holds the title of the loaded media file, if available.  Use the GetInfo method.
MedMute (Byte)	A value of 1 mutes the sound, 0 "un-mutes" it.  If unset, defaults to 0.  Use the GetInfo or Update methods.
MedPlayRate (Long)	Set the playback rate for media files.  100 is normal speed (i.e. 100%), 50 is 50%, and so on.  Set it "directly" (ThisViewer1.MedPlayRate = 50) before calling the Load method, or after loading a file using the Update method.  Also works with the GetInfo method.
MedRepeatTimes (Byte)	Holds the number of times a file will be played / looped before stopping.  A value of 0 or 1 indicates the file will play through once and then stop.  Use the GetInfo or Update methods.
MedRightClick (Byte)	By default, if the user right-clicks on the Viewer control a popup menu appears.  Setting this property to false (0) disables that popup window from appearing.  Use the Update or GetInfo methods. Example: ThisViewer1.Load ('c:\mydoc.avi') ThisViewer1.Update('MedRightClick', false)
MedShowGotoBar (Byte)	Determines whether the 'Goto Bar' drop list is hidden or not.  Use the Update or GetInfo methods - valid values are true (1) or false (0).
MedShowInfoWindow (Byte)	Determines whether the 'Clip', 'Author', and 'Copyright' information is hidden or not.  Use the Update or GetInfo methods - valid values are true (1) or false (0).
MedShowPositionControls (Byte)	Determines whether the 'Skip Back', 'Rewind', 'Fast Forward', 'Skip Forward', and 'Preview each clip in Playlist' buttons are hidden or not.  Use the Update or GetInfo methods - valid values are true (1) or false (0).
MedShowSlideBar (Byte)	Determines whether the 'Slide Bar' ('Tracker Bar') is hidden or not.  This is the bar which you can use to 'move around' in the clip by dragging the locator on the bar.  Use the Update or GetInfo methods - valid values are true (1) or false (0).
MedShowToolbar (Byte)	Set to True (1) to display the native Media toolbar, or False (0) to hide it.  Either set this "directly" before calling the Load method, or after a file has loaded using the Update method.  Also works with the GetInfo method.
MedSoundCard (Byte)	Use the GetInfo method.  A value of 1 means that a soundcard is present on the PC.
MedStartPosition (Long)	The default start position for a clip is at 0.0 (i.e. the beginning of the track).  You can set this to any value though, to start playing the clip at a point other than at the beginning.  Use the Update or GetInfo methods.
MedVolume (Long)	This property holds the current playback volume.  This can be any value from -1 (max volume) to -9640 (min volume).  If unset this defaults to -600.  Use the Update or GetInfo methods.
MedZoom (Byte)	This property determines the visual "size" of the movie clip which you load.  It can hold one of 8 possible values, as outlined below: 100 - 100%, or the default size 50 - 50%, or half the default size 200 - 200%, or double the default size 1 - Full screen 2 - Fit to size 3 - 1/16th of the screen size 4 - 1/4 of the screen size 5 - 1/2 of the screen size If unset, this property defaults to 100.  Use the Update or GetInfo methods.  Note that some settings only work with certain file formats, such as Full Screen works with Mpeg, but not AVI. Example: ThisViewer1.Load ( 'c:\MyFile.mpg' )       ! Load the clip ThisViewer1.Wait(2)      ! Gives the ocx time to finish loading ThisViewer1.Update('MedZoom', 1)     ! Shows video at full screen ThisViewer1.Play()     ! Start playing the clip

Class Properties
	feMedia.MPVersionNumber	The version of Windows Media Player to load

MPVersionNumber long
The version of Windows Media Player to Load. You need to set this before the call to the Init method.

Information

There are currently two allowed values for MPVersionNumber. Setting this to 6 will use the old Windows Media Player 6/7 control. Setting this to 10 will use the new Windows Media player 9 and newer control. Please note that using the new control is currently a Beta feature, in testing it works very well, however there is a known issue with multiple controls on a single window causing a GPF when the window is closed. You may have both old and new controls in your application, and you can even have old and new controls on the same window/thread.

Example

	! Use the old version of Windows Media Player
	ThisViewer1.MPVersionNumber = 6
	ThisViewer1.Init (?feControl, , , , 1)

	! Use the new version of Windows Media Player
	ThisViewer3.MPVersionNumber = 10
	ThisViewer3.Init (?feControl, , , , 1)

Information

The same techinique is used regardless of whether the Init method call is being done manually or populated by the template.

FeMedia - Templates

At this time there is quite an overlap in terms of multiple File Explorer classes being implemented by the same templates.  In the future we may revisit this, but for now all templates are covered in the main (FileExplorer.htm) help document, please click here.

Summary of callback events

See the FeMedia_SoundCallbacks and FeMedia_VideoCallbacks procedures in the feabc.app example application for more info.

Event Name:	Equate:	Description:
Buffering	fe:MedEvt_Buffering	Occurs when the control begins or ends buffering.
Click	fe:MedEvt_Click	Occurs when a user clicks the mouse with the cursor in the image window.
DblClick	fe:MedEvt_DblClick	Occurs when a user double clicks the mouse with the cursor in the image window.
Disconnect	fe:MedEvt_Disconnect	Occurs when the control is disconnected from the server.
DisplayModeChange	fe:MedEvt_DisplayModeChange	Occurs when the DisplayMode property changes.
DVDNotify	fe:MedEvt_DVDNotify	( none )
EndOfStream	fe:MedEvt_EndOfStream	Occurs when the end of the title is reached.
Error	fe:MedEvt_Error	Occurs when the control has an error condition.
KeyDown	fe:MedEvt_KeyDown	Occurs when a key is pressed.
KeyPress	fe:MedEvt_KeyPress	Occurs when a key is pressed and released.
KeyUp	fe:MedEvt_KeyUp	Occurs when a key is released.
MarkerHit	fe:MedEvt_MarkerHit	Occurs when a marker is reached.
MouseDown	fe:MedEvt_MouseDown	Occurs when a mouse button is pressed.
MouseMove	fe:MedEvt_MouseMove	Occurs when the mouse pointer is moved.
MouseUp	fe:MedEvt_MouseUp	Occurs when a mouse button is released.
NewStream	fe:MedEvt_NewStream	Occurs when a new stream is started in a station.
OpenStateChange	fe:MedEvt_OpenStateChange	Occurs when the control changes its open state.
PlayStateChange	fe:MedEvt_PlayStateChange	Occurs when the control changes its play state.
PositionChange	fe:MedEvt_PositionChange	Occurs when the current media position moves to a new position.
ReadyStateChange	fe:MedEvt_ReadyStateChange	Occurs when the control's state of readiness changes.
ScriptCommand	fe:MedEvt_ScriptCommand	Occurs when a synchronized command or URL is received.
Warning	fe:MedEvt_Warning	Occurs when the control encounters a possible problem.

More Info:    ( work in progress )

OpenStateChange   ( OldState, NewState )
  OldState indicates the previous OpenState value.
  NewState indicates the new (current) OpenState value.
  Possible OpenState values are:
    0 - Content file is closed
    1 - Loading an .asx redirector 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

PlayStateChange   ( OldState, NewState )
  OldState indicates the previous PlayState value.
  NewState indicates the new (current) PlayState value.
  Possible PlayState values are:
    0 - Playback is stopped
    1 - Playback is paused
    2 - Stream is playing
    3 - Waiting for stream to begin
    4 - Stream is scanning forward
    5 - Stream is scanning in reverse
    6 - Skipping to next
    7 - Skipping to previous
    8 - Stream is not open