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.videogrid.api;
23
24 import org.opencastproject.job.api.Job;
25 import org.opencastproject.mediapackage.MediaPackageException;
26 import org.opencastproject.mediapackage.Track;
27
28 import org.apache.commons.codec.EncoderException;
29
30 import java.util.List;
31
32 /**
33 * Generate a single video out of many, arranged in a grid.
34 */
35 public interface VideoGridService {
36
37 /**
38 * The namespace distinguishing videogrid jobs from other types
39 */
40 String JOB_TYPE = "org.opencastproject.videogrid";
41
42 /**
43 * Generate the final video in parts
44 *
45 * @param command
46 * An ffmpeg command as a list
47 * @param tracks
48 * Source tracks used by the ffmpeg command
49 * @return VideoGrid service job.
50 * @throws VideoGridServiceException
51 * If something went wrong during the processing
52 */
53 Job createPartialTrack(List<String> command, Track... tracks)
54 throws VideoGridServiceException, EncoderException, MediaPackageException;
55 }