org.opencastproject.caption.api.Caption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencast-caption-api Show documentation

There is a newer version: 16.7

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.caption.api;

/**
 * A single caption at a point in time.
 */
public interface Caption {

  /**
   * Get the start time of the caption.
   *
   * @return caption start time
   */
  Time getStartTime();

  /**
   * Get the end time of the caption.
   *
   * @return caption end time
   */
  Time getStopTime();

  /**
   * Get the caption text.
   *
   * @return caption text
   */
  String[] getCaption();
}