1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.crop.api;
23
24
25 import org.opencastproject.job.api.Job;
26 import org.opencastproject.mediapackage.MediaPackageException;
27 import org.opencastproject.mediapackage.Track;
28
29 /**
30 * Api for cropping implementations.
31 */
32 public interface CropService {
33 /** Job type */
34 String JOB_TYPE = "org.opencastproject.crop";
35
36 /**
37 * Takes the given track and returns the job that can be used to get the resulting mpeg7 catalog
38 *
39 * @param track
40 * track to crop
41 * @return the job with which we can obtain the extracted metadata
42 * @throws CropException
43 * if the track could not be cropped
44 * @throws MediaPackageException
45 * if the track is invalid
46 */
47 Job crop(Track track) throws CropException, MediaPackageException;
48 }