Vtc.Framerate.ParseError exception (vtc v0.1.4) View Source

Exception returned when a framerate cannot be parsed.

Link to this section Summary

Functions

Returns a message for the error reason.

Link to this section Types

Specs

t() :: %Vtc.Framerate.ParseError{
  __exception__: term(),
  reason: :bad_drop_rate | :invalid_ntsc | :unrecognized_format
}

Type of Vtc.Framerate.ParseError

Fields

  • :reason: The reason the error occurred must be one of the following:
    • :bad_drop_rate: Returned when the playback speed of a framerate with an ntsc value of :Drop is not divisible by 3000/1001 (29.97), for more on why drop-frame framerates must be a multiple of 29.97, see: https://www.davidheidelberger.com/2010/06/10/drop-frame-timecode/
    • :invalid_ntsc: Returned when the ntsc value is not one of the allowed atom values.
    • :unrecognized_format: Returned when a string value is not a recognized format.

Link to this section Functions

Specs

message(t()) :: String.t()

Returns a message for the error reason.