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.inspection.ffmpeg.api;
24
25
26 import java.io.File;
27 import java.util.Map;
28
29 /**
30 * Interface for tools that analyze media files.
31 * Implement this and register it as a factory service.
32 *
33 * MediaAnalyzers are not guaranteed to be thread safe.
34 */
35 public interface MediaAnalyzer {
36
37 /**
38 * Analyze a media file and return the metadata that is found
39 *
40 * @param media any media file
41 * @return the metadata that is found
42 * @throws MediaAnalyzerException if the analyzer fails
43 */
44 MediaContainerMetadata analyze(File media) throws MediaAnalyzerException;
45
46 /*
47 * Needed for https://issues.opencastproject.org/jira/browse/MH-2157 -AZ
48 */
49 void setConfig(Map<String, Object> config);
50
51 }