#
View Source Vtc.Framestamp.ParseError exception (vtc v0.13.15)

Exception returned when there is an error parsing a Timecode value.

##

struct-fields

Struct Fields

- `reason`: The reason the error occurred.

##

failure-reasons

Failure Reasons

The following values can appear in the `:reason` fields:

- `:unrecognized_format`: Returned when a string value is not a recognized timecode, runtime, etc. format.

- `:bad_drop_frames`: Returned when parsing SMPTE, drop-frame timecode. Indicates that the 'frames' field represents a frame that should have been dropped.

# Link to this section Summary

## Types

t()

Type of `Framestamp.ParseError`.

## Functions

message(map)

Returns a message for the error reason.

# Link to this section Types

Link to this type

# t()

View Source

    @type t() :: %Vtc.Framestamp.ParseError{
      __exception__: true,
      reason:
        :unrecognized_format
        | :bad_drop_frames
        | :drop_frame_maximum_exceeded
        | :partial_frame
    }

Type of `Framestamp.ParseError`.

# Link to this section Functions

Link to this function

# message(map)

View Source

    @spec message(t()) :: String.t()

Returns a message for the error reason.