Package org.opencastproject.composer.api

Interface EncodingProfile

All Known Implementing Classes:
EncodingProfileImpl
public interface EncodingProfile
An encoding format encapsulates all the relevant configuration data for encoding a media file to a certain encoding formats.

  • Method Details

    • getIdentifier

      String getIdentifier()
      Returns the unique format identifier.
      Returns:
      the format identifier

    • getName

      String getName()
      Returns the encoding format's name.
      Returns:
      the format name

    • getSource

      Object getSource()
      Returns the source object that provided this encoding profile
      Returns:
      the source object that provided this profile

    • getOutputType

      EncodingProfile.MediaType getOutputType()
      Returns the encoding format's media type, which is either video (plus audio) or audio only.
      Returns:
      the format type

    • getSuffix

      String getSuffix()
      Returns a suffix of the files. First tag found used if tags are used but not provided in the request
      Returns:
      the suffix

    • getSuffix

      String getSuffix(String tag)
      Returns a suffix of the files for a certain tag.
      Parameters:
      tag - a tag that describes the aoutput file
      Returns:
      the suffix

    • getTags

      List<String> getTags()
      Returns a list of the tags for output files used in this request
      Returns:
      a list of the used tags

    • getMimeType

      String getMimeType()
      See Also:

    • setMimeType

      void setMimeType(String mimeType)
      Sets the Mimetype.
      Parameters:
      mimeType - the Mimetype

    • getApplicableMediaType

      EncodingProfile.MediaType getApplicableMediaType()
      Returns the media format that can be used with this encoding profile.
      Returns:
      the applicable input format

    • isApplicableTo

      boolean isApplicableTo(EncodingProfile.MediaType type)
      Returns true if the profile is applicable for the given track type.
      Parameters:
      type - the track type
      Returns:
      true if the profile is applicable

    • hasExtensions

      boolean hasExtensions()
      Returns true if additional properties have been specified.
      Returns:
      true if there are additional properties

    • getExtension

      String getExtension(String key)
      Returns the extension specified by key or null if no such key was defined.

      Note that key must not contain the media format prefix, so if the configured entry was mediaformat.format.xyz.test, then the key to access the value must simply be test.

      Parameters:
      key - the extension key
      Returns:
      the value or null

    • getExtensions

      Map<String,String> getExtensions()
      Returns a map containing the additional properties or an empty map if no additional properties were found.
      Returns:
      the additional properties

    • getJobLoad

      float getJobLoad()
      Returns an estimate of the load a single job with this profile causes. This should be roughly equal to the number of processor cores used at runtime.
      Returns:
      the load a single job with this profile causes