mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-01 08:24:53 +01:00
modified docstring
This commit is contained in:
parent
4f862acfb8
commit
b73fcc6730
1 changed files with 8 additions and 20 deletions
|
|
@ -307,34 +307,22 @@ def burnins_from_data(input_path, codec_data, output_path, data, overwrite=True)
|
||||||
- each key of "burnins" represents Alignment, there are 6 possibilities:
|
- each key of "burnins" represents Alignment, there are 6 possibilities:
|
||||||
TOP_LEFT TOP_CENTERED TOP_RIGHT
|
TOP_LEFT TOP_CENTERED TOP_RIGHT
|
||||||
BOTTOM_LEFT BOTTOM_CENTERED BOTTOM_RIGHT
|
BOTTOM_LEFT BOTTOM_CENTERED BOTTOM_RIGHT
|
||||||
- value for each key is dict which should contain "function" which says
|
- value must be string with text you want to burn-in
|
||||||
what kind of burnin is that:
|
- text may contain specific formatting keys (exmplained below)
|
||||||
"text", "timecode" or "frame_numbers"
|
|
||||||
- "text" key with content is also required when "text" function is used
|
|
||||||
|
|
||||||
Requirement of *data* keys is based on presets.
|
Requirement of *data* keys is based on presets.
|
||||||
- "start_frame" - is required when "timecode" or "frame_numbers" function is used
|
- "frame_start" - is required when "timecode" or "current_frame" ins keys
|
||||||
- "start_frame_tc" - when "timecode" should start with different frame
|
- "frame_start_tc" - when "timecode" should start with different frame
|
||||||
- *keys for static text*
|
- *keys for static text*
|
||||||
|
|
||||||
EXAMPLE:
|
EXAMPLE:
|
||||||
preset = {
|
preset = {
|
||||||
"options": {*OPTIONS FOR LOOK*},
|
"options": {*OPTIONS FOR LOOK*},
|
||||||
"burnins": {
|
"burnins": {
|
||||||
"TOP_LEFT": {
|
"TOP_LEFT": "static_text",
|
||||||
"function": "text",
|
"TOP_RIGHT": "{shot}",
|
||||||
"text": "static_text"
|
"BOTTOM_LEFT": "TC: {timecode}",
|
||||||
},
|
"BOTTOM_RIGHT": "{frame_start}{current_frame}"
|
||||||
"TOP_RIGHT": {
|
|
||||||
"function": "text",
|
|
||||||
"text": "{shot}"
|
|
||||||
},
|
|
||||||
"BOTTOM_LEFT": {
|
|
||||||
"function": "timecode"
|
|
||||||
},
|
|
||||||
"BOTTOM_RIGHT": {
|
|
||||||
"function": "frame_numbers"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue