srt

package

v0.2.0 Latest Latest Go to latest Published: Aug 7, 2023 License: GPL-3.0, MIT Imports: 6 Imported by: 0

Details

I've taken only part of the code for this to work and I have changed some small things, but the documentation of it should still be correct.

This section is empty.

This section is empty.

func LoadSrt(v *SubRip, filepath string) error

LoadSrt loads the provided file into the given object. It fixes the \ufeff problem that some parsers have.

func WriteSrt(v *SubRip, outpath string) error

WriteSrt takes a SubRip object and the path to which to write the file as a string

func WriteSrtToWriter(v *SubRip, w io.Writer) error

WriteSrt takes a SubRip object and the path to which to write the file as a string

type SubRip struct {
	Subtitle struct {
		Content []Subtitle
	}
}

SubRip is the overall file descriptor. It provides a container for us to dump subtitles into.

func ParseSrt(filename string) (*SubRip, error)

ParseSrt is the loader for srt files. Takes the path of the file being opened as the argument.

type Subtitle struct {
	Id    int
	Start string
	End   string
	Line  []string
}

Subtitle struct provides all of the elements of an .srt subtitle with lines of subtitles being broken up into []strings

func CreateSubtitle(id int, start string, end string, text []string) *Subtitle

CreateSubtitle creates a subtitle object.