Help is on the way!

Browse our Documentation, Search the Knowledge Base, Still need help? Send us a support ticket.

JoomlaXTC VTube V1.0 Documentation


Vtube is the most powerful and customizable videoplayer for Joomla. It plays any kind of video file that Flash Player supports ( FLV / H.264 encoded video including MP4, M4V, M4A, MOV, Mp4v, F4V), YouTube and Stream Videos. The code is very clean and it's easy to customize the player's design via the modules admin panel. The playlist is generated via the JOOMLA XTC XPS playlist or via your own custom XML.

Features:


  • H.264 video

    Supports MPEG-4 standard container files that contain video and audio H.264 / AAC encoded including MP4, M4V, M4A, MOV, Mp4v, F4V, FLV.


  • Playlist

    You can insert in the XPS or XML file an unlimited number of videos.


  • AutoResize

    You don't need to worry to reposition the controls, all that you need to do is to set the admin controls and the module will reposition automatically.


  • FullScreen

    FullScreen button; you can show/hide FullScreen button from the admin.


  • AutoHide controls bar

    You can set the player to autohide the controls bar after a number of seconds of inactivity.


  • AutoHide mouse cursor

    You can set the player to autohide the mouse cursor after a number of seconds of inactivity.


  • Preview Image

    You can set an image for video that will be displayed when the video is stopped and if showPreviewImage = "true"


  • Big play button in the middle of the video

    If you want to display a big play button in the middle on the video, when the video is paussed or stopped, you need to set showMiddlePlayButton = "true"


  • Share

    Link to this video - you can provide a link to the page where you put the video player; Embed this video - it will generate code lines that visitors can use to embed the player on other sites - THIS OPTION IS ONLY AVAILABLE WHEN USING THE XML FILE AS PLAYLIST; Send To A Friend (STAF) - the visitors may send an email to a provided email address; the email can be html and you can edit the template used for this email


  • Watermark

    Sometimes, when you play a video from another site, it's a good idea to display a watermark.


  • Space key listener

    You can use Space key to play/pause the video.


  • Click listener

    You can click on the video to play/pause the video.


  • Double Click listener

    You can click on the video to go in FullScreen mode or come back to Normal mode.

Uploading the package element:

VTube is a Joomla 1.5 module and is installed like all Joomla Modules via the Extensions Install area of your Joomla Administrator.

Configuring the Module:

  1. autoResize - if this option is set to true then the player will be displayed on the whole stage
    playerWidth and playerHeight - use these options if you want not to use the whole stage (these options will be ignored if autoResize=true)



    autoLoad - if this option is set to true then the player will start loading the video at startup
    autoPlay - if this option is set to true then the player will start playing the video at startup (it will ignore autoLoad option)
    playContinuously - if this option is set to true then after a video finished to play the player will play the next video
    loop - if this option is set to true then the player will replay the video
    random - if this option is set to true then the player will play the videos randomly



    bufferTime - the buffer size, in seconds
    keepAspectRatio - if this option is set to false then the video will be shown on the entire player area



    volume - the default volume
    controlsPadding - the space between the buttons from the Controll Bar



    buttonSound - if this option is set to true then a sound will play when the mouse's cursor is over a buttons



    showPreviewImage - if this option is set to true then the player will display a preview image when the video is stopped
    showShareBtn - if this option is set to true then a share button will be displayed on Controll Bar
    showFullScreenBtn - if this option is set to true then a change window state button will be displayed on Controll Bar
    showMiddlePlayBtn - if this option is set to true then Middle Play Button will be displayed when the video is stopped or paused



    showWatermark - if this option is set to true then a Watermark image will be displayed over the video
    watermarkPos - the value can be TL, TR, BL, BR (T-top, B-bottom, R-Right, L-Left)



    spaceKeyListener - if this option is set to true then when the space key is pressed the video will toggle play-pause events
    clickListener - if this option is set to true then when the background area is clicked the video will toggle play-pause events
    doubleClickListener - if this option is set to true then when the background area is double clicked the player goes in FullScreen mode or in Normal mode



    cBarAutoHide - if this option is set to true then the controls bar will be hidden after a number of seconds
    cBarHideDelay - the number of seconds of inactivity after the controls bar will be hidden



    mouseCursorAutoHide - if this option is set to true then the mouse cursor will be hidden after a number of seconds
    mouseCursorHideDelay - the number of seconds of inactivity after the mouse cursor will be hidden



    playlistPos - the position of playlist; the value can be: B, T, L, R (Bottom, Top, Left, Right)
    playlistSize - the size of playlist; if playlistPos is B or T then the size will be the height of the playlist, else the size will be the width of the playlist
    playlistAutohide - if this option is set to true then the playlist will start hidding after playlistHideDelay seconds
    playlistHideType - the type of hide effect; the value can be fade or slide
    playlistHideDelay - after how much time of mouse inactivity to hide the playlist
    playlistThumbWidth - the thumbs width
    playlistThumbHeight - the thumbs height
    playlistThumbPadding - the space between thumbs


  2. Colors


    playerBackground - the video's background color
    preloader:

    • background - the background's color

    • bckAlpha - the background's alpha

    • text - the percentage's color

    • circle - the rotating circle's color

    middlePlayBtn:

    • arrowNormal - the arrow's color for the normal state

    • bckNormal - the background's color for thenormal state

    • alphaNormal - the alpha value for the normal state

    • arrowOver - the arrow's color for the over state

    • bckOver - the background's color for the over state

    • alphaOver - the alpha value for the over state

    • arrowDown - the arrow's color for the press state

    • bckDown - the background's color for the over state

    • alphaDown - the alpha value for the press state

    controllerBackground - the Controll bar's background color


    controllerButtons:

    • normal - the buttons color for the normal state

    • over - the buttons color for the over state

    • down - the buttons color for the press state

    volume:

    • border - the volume's bar border color

    • background - the volume's bar background color

    • speaker - the speaker's button color

    • bar - the volume's bar color

    volumeScrubBtn:

    • brdNormal - the scrub volume button's border color for the normal state

    • bckNormal - the scrub volume button's background color for the normal state

    • brdOver - the scrub volume button's border color for the over state

    • bckOver - the scrub volume button's background color for the over state

    • brdDown - the scrub volume button's border color for the press state

    • bckDown - the scrub volume button's background color for the press state

    progressBar:

    • border - the progress bar's border color

    • background - the progress bar's background color

    • elapse - the elapsed time bar's color

    • download - the downloaded time bar's color

    progressScrubBtn:

    • brdNormal - the scrub video button's border color for the normal state

    • bckNormal - the scrub video button's background color for the normal state

    • brdOver - the scrub video button's border color for the over state

    • bckOver - the scrub video button's background color for the over state

    • brdDown - the scrub video button's border color for the press state

    • bckDown - the scrub video button's background color for the press state

    times - the color for Elapsed Time and Total time (visible on Controll bar)


    share:

    • background - the overlay's color

    • bckAlpha - the overlay's alpha

    • boxBck - the texts and buttons box background color

    • boxBckAlpha - the texts and buttons box alpha

    • labels - the labels ("Link to this video", "Embed this video" and "Send to a friend") text's color

    • errorText - the error or confirmation text's color

    • text - the input text's color

    • textBck - the input text's background color

    • textBrd - the input text's border color

    • btnsNormal - the buttons color for the normal state

    • btnsOver - the buttons color for the over state

    • btnsDown - the buttons color for the press state

    playlist:

    • background - the playlist background's color

    • bckAlpha - the playlost background's alpha

    • thumbBck - the thumb's background color

    • thumbNormalAlpha - the thumb's alpha for normal state

    • thumbOverAlpha - the thumb's alpha for over state

    • thumbSelectedAlpha - the thumb's alpha for select state


  3. XPS Playlist (Put Each Element on a new line in the

    XPS Playlist window and use a blank line for next

    video)

    videoPath - the video file's path goes here
    previewImage - the preview image file's path goes here
    thumbImage - the thumb image file's path goes here
    stafImage - the image file's path that will be used for send to a friend goes here
    aspectRatio - you need to set this if metaData is not available and if you want to keep aspect ratio
    totalTime - you need to set this if metaData is not available
    watermarkPath - the watermark image file's path goes here
    watermarkLink - the link that will be oppened when watermark image is clicked


    Staf

    subject - the email subject displayed in the email that will be send using Share With A Friend feature
    message - the email message displayed in the email that will be send using Share With A Friend feature; [videoPage] will be replaced, automatically, with the html page where the player is and [imgPath] will be replaced, automatically, with the thumbnail for the current video

Didn't find an Answer?

If you didn't find the answer you were looking for from the links above.




SUBMIT SUPPORT TICKET

Didn't find an Answer?

If you didn't find the answer you were looking for from the links above.




SUBMIT SUPPORT TICKET