Look under the Automation menu in Aegisub. You can run Karaoke Templater in two different ways. Then continue on to more advanced effects throughout the series. We’ll start out with something simple and The exact contents of this table are deliberately undocumented, and may change without warning.Welcome to the first tutorial in using Karaoke Templater to create karaoke effects. Get a table containing information about what files the user currently has open. Synopsis properties = aegisub.project_properties() Invalid path specifier (such as if ?video was used when no video is open),Ī string that is unlikely to be useful in any way. ( string) If encoded_path began with a valid path specifier, an absolute path. ( string) A string which may optionally begin with an Aegisub path specifier. Synopsis path = code_path(encoded_path)Ĭonvert a path beginning with a path specifier No keyframe data is loaded, the table will be empty. keyframes ( table) A sorted table where each entry is the frame number of a keyframe. Get a list of what video frames are keyframes.

4: The DAR is whatever the ar return value contains.

artype ( number) There are 5 values that artype can take: ar ( number) Custom display aspect ratio override. yres ( number) Coded height of the video in pixels, or nil if there is no video loaded. xres ( number) Coded width of the video in pixels, or nil if there is no video loaded. Get information about the resolution and aspect-ratio of the loaded video, Synopsis: xres, yres, ar, artype = _size() That is guaranteed to be within the frame. Millisecond this function rounds up and returns the first whole millisecond ms ( number) First integer millisecond time stamp to lie within the frame, or nil ifīecause beginning times of frames can have better precision than one ( number) Frame to obtain the beginning time of. Use loaded frame rate data to convert a frame number of the video intoĪn absolute time in milliseconds. Synopsis: ms = aegisub.ms_from_frame(frame) If the time is in the middle of the frame it is rounded down to the frame

frame ( number) Frame number corresponding to the time in ms, or nil if there is no ( number) Absolute time from the beginning of the video, for Use loaded frame rate data to convert an absolute time given in The beginning time of a frame is included in the range while theĮnding time is excluded from the range. The ending time of a frame is the beginning time of the One-dimensional time line, a time stamp is a point on the time line, whileĪ video frame spans a range of the time line, from its beginning time to One thing to remember when using these functions is that, considering a get the timestamps of a number of sequential frames andĬalculate coordinates, sizes etc. The primary purpose of these functions is to be able to generate per-frameĮffects, i.e. Getting information on the video #Īutomation 4 Lua offers two functions designed to be able to work withįrame-based timing without having to consider whether the video source is Note that in the bundled macros this is always aliased to tr for the sake Translations), but if you happen to be using strings that are present in

This is mostly only intended for scriptsīundled with Aegisub (as there’s no way for you to add your own Synopsis: translation = aegisub.gettext(untranslated) Rendered sizes of bits and pieces of a longer text, which can then be Rather, it is intended as a helper to create text layouts by determining It cannot handle any kind of formatting codes or text layout. You should only feed plain text strings without line breaks into thisįunction. ext_lead ( number) External leading for the font. descent ( number) Length of descenders in the font. height ( number) Height in pixels of the text. Should not contain line breaks ( or ) nor should it containįormatting codes of any kind. ( string) The text the extents should be determined for. The font name, size, weight, style, spacing andĮncoding is used to determine the size of the text. Obtain system font metrics and determine the rendered size in pixels of the Synopsis: width, height, descent, ext_lead = aegisub.text_extents(style, text) Immediately end execution of the current script, rolling back any changes These can’t be clearly placed into any of the other mainĬategories and there’s too few of each kind to warrant a separate category. This page documents miscellaneous APIs useful for working with

Tutorial create effects for aegisub