Vtc.Timecode.with_frames
You're seeing just the function
with_frames
, go back to Vtc.Timecode module for more information.
Specs
with_frames(Vtc.Source.Frames.t(), Vtc.Framerate.t()) :: parse_result()
Returns a new Timecode
with a frames/1
return value equal to the frames
arg.
Arguments
frames: A value which can be represented as a frame number / frame count. Must implement the
Frames
protocol.rate: Frame-per-second playback value of the timecode.
Options
- round: How to round the result with regards to whole-frames.
Examples
Accepts timecode strings...
iex> Timecode.with_frames("01:00:00:00", Rates.f23_98) |> inspect()
"{:ok, <01:00:00:00 @ <23.98 NTSC NDF>>}"
... feet+frames strings...
iex> Timecode.with_frames("5400+00", Rates.f23_98) |> inspect()
"{:ok, <01:00:00:00 @ <23.98 NTSC NDF>>}"
... integers...
iex> Timecode.with_frames(86400, Rates.f23_98) |> inspect()
"{:ok, <01:00:00:00 @ <23.98 NTSC NDF>>}"
... and integer strings.
iex> Timecode.with_frames("86400", Rates.f23_98) |> inspect()
"{:ok, <01:00:00:00 @ <23.98 NTSC NDF>>}"