jPlayer
in package
Table of Contents
- $height : mixed
- $mode : mixed
- $playersize : mixed
- $supplied : mixed
- $supplied_counterparts : mixed
- $width : mixed
- __construct() : mixed
- getCounterpartFiles() : mixed
- TODO: Could not get this to work with Firefox. Low priority so postponed for sometime later... Gets the mp3, m4v,m4a,mp4 counterpart formats (webm,ogg) for html5 browser compatibilty NOTE: THese formats need to be uploaded via FTP as they are not valid file types for Zenphoto to avoid confusion
- getHeight() : int
- Returns the height of the player
- getMacrojplayer() : mixed
- getPlayerConfig() : mixed
- Get the JS configuration of jplayer
- getPlayerHTMLparts() : mixed
- gets commonly used html parts for the player config
- getWidth() : int
- Returns the width of the player
- headJS() : mixed
- macro() : mixed
- playlistJS() : mixed
- printjPlayerPlaylist() : mixed
- Prints a playlist using jPlayer. Several playlists per page supported.
- printPlayerConfig() : mixed
- outputs the player configuration HTML
- setModeAndSuppliedFormat() : mixed
- Sets the properties $mode, $supplied and $supplied_counterparts
Properties
$height
public
mixed
$height
= ''
$mode
public
mixed
$mode
= ''
$playersize
public
mixed
$playersize
= ''
$supplied
public
mixed
$supplied
= ''
$supplied_counterparts
public
mixed
$supplied_counterparts
= ''
$width
public
mixed
$width
= ''
Methods
__construct()
public
__construct() : mixed
Return values
mixed —getCounterpartFiles()
TODO: Could not get this to work with Firefox. Low priority so postponed for sometime later... Gets the mp3, m4v,m4a,mp4 counterpart formats (webm,ogg) for html5 browser compatibilty NOTE: THese formats need to be uploaded via FTP as they are not valid file types for Zenphoto to avoid confusion
public
getCounterpartFiles(string $moviepath, string $ext) : mixed
Parameters
- $moviepath : string
-
full link to the multimedia file to get counterpart formats to.
- $ext : string
-
the file format extention to search the counterpart for (as we already have fetched that)
Return values
mixed —getHeight()
Returns the height of the player
public
getHeight([object $image = NULL ]) : int
Parameters
- $image : object = NULL
-
the image for which the height is requested
Return values
int —getMacrojplayer()
public
static getMacrojplayer(mixed $albumname, mixed $imagename[, mixed $count = 1 ]) : mixed
Parameters
- $albumname : mixed
- $imagename : mixed
- $count : mixed = 1
Return values
mixed —getPlayerConfig()
Get the JS configuration of jplayer
public
getPlayerConfig(mixed $movie[, string $movietitle = NULL ][, string $count = NULL ]) : mixed
Parameters
- $movie : mixed
-
the image object
- $movietitle : string = NULL
-
the title of the movie
- $count : string = NULL
-
number (preferredly the id) of the item to append to the css for multiple players on one page
Return values
mixed —getPlayerHTMLparts()
gets commonly used html parts for the player config
public
getPlayerHTMLparts([string $mode = '' ][, string $part = '' ]) : mixed
Parameters
- $mode : string = ''
-
'video' or 'audio'
- $part : string = ''
-
part to get: 'controls', 'controls-playlist', 'toggles', 'toggles-playlist','no-solution'
Return values
mixed —getWidth()
Returns the width of the player
public
getWidth([object $image = NULL ]) : int
Parameters
- $image : object = NULL
-
the image for which the width is requested
Return values
int —headJS()
public
static headJS() : mixed
Return values
mixed —macro()
public
static macro(mixed $macros) : mixed
Parameters
- $macros : mixed
Return values
mixed —playlistJS()
public
static playlistJS() : mixed
Return values
mixed —printjPlayerPlaylist()
Prints a playlist using jPlayer. Several playlists per page supported.
public
printjPlayerPlaylist([string $option = "playlist" ][, string $albumfolder = "" ]) : mixed
The playlist is meant to replace the 'next_image()' loop on a theme's album.php. It can be used with a special 'album theme' that can be assigned to media albums with with .flv/.mp4/.mp3s, although Flowplayer 3 also supports images Replace the entire 'next_image()' loop on album.php with this:
orParameters
- $option : string = "playlist"
-
"playlist" use for pure video and mixed video/audio playlists or if you want to show the poster/videothumb with audio only playlists, "playlist-audio" use for pure audio playlists (m4a,mp3,fla supported only) if you don't need the poster/videothumb to be shown only.
- $albumfolder : string = ""
-
album name to get a playlist from directly
Return values
mixed —printPlayerConfig()
outputs the player configuration HTML
public
printPlayerConfig([mixed $movie = NULL ][, string $movietitle = NULL ][, string $count = NULL ]) : mixed
Parameters
- $movie : mixed = NULL
-
the image object if empty (within albums) the current image is used
- $movietitle : string = NULL
-
the title of the movie. if empty the Image Title is used
- $count : string = NULL
-
unique text for when there are multiple player items on a page
Return values
mixed —setModeAndSuppliedFormat()
Sets the properties $mode, $supplied and $supplied_counterparts
public
setModeAndSuppliedFormat(mixed $ext) : mixed
Parameters
- $ext : mixed