DotnetTimecode 3.0.1

What is Dotnet Timecode?

Dotnet Timecode is a C# class library for working with SMPTE Timecodes defined by the Society of Motion Picture and Television Engineers in the SMPTE 12M specification.

The library allows the user to construct timecode objects, manipulate timecode values, and convert between the most common framerates, including drop frame framerates such as 29.97DF and 59.95DF.

How do I get started?

Get the latest nuget package using the dotnet CLI

dotnet add package DotnetTimecode

or using the Nuget Package Manager

Install-Package DotnetTimecode

Add a reference to the library, then simply construct your objects.

Examples:

using DotnetTimecode;
using DotnetTimecode.Enums;

var foo = new Timecode(Framerate.fps30);
var bar = new Timecode(10, 00, 00, 00, Framerate.fps59_94_DF);
var baz = new Timecode("10:00:00:00", Framerate.fps24);

foo.ToString() // "00:00:00:00"
bar.AddMinutes(-61).ToString(); // "08:59:00;00"
baz.ConvertFramerate(Framerate.fps25).ToString(); // "09:36:00:00"

Public endpoints

Constructors

Timecode(Enums.Framerate framerate);
Timecode(int hour, int minute, int second, int frame, Enums.Framerate framerate);
Timecode(string timecode, Enums.Framerate framerate);

Object methods

timecodeObj.AddHours(int hours);
timecodeObj.AddMinutes(int minutes);
timecodeObj.AddSeconds(int seconds);
timecodeObj.AddFrames(int frames);
timecodeObj.ConvertFramerate(Enums.Framerate targetFramerate);
string timecodeString = timecodeObj.ToString();
string timecodeString = timecodeObj.ToSubtitleString();

Static methods

string timecodeString = Timecode.AddHours(string timecode, int hours);
string timecodeString = Timecode.AddMinutes(string timecode, int minutes);
string timecodeString = Timecode.AddSeconds(string timecode, int seconds);
string timecodeString = Timecode.AddFrames(string timecode, int frames);
string timecodeString = Timecode.ConvertFramerate(string timecode, Enums.Framerate originalFramerate, Enums.Framerate targetFramerate);
string timecodeString = Timecode.ConvertSMPTETimecodeToSubtitleTimecode(string srtTimecode, Enums.Framerate framerate);
string subtitleTimecodeString = Timecode.ConvertSubtitleTimecodeToSMPTETimecode(string timecode, Enums.Framerate framerate);

Object Properties

int hour = timecodeObj.Hour;
int minute = timecodeObj.Minute;
int second = timecodeObj.Second;
int frame = timecodeObj.Frame;
int totalFrames = timecodeObj.TotalFrames;
Enums.Framerate framerate = timecodeObj.Framerate;

Static Properties

string timecodeRegex = Timecode.TimecodeRegexPattern;
string srtTimecodeRegex = Timecode.SrtTimecodeRegexPattern;

Operator Overloading

var timecodeObj1 = new Timecode(10, 0, 0, 0, Enums.Framerate.fps23_976); // 10:00:00:00
var timecodeObj2 = new Timecode(1, 0, 0, 0, Enums.Framerate.fps23_976); // 01:00:00:00

timecodeObj1 + timecodeObj2;  // 11:00:00:00
timecodeObj1 - timecodeObj2;  // 09:00:00:00
timecodeObj1 < timecodeObj2;  // False
timecodeObj1 > timecodeObj2;  // True
timecodeObj1 <= timecodeObj2; // False
timecodeObj1 >= timecodeObj2; // True
timecodeObj1 == timecodeObj2; // False
timecodeObj1 != timecodeObj2; // True

Contributions

How to contribute to the project

See CONTRIBUTING.md and CODE_OF_CONDUCT.md for instructions on how to contribute to the project.

License

Dotnet Timecode is Copyright © 2022 Rasmus Broborg and other contributors under the MIT license.