Overview

Packages

  • admin
  • classes
    • media
  • CodeIgniter
    • Libraries
  • core
  • functions
  • JSMin
  • None
  • OpenID
  • PHP
  • PHPMailer
  • plugins
    • admin
    • development
    • feed
    • mail
    • media
    • misc
    • seo
    • spam
    • uploader
    • users
    • zenpage
    • zenphoto
      • news
  • Services
    • JSON

Classes

  • AnyFile
  • AnyFile_Options
  • bxslider
  • colorbox
  • cycle
  • favoritesOptions
  • flag_thumbnail
  • image_effects
  • jcarousel
  • jPlayer
  • jplayer_options
  • slideshow
  • TextObject_Options
  • viewer_size_image_options
  • WEBdocs
  • WEBdocs_Options
  • xmpMetadata

Functions

  • get_AnyFile_suffixes
  • getFavoritesURL
  • getjPlayerSkinCSS
  • getjPlayerSkins
  • getViewerImageSize
  • printAddToFavorites
  • printFavoritesURL
  • printjPlayerPlaylist
  • printUserSizeImage
  • printUserSizeSelector
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class jPlayer

Package: plugins\media
Author: Malte Müller (acrylian)
Located at zp-extensions/jplayer.php
Methods summary
public
# __construct( )
public static
# getMacrojplayer( $albumname, $imagename, $count = 1 )
public static
# macro( $macros )
public static
# headJS( )
public static
# playlistJS( )
public
# getPlayerConfig( mixed $movie, string $movietitle = NULL, string $count = NULL, string $width,…, string $height,… )

Get the JS configuration of jplayer

Get the JS configuration of jplayer

Parameters

$movie
the image object
$movietitle
the title of the movie
$count
number (preferredly the id) of the item to append to the css for multiple players on one page
$width,…
Not supported as jPlayer is dependend on its CSS based skin to change sizes. Can only be set via plugin options.
$height,…
Not supported as jPlayer is dependend on its CSS based skin to change sizes. Can only be set via plugin options.
public
# printPlayerConfig( mixed $movie = NULL, string $movietitle = NULL, string $count = NULL )

outputs the player configuration HTML

outputs the player configuration HTML

Parameters

$movie
the image object if empty (within albums) the current image is used
$movietitle
the title of the movie. if empty the Image Title is used
$count
unique text for when there are multiple player items on a page
public
# getPlayerHTMLparts( string $mode = '', string $part = '' )

gets commonly used html parts for the player config

gets commonly used html parts for the player config

Parameters

$mode
'video' or 'audio'
$part
part to get: 'controls', 'controls-playlist', 'toggles', 'toggles-playlist','no-solution'
public integer
# getWidth( object $image = NULL )

Returns the width of the player

Returns the width of the player

Parameters

$image
the image for which the width is requested

Returns

integer
public integer
# getHeight( object $image = NULL )

Returns the height of the player

Returns the height of the player

Parameters

$image
the image for which the height is requested

Returns

integer
public
# setModeAndSuppliedFormat( $ext )

Sets the properties $mode, $supplied and $supplied_counterparts

Sets the properties $mode, $supplied and $supplied_counterparts

public
# getCounterpartFiles( string $moviepath, string $ext )

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

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

Parameters

$moviepath
full link to the multimedia file to get counterpart formats to.
$ext
the file format extention to search the counterpart for (as we already have fetched that)
public
# printjPlayerPlaylist( string $option = "playlist", string $albumfolder = "" )

Prints a playlist using jPlayer. Several playlists per page supported.

Prints a playlist using jPlayer. Several playlists per page supported.

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: or

Parameters

$option

"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
album name to get a playlist from directly
Properties summary
public string $width
# ''
public string $height
# ''
public string $playersize
# ''
public string $mode
# ''
public string $supplied
# ''
public string $supplied_counterparts
# ''
Zenphoto doc API documentation generated by ApiGen