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.speechtotext.api;
23
24 import org.opencastproject.job.api.Job;
25
26 import java.net.URI;
27
28 /**
29 * Generates subtitles files from video or audio sources.
30 */
31 public interface SpeechToTextService {
32
33 /**
34 * The namespace distinguishing speech-to-text jobs from other types.
35 */
36 String JOB_TYPE = "org.opencastproject.speechtotext";
37
38 /**
39 * Generates a subtitles file for a media package with an audio track.
40 *
41 * @param mediaFile Location of the media file to generate subtitles for.
42 * @param language The language of the audio.
43 * @return SpeechToText service job.
44 * @throws SpeechToTextServiceException If something went wrong during the subtitle's generation.
45 */
46 Job transcribe(URI mediaFile, String language, Boolean translate) throws SpeechToTextServiceException;
47
48 }