diff --git a/pype/scripts/otio_burnin.py b/pype/scripts/otio_burnin.py index 034484a442..27f506117a 100644 --- a/pype/scripts/otio_burnin.py +++ b/pype/scripts/otio_burnin.py @@ -9,6 +9,40 @@ log = pype.Logger().get_logger("BurninWrapper", "burninwrap") class ModifiedBurnins(ffmpeg_burnins.Burnins): + ''' + This is modification of OTIO FFmpeg Burnin adapter. + - requires FFmpeg in PATH + + Offers 6 positions for burnin text. Each can be set with: + - static text + - frames + - timecode + + Options - dictionary which sets the final look. + - Datatypes explanation: + string format must be supported by FFmpeg. + Examples: "#000000", "0x000000", "black" + must be accesible by ffmpeg = name of registered Font in system or path to font file. + Examples: "Arial", "C:/Windows/Fonts/arial.ttf" + + - Possible keys: + "opacity" - Opacity of text - + "bg_opacity" - Opacity of background (box around text) - + "bg_color" - Background color - + "bg_padding" - Background padding in pixels - + "x_offset" - offsets burnin vertically by entered pixels from border - + "y_offset" - offsets burnin horizontally by entered pixels from border - + - x_offset & y_offset should be set at least to same value as bg_padding!! + "font" - Font Family for text - + "font_size" - Font size in pixels - + "font_color" - Color of text - + "frame_offset" - Default start frame - + - required IF start frame is not set when using frames or timecode burnins + + On initializing class can be set General options through "options_init" arg. + General can be overriden when adding burnin + + ''' TOP_CENTERED = ffmpeg_burnins.TOP_CENTERED BOTTOM_CENTERED = ffmpeg_burnins.BOTTOM_CENTERED TOP_LEFT = ffmpeg_burnins.TOP_LEFT