com.github.dnbn.submerge.api.subtitle.common.TimedObject Maven / Gradle / Ivy

Go to download

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

Library to manage SRT and ASS subtitles

The newest version!

package com.github.dnbn.submerge.api.subtitle.common;

import java.io.Serializable;
import java.time.LocalTime;
import java.util.Comparator;

/**
 * 
 * Simple object that contains timed start ant end
 */
public interface TimedObject extends Serializable, Comparable, Comparator {

	/**
	 * Return the time elapsed during script playback at which the text will appear
	 * onscreen.
	 * 
	 * @return start time
	 */
	LocalTime getStart();

	/**
	 * Return the time elapsed during script playback at which the text will disappear
	 * offscreen.
	 * 
	 * @return end time
	 */
	LocalTime getEnd();

	/**
	 * Set the time elapsed during script playback at which the text will appear onscreen.
	 * 
	 * @param start time
	 */
	void setStart(LocalTime start);

	/**
	 * Set the time elapsed during script playback at which the text will disappear
	 * offscreen.
	 * 
	 * @param end time
	 */
	void setEnd(LocalTime end);
}