View Source Vtc.Source.Frames protocol (vtc v0.17.5)
Protocol which types can implement to be passed as the main value of
Framestamp.with_frames/2.
implementations
Implementations
Out of the box, this protocol is implemented for the following types:
String&BitStringtimecode ("01:00:00:00")
integer ("86400")
Feet+Frames ("5400+00")
Link to this section Summary
Functions
Returns the value as a frame count.
Link to this section Types
@type result() :: {:ok, integer()} | {:error, Vtc.Framestamp.ParseError.t()}
Result type of frames/2.
@type t() :: term()
Link to this section Functions
@spec frames(t(), Vtc.Framerate.t()) :: result()
Returns the value as a frame count.
Arguments
value: The source value.
rate: The framerate of the framestamp being parsed.
Returns
A result tuple with an integer value representing the frame count on success.