ffencoderd::Profiles Class Reference

List of all members.

Public Class Methods

ffencoderd::Profiles new (hash params)

Public Object Methods

hash getProfile (scalar profile_name)
array getMountPoints ()
array getProfiles ()


Detailed Description

Get information about the different enabled profiles, gets data out from the profiles xml file. There is a schema defined as DTD in the doc folder. The DTD describes the profile element, see it for more information.

Member Function Documentation

ffencoderd::Profiles ffencoderd::Profiles::new ( hash  params  ) 

Create a new profile instance

Parameters:
hash params -profiles Path to profiles file
Returns:
A Profiles instance #

hash ffencoderd::Profiles::getProfile ( scalar  profile_name  ) 

Return a hash with the profile definition, if profiles information aren't setted tries to set it

Parameters:
String $profile_name Name of the profile to obtain definition
Returns:
hash Profile definition in a hash Returned hash has the following keys
  • in
    • name
      • arg
      • default
      • name
    • ...
  • out
    • name
      • arg
      • default
      • name
    • ...
  • mount
  • type

array ffencoderd::Profiles::getMountPoints (  ) 

Returns all mountpoints stored in MOUNTPOINTS, if $self->{MOUNTPOINTS} is not setted it calls getProfiles to set it up. The returned array contains hashes elements, these have two keys

  • name The profile name
  • ext The extension that the ffmpeg command produces as output
  • mountpoint The sufix for the path from where to access encoded resources with this profile
  • type Media type to be used in the mount point
Returns:
Array With profiles mount points, four keys "name", "ext" ,"type" and "mountpoint"

array ffencoderd::Profiles::getProfiles (  ) 

Returns an array with names of all existing profiles, it stores profiles information in $self->{PROFILES} may be retrieved with the getProfile method.

Returns:
Array List with names of profiles


The documentation for this class was generated from the following file:

Generated on Mon May 12 16:23:47 2008 for ffencoderd framework API by  doxygen 1.5.5