video.Maru
by polyGeek polyGeek logo

Documentation Index

back# ( movieclip ) ( details page )
A user control that when pressed will seek backward in a video by the number of seconds indicated at the end of the instance name.

buffer# ( movieclip ) ( details page )
The instance name of the MovieClip that tells video.Maru how many seconds of video to buffer before playback begins. The default is 0.1 seconds. The instance name should be buffer followed by the number of seconds.

captions ( textfield) ( details page )
The instance name of the TextField that will display the video captions. Put the path to the XML file that describes the captions in the TextField. If you are using XML integration then check the XML documentation for details on how to specify which XML captions file to load for each video node.

description ( textfield - xml) ( details page )
Used in conjunction with XML to display a text description of the video

downloadPercent ( textfield ) ( details page )
Displays the percent of the video that has been downloaded.

downloadProgress ( movieclip ) ( details page )
Snaps to the timeLine and grows from left-to-right as the video is downloaded. It’s a good idea to use a shape instead of a line for this to avoid distortion as the MovieClip changes width.

fadeTray# ( movieclip ) ( details page )
A MovieClip that will fade out when the user stops moving the mouse. You specify the amount of time to wait by placing a number - seconds - at the end of the instance name. To change the time it takes to fade in-out use the video.Maru API.

fullscreen_btn ( movieclip ) ( details page )
When the user presses and releases this it will cause the SWF to toggle between fullScreen and in-browser views.

link ( textfield ) ( details page )
The TextField inside the linkBTN that will receive the text value from the linkText attribute in the XML.

linkBTN ( movieclip - exported for Actionscript) ( details page )
A MovieClip that is exported for Actionscript and will become part of the navigation when using XML. This MovieClip does not need to be on the stage at authoring time.

linkBTNholder ( movieclip ) ( details page )
Used in conjunction with the linkBTNs to place them visually on the stage at authoring time.

linkIcon ( movieclip ) ( details page )
A MovieClip inside the linkBTN that will be replaced with an external graphic as indicated by the iconSrc attribute in the XML.

loop ( movieclip ) ( details page )
Causes the video to loop.

metaData ( textfield) ( details page )
A TextField that, if it exists, will display all of the metaData in the FLV that is currently playing. It is meant to be used at authoring time to help find the width/height of the FLV and other attributes.

metaDuration ( textfield) ( details page )
Displays the length - hours : minutes : seconds - of the current FLV as reported in the metaData.

muteSound ( movieclip )
See soundOn/soundOff below.

next (movieclip - exported for Acitonscript) ( details page - videoLink ) ( details page - linkBTN/XML )
Cycles to the next highest index of videoLink# or linkBTN if using XML. If used as XML you must export this MovieClip for Actionscript.

pauseOnLastFrame ( movieclip ) ( details page )
Causes the video to pause on the last frame of the video, unless it is looping or moving on to the next video.

pause_btn ( movieclip ) ( details page )
User control for toggling the playback of the video. If the instance name pause_btn is used then the video will be paused on startup.

play_btn ( movieclip ) ( details page )
User control for toggling the playback of the video. If the instance name play_btn is used then the video will start playing automatically on startup.

playhead ( movieclip ) ( details page )
User control to indicate current position of the video playback and to allow for scrubbing back and forth through the video.

prev ( movieclip ) ( details page - videoLink ) ( details page - linkBTN/XML ) *
Cycles to the next lowest index of videoLink# or linkBTN if using XML. If used as XML you must export this MovieClip for Actionscript.

reflection ( movieclip ) ( details page )
If used it will create a reflection of the videoWindow. If the shape inside the MovieClip has a gradated alpha fade then it will also fade out the reflection.

smoothingon ( movieclip ) ( details page )
If it exists then it will turn smoothing on for the videoWindow. This is especially useful if you are displaying the video at non-native dimensions, such as fullscreen.

soundon/soundoff ( movieclip ) ( details page )
The mute button. The instance name determines the state of the audio at startup.

startplay ( movieclip ) ( details page ) ( update )
User control that is meant to be placed on top of the videoWindow. When the user clicks on it, it will be removed from the stage and video playback will begin. This MovieClip overrides the play_btn to keep the video paused at startup.

stop_btn ( movieclip ) ( details page )
Returns the to the beginning of the video and pauses the video playback.

timeCombo ( textfield) ( details page )
Displays the time played and time remaining in the video in hours : minutes : seconds.

timeline ( movieclip ) ( details page )*
The area over which the playhead can move and downloadProgress can grow.

timePlayed ( textfield) ( details page )
Displays the time played in hours : minutes : seconds.

timeRemaining ( textfield) ( details page )
Displays the time remaining in the video in hours : minutes : seconds.

verbose ( movieclip ) ( details page )
Used during authoring time to display trace statements in the Output window. It has no affect on the SWF when it is published.

videoLinks# (movieclip - xml ) ( details page )
MovieClips that when the user presses and releases will play the indicated FLV - as determined by the text in a TextField located inside the MovieClip, just like the videoWindow. Note: if the user clicks on a videoLink that is the currently playing FLV then nothing will happen.

videoMask ( movieclip ) ( details page )
A MovieClip that you can place over the videoWindow to use as a mask. The shape of the mask will act as the window through which you will see the video.

videoTitle ( textfield - xml ) ( details page )
Used with XML to display the indicated title of the video.

videoWindow ( movieclip ) ( details page )
The MovieClip that is replaced at runtime to display the video playback.

volumeRange ( movieclip ) ( details page )
The range over which the volumSlider can be dragged.

volumeSlider ( movieclip ) ( details page )
User control that allows the user to change the volume level. The position of the volumeSlider at authoring time affects the volume at startup. If the volumeSlider is placed at the far left of the volumeRange, or bottom depending on orientation, then volume at startup will be zero. If placed in the middle the volume at startup will be 50%, and so forth.

Share and Enjoy: These icons link to social bookmarking sites where readers can share and discover new web pages.
  • Digg
  • Technorati
  • del.icio.us
  • Facebook
  • Google
  • StumbleUpon