timecodetool

README

TimecodeTool package

This package represents all the front facing APIs for both the CLI and the library.

Documentation

Index

• Variables
• type CalcResponse
  • func NewCalculateTimecodes(inTc string, operations []string, fps float64, excludeLastTimecode bool) *CalcResponse
• type CalculationStep
• type SpanResponse
  • func NewSpanTimecode(startTc string, endTc string, fps float64, excludeLastTimecode bool) *SpanResponse
• type ValidateResponse
  • func NewValidateTimecode(startTc string, fps float64) *ValidateResponse

Variables

var VERSION string

Types

type CalcResponse

type CalcResponse struct {
	SpanResponse
	LastTimecode string `json:"lastTimecode"`
	Steps        []CalculationStep
}

func NewCalculateTimecodes

func NewCalculateTimecodes(inTc string, operations []string, fps float64, excludeLastTimecode bool) *CalcResponse

type CalculationStep

type CalculationStep struct {
	Operation string `json:"operation"` // "+" or "-"
	Timecode  string `json:"timecode"`  // Timecode for the operation
	Frames    int    `json:"frames"`    // Equivalent frames for the operation
}

type SpanResponse

type SpanResponse struct {
	InputFirstTimecode  string  `json:"inputFirstTimecode"`
	InputLastTimecode   string  `json:"inputLastTimecode,omitempty"`
	InputFps            float64 `json:"inputFps"`
	Valid               bool    `json:"valid"`
	ErrorMsg            string  `json:"errorMsg"`
	IsDf                bool    `json:"isDf"`
	ExcludeLastTimecode bool    `json:"excludeLastTimecode"`
	StartFrameIdx       int     `json:"startFrameIdx"`
	LastFrameIdx        int     `json:"lastFrameIdx"`
	LengthFrames        int     `json:"lengthFrames"`
	LengthTime          string  `json:"lengthTime"`
	LengthTimecode      string  `json:"lengthTimecode"`
	LengthSeconds       float64 `json:"lengthSeconds"`
	NextTimecode        string  `json:"nextTimecode"`
}

func NewSpanTimecode

func NewSpanTimecode(startTc string, endTc string, fps float64, excludeLastTimecode bool) *SpanResponse

type ValidateResponse

type ValidateResponse struct {
	InputTimecode string  `json:"inputTimecode"`
	InputFps      float64 `json:"inputFps"`
	Valid         bool    `json:"valid"`
	ErrorMsg      string  `json:"errorMsg"`
	IsDf          bool    `json:"isDf"`
	FrameIdx      int     `json:"frameIdx"`
	NextTimecode  string  `json:"nextTimecode"`
}

func NewValidateTimecode

func NewValidateTimecode(startTc string, fps float64) *ValidateResponse