Package org.opencastproject.inspection.api

Interface MediaInspectionService

public interface MediaInspectionService
Anayzes media to determine its technical metadata.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_TYPE
    The namespace distinguishing media inspection jobs from other types

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opencastproject.job.api.Job
    enrich(org.opencastproject.mediapackage.MediaPackageElement original, boolean override)
    Equip an existing media package element with automatically generated metadata
    org.opencastproject.job.api.Job
    enrich(org.opencastproject.mediapackage.MediaPackageElement original, boolean override, Map<String,String> options)
    Equip an existing media package element with automatically generated metadata
    org.opencastproject.job.api.Job
    inspect(URI uri)
    Inspect a track based on a given uri to the track and put the gathered data into the track
    org.opencastproject.job.api.Job
    inspect(URI uri, Map<String,String> options)
    Inspect a track based on a given uri to the track and put the gathered data into the track

  • Field Details

    • JOB_TYPE

      static final String JOB_TYPE
      The namespace distinguishing media inspection jobs from other types
      See Also:

  • Method Details

    • inspect

      org.opencastproject.job.api.Job inspect(URI uri) throws MediaInspectionException
      Inspect a track based on a given uri to the track and put the gathered data into the track
      Parameters:
      uri - the uri to a track in a media package
      Returns:
      the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done
      Throws:
      MediaInspectionException - if there is a failure during media package update

    • inspect

      org.opencastproject.job.api.Job inspect(URI uri, Map<String,String> options) throws MediaInspectionException
      Inspect a track based on a given uri to the track and put the gathered data into the track
      Parameters:
      uri - the uri to a track in a media package
      options - Options in form of key/value pairs that are passed to the Media Inspection Service implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.
      Returns:
      the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done
      Throws:
      MediaInspectionException - if there is a failure during media package update

    • enrich

      org.opencastproject.job.api.Job enrich(org.opencastproject.mediapackage.MediaPackageElement original, boolean override) throws MediaInspectionException, org.opencastproject.mediapackage.MediaPackageException
      Equip an existing media package element with automatically generated metadata
      Parameters:
      original - The original media package element that will be inspected
      override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.
      Returns:
      the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done
      Throws:
      MediaInspectionException - if there is a failure during media package update
      org.opencastproject.mediapackage.MediaPackageException - if the element is invalid

    • enrich

      org.opencastproject.job.api.Job enrich(org.opencastproject.mediapackage.MediaPackageElement original, boolean override, Map<String,String> options) throws MediaInspectionException, org.opencastproject.mediapackage.MediaPackageException
      Equip an existing media package element with automatically generated metadata
      Parameters:
      original - The original media package element that will be inspected
      override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.
      options - Options in form of key/value pairs that are passed to the MediaInspectionService implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.
      Returns:
      the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done
      Throws:
      MediaInspectionException - if there is a failure during media package update
      org.opencastproject.mediapackage.MediaPackageException - if the element is invalid