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
23 package org.opencastproject.silencedetection.api;
24
25 import org.opencastproject.job.api.Job;
26 import org.opencastproject.mediapackage.Track;
27
28 /**
29 * SilenceDetectionService detect silent seqences in audio tracks.
30 */
31 public interface SilenceDetectionService {
32
33 /**
34 * ServiceRegistry job type.
35 */
36 String JOB_TYPE = "org.opencastproject.silencedetection";
37
38 /**
39 * Run silence detection on audio (visual) file.
40 *
41 * @param sourceTrack track to detect non silent segments from
42 * @return Job detection job
43 * @throws SilenceDetectionFailedException if fails
44 */
45 Job detect(Track sourceTrack) throws SilenceDetectionFailedException;
46
47 /**
48 * Run silence detection on audio (visual) file.
49 *
50 * @param sourceTrack track to detect non silent segments from
51 * @param referenceTracks tracks to reference in smil file instead of sourceTrack
52 * @return Job detection job
53 * @throws SilenceDetectionFailedException if fails
54 */
55 Job detect(Track sourceTrack, Track[] referenceTracks) throws SilenceDetectionFailedException;
56 }