Difference between revisions of "FormatTimecode"

From Moving Light Assistant
Jump to: navigation, search
(Added Page.)
 
m
 
Line 8: Line 8:
 
The separators of the timecode string do not really matter as long as it is not a number, so it could be a dot, comma, slash etc.<br><br>
 
The separators of the timecode string do not really matter as long as it is not a number, so it could be a dot, comma, slash etc.<br><br>
  
Format String Examples...<br>
+
''Format String Examples...''<br>
 
<code> h/m/s/f </code><br>
 
<code> h/m/s/f </code><br>
 
<code> h:m:s:f</code><br>
 
<code> h:m:s:f</code><br>
 
<code> h/m/s.f</code> (note this is the format the Hog 4 uses)<br><br>
 
<code> h/m/s.f</code> (note this is the format the Hog 4 uses)<br><br>
  
Code Example...<br>
+
''Code Example..''.<br>
<code>a = FormatTimecode("00.01.23.04", "h/m/s/f")</code><br>
+
<code>a = FormatTimecode("00.01.23.04", "h/m/s/f")</code><br><br>
 
The variable ''a'' would be assigned the string <code>00/01/23/04</code>
 
The variable ''a'' would be assigned the string <code>00/01/23/04</code>

Latest revision as of 16:12, 27 December 2015

FormatTimcode( timecodeString, formatString )

timecodeString is a string. This is a timecode string.
formatString is a string. This is a string to define the format of the returned string .
Returns a string. This is a string representing the timecode in a format defined by the format string

This function is only available in MLA v1.2.1 Beta 6 onwards.

This function is used to format a timecode string. The format string will define the separating characters between time fields. The placeholders h, m, s, f are used to indicate the hours, minutes, seconds and frames values.
The separators of the timecode string do not really matter as long as it is not a number, so it could be a dot, comma, slash etc.

Format String Examples...
h/m/s/f
h:m:s:f
h/m/s.f (note this is the format the Hog 4 uses)

Code Example...
a = FormatTimecode("00.01.23.04", "h/m/s/f")

The variable a would be assigned the string 00/01/23/04