[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: jPlayer

Source Location: /zp-extensions/jplayer.php

Class jPlayer

Property Summary
mixed   $height  
mixed   $mode  
mixed   $playersize  
mixed   $supplied  
mixed   $supplied_counterparts  
mixed   $width  

[ Top ]
Method Summary
static void   getMacrojplayer()  
static void   headJS()  
static void   macro()  
static void   playlistJS()  
jPlayer   __construct()  
void   getCounterpartFiles()   TODO: Could not get this to work with Firefox. Low priority so postponed for sometime later...
int   getHeight()   Returns the height of the player
void   getPlayerConfig()   Get the JS configuration of jplayer
void   getPlayerHTMLparts()   gets commonly used html parts for the player config
int   getWidth()   Returns the width of the player
void   printjPlayerPlaylist()   Prints a playlist using jPlayer. Several playlists per page supported.
void   printPlayerConfig()   outputs the player configuration HTML
void   setModeAndSuppliedFormat()   Sets the properties $mode, $supplied and $supplied_counterparts

[ Top ]
Properties
mixed   $height = '' [line 202]
API Tags:
Access:  public


[ Top ]
mixed   $mode = '' [line 204]
API Tags:
Access:  public


[ Top ]
mixed   $playersize = '' [line 203]
API Tags:
Access:  public


[ Top ]
mixed   $supplied = '' [line 205]
API Tags:
Access:  public


[ Top ]
mixed   $supplied_counterparts = '' [line 206]
API Tags:
Access:  public


[ Top ]
mixed   $width = '' [line 201]
API Tags:
Access:  public


[ Top ]
Methods
static method getMacrojplayer  [line 234]

  static void getMacrojplayer( $albumname, $imagename, [ $count = 1]  )

Parameters:
   $albumname: 
   $imagename: 
   $count: 


[ Top ]
static method headJS  [line 255]

  static void headJS( )



[ Top ]
static method macro  [line 244]

  static void macro( $macros  )

Parameters:
   $macros: 


[ Top ]
static method playlistJS  [line 268]

  static void playlistJS( )



[ Top ]
Constructor __construct  [line 208]

  jPlayer __construct( )



[ Top ]
getCounterpartFiles  [line 583]

  void 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

Parameters:
string   $moviepath:  full link to the multimedia file to get counterpart formats to.
string   $ext:  the file format extention to search the counterpart for (as we already have fetched that)


[ Top ]
getHeight  [line 530]

  int getHeight( [object $image = NULL]  )

Returns the height of the player

Parameters:
object   $image:  the image for which the height is requested


[ Top ]
getPlayerConfig  [line 284]

  void getPlayerConfig( mixed $movie, [string $movietitle = NULL], [string $count = NULL], string $width, string $height  )

Get the JS configuration of jplayer

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


[ Top ]
getPlayerHTMLparts  [line 456]

  void getPlayerHTMLparts( [string $mode = ''], [string $part = '']  )

gets commonly used html parts for the player config

Parameters:
string   $mode:  'video' or 'audio'
string   $part:  part to get: 'controls', 'controls-playlist', 'toggles', 'toggles-playlist','no-solution'


[ Top ]
getWidth  [line 517]

  int getWidth( [object $image = NULL]  )

Returns the width of the player

Parameters:
object   $image:  the image for which the width is requested


[ Top ]
printjPlayerPlaylist  [line 627]

  void printjPlayerPlaylist( [string $option = "playlist"], [string $albumfolder = ""]  )

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: <?php printjPlayerPlaylist("playlist"); ?> or <?php printjPlayerPlaylist("playlist-audio"); ?>

Parameters:
string   $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.
string   $albumfolder:  album name to get a playlist from directly


[ Top ]
printPlayerConfig  [line 442]

  void printPlayerConfig( [mixed $movie = NULL], [string $movietitle = NULL], [string $count = NULL]  )

outputs the player configuration HTML

Parameters:
mixed   $movie:  the image object if empty (within albums) the current image is used
string   $movietitle:  the title of the movie. if empty the Image Title is used
string   $count:  unique text for when there are multiple player items on a page


[ Top ]
setModeAndSuppliedFormat  [line 541]

  void setModeAndSuppliedFormat( $ext  )

Sets the properties $mode, $supplied and $supplied_counterparts

Parameters:
   $ext: 


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:35 +0200 by phpDocumentor 1.4.3