fake-bpy-module 20240802__py3-none-any.whl → 20240804__py3-none-any.whl

bpy/ops/sequencer/__init__.pyi

@@ -13,7 +13,7 @@ def change_effect_input(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    swap: str | None = "A_B",
+    swap: typing.Literal["A_B", "B_C", "A_C"] | None = "A_B",
 ):
     """Undocumented, consider contributing.
 
@@ -21,7 +21,7 @@ def change_effect_input(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param swap: Swap, The effect inputs to swap
-    :type swap: str | None
+    :type swap: typing.Literal['A_B','B_C','A_C'] | None
     """
 
     ...
@@ -31,7 +31,27 @@ def change_effect_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CROSS",
+    type: typing.Literal[
+        "CROSS",
+        "ADD",
+        "SUBTRACT",
+        "ALPHA_OVER",
+        "ALPHA_UNDER",
+        "GAMMA_CROSS",
+        "MULTIPLY",
+        "OVER_DROP",
+        "WIPE",
+        "GLOW",
+        "TRANSFORM",
+        "COLOR",
+        "SPEED",
+        "MULTICAM",
+        "ADJUSTMENT",
+        "GAUSSIAN_BLUR",
+        "TEXT",
+        "COLORMIX",
+    ]
+    | None = "CROSS",
 ):
     """Undocumented, consider contributing.
 
@@ -93,7 +113,7 @@ def change_effect_type(
 
     COLORMIX
     Color Mix.
-        :type type: str | None
+        :type type: typing.Literal['CROSS','ADD','SUBTRACT','ALPHA_OVER','ALPHA_UNDER','GAMMA_CROSS','MULTIPLY','OVER_DROP','WIPE','GLOW','TRANSFORM','COLOR','SPEED','MULTICAM','ADJUSTMENT','GAUSSIAN_BLUR','TEXT','COLORMIX'] | None
     """
 
     ...
@@ -128,7 +148,10 @@ def change_path(
     filter_blenlib: bool | None = False,
     filemode: int | None = 9,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
     use_placeholders: bool | None = False,
 ):
@@ -198,7 +221,7 @@ def change_path(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
         :param use_placeholders: Use Placeholders, Use placeholders for missing frames of the strip
@@ -343,7 +366,27 @@ def effect_strip_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CROSS",
+    type: typing.Literal[
+        "CROSS",
+        "ADD",
+        "SUBTRACT",
+        "ALPHA_OVER",
+        "ALPHA_UNDER",
+        "GAMMA_CROSS",
+        "MULTIPLY",
+        "OVER_DROP",
+        "WIPE",
+        "GLOW",
+        "TRANSFORM",
+        "COLOR",
+        "SPEED",
+        "MULTICAM",
+        "ADJUSTMENT",
+        "GAUSSIAN_BLUR",
+        "TEXT",
+        "COLORMIX",
+    ]
+    | None = "CROSS",
     frame_start: int | None = 0,
     frame_end: int | None = 0,
     channel: int | None = 1,
@@ -412,7 +455,7 @@ def effect_strip_add(
 
     COLORMIX
     Color Mix.
-        :type type: str | None
+        :type type: typing.Literal['CROSS','ADD','SUBTRACT','ALPHA_OVER','ALPHA_UNDER','GAMMA_CROSS','MULTIPLY','OVER_DROP','WIPE','GLOW','TRANSFORM','COLOR','SPEED','MULTICAM','ADJUSTMENT','GAUSSIAN_BLUR','TEXT','COLORMIX'] | None
         :param frame_start: Start Frame, Start frame of the sequence strip
         :type frame_start: int | None
         :param frame_end: End Frame, End frame for the color strip
@@ -487,7 +530,10 @@ def export_subtitles(
     filter_folder: bool | None = True,
     filter_blenlib: bool | None = False,
     filemode: int | None = 8,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Export .srt file containing text strips
@@ -550,7 +596,7 @@ def export_subtitles(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -563,7 +609,8 @@ def fades_add(
     undo: bool | None = None,
     *,
     duration_seconds: float | None = 1.0,
-    type: str | None = "IN_OUT",
+    type: typing.Literal["IN_OUT", "IN", "OUT", "CURSOR_FROM", "CURSOR_TO"]
+    | None = "IN_OUT",
 ):
     """Adds or updates a fade animation for either visual or audio strips
 
@@ -588,7 +635,7 @@ def fades_add(
 
     CURSOR_TO
     To Current Frame -- Fade from the start of sequences under the time cursor to the current frame.
-        :type type: str | None
+        :type type: typing.Literal['IN_OUT','IN','OUT','CURSOR_FROM','CURSOR_TO'] | None
     """
 
     ...
@@ -673,15 +720,25 @@ def image_strip_add(
     relative_path: bool | None = True,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
-    sort_method: str | None = "",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
+    sort_method: typing.Literal[
+        "DEFAULT",
+        "FILE_SORT_ALPHA",
+        "FILE_SORT_EXTENSION",
+        "FILE_SORT_TIME",
+        "FILE_SORT_SIZE",
+    ]
+    | None = "",
     frame_start: int | None = 0,
     frame_end: int | None = 0,
     channel: int | None = 1,
     replace_sel: bool | None = True,
     overlap: bool | None = False,
     overlap_shuffle_override: bool | None = False,
-    fit_method: str | None = "FIT",
+    fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"] | None = "FIT",
     set_view_transform: bool | None = True,
     use_placeholders: bool | None = False,
 ):
@@ -751,7 +808,7 @@ def image_strip_add(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
 
     DEFAULT
@@ -768,7 +825,7 @@ def image_strip_add(
 
     FILE_SORT_SIZE
     Size -- Sort files by size.
-        :type sort_method: str | None
+        :type sort_method: typing.Literal['DEFAULT','FILE_SORT_ALPHA','FILE_SORT_EXTENSION','FILE_SORT_TIME','FILE_SORT_SIZE'] | None
         :param frame_start: Start Frame, Start frame of the sequence strip
         :type frame_start: int | None
         :param frame_end: End Frame, End frame for the color strip
@@ -794,7 +851,7 @@ def image_strip_add(
 
     ORIGINAL
     Use Original Size -- Keep image at its original size.
-        :type fit_method: str | None
+        :type fit_method: typing.Literal['FIT','FILL','STRETCH','ORIGINAL'] | None
         :param set_view_transform: Set View Transform, Set appropriate view transform based on media color space
         :type set_view_transform: bool | None
         :param use_placeholders: Use Placeholders, Use placeholders for missing frames of the strip
@@ -941,14 +998,24 @@ def movie_strip_add(
     relative_path: bool | None = True,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
-    sort_method: str | None = "",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
+    sort_method: typing.Literal[
+        "DEFAULT",
+        "FILE_SORT_ALPHA",
+        "FILE_SORT_EXTENSION",
+        "FILE_SORT_TIME",
+        "FILE_SORT_SIZE",
+    ]
+    | None = "",
     frame_start: int | None = 0,
     channel: int | None = 1,
     replace_sel: bool | None = True,
     overlap: bool | None = False,
     overlap_shuffle_override: bool | None = False,
-    fit_method: str | None = "FIT",
+    fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"] | None = "FIT",
     set_view_transform: bool | None = True,
     adjust_playback_rate: bool | None = True,
     sound: bool | None = True,
@@ -1022,7 +1089,7 @@ def movie_strip_add(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
 
     DEFAULT
@@ -1039,7 +1106,7 @@ def movie_strip_add(
 
     FILE_SORT_SIZE
     Size -- Sort files by size.
-        :type sort_method: str | None
+        :type sort_method: typing.Literal['DEFAULT','FILE_SORT_ALPHA','FILE_SORT_EXTENSION','FILE_SORT_TIME','FILE_SORT_SIZE'] | None
         :param frame_start: Start Frame, Start frame of the sequence strip
         :type frame_start: int | None
         :param channel: Channel, Channel to place this strip into
@@ -1063,7 +1130,7 @@ def movie_strip_add(
 
     ORIGINAL
     Use Original Size -- Keep image at its original size.
-        :type fit_method: str | None
+        :type fit_method: typing.Literal['FIT','FILL','STRETCH','ORIGINAL'] | None
         :param set_view_transform: Set View Transform, Set appropriate view transform based on media color space
         :type set_view_transform: bool | None
         :param adjust_playback_rate: Adjust Playback Rate, Play at normal speed regardless of scene FPS
@@ -1481,7 +1548,7 @@ def scene_strip_add_new(
     replace_sel: bool | None = True,
     overlap: bool | None = False,
     overlap_shuffle_override: bool | None = False,
-    type: str | None = "NEW",
+    type: typing.Literal["NEW", "EMPTY", "LINK_COPY", "FULL_COPY"] | None = "NEW",
 ):
     """Create a new Strip and assign a new Scene as source
 
@@ -1511,7 +1578,7 @@ def scene_strip_add_new(
 
     FULL_COPY
     Full Copy -- Add a Strip and make a full copy of the current scene.
-        :type type: str | None
+        :type type: typing.Literal['NEW','EMPTY','LINK_COPY','FULL_COPY'] | None
     """
 
     ...
@@ -1572,7 +1639,7 @@ def select_all(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "TOGGLE",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
 ):
     """Select or deselect all strips
 
@@ -1592,7 +1659,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -1607,7 +1674,7 @@ def select_box(
     ymin: int | None = 0,
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
     tweak: bool | None = False,
     include_handles: bool | None = False,
 ):
@@ -1636,7 +1703,7 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
         :param tweak: Tweak, Operator has been activated using a click-drag event
         :type tweak: bool | None
         :param include_handles: Select Handles, Select the strips and their handles
@@ -1650,7 +1717,10 @@ def select_grouped(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "TYPE",
+    type: typing.Literal[
+        "TYPE", "TYPE_BASIC", "TYPE_EFFECT", "DATA", "EFFECT", "EFFECT_LINK", "OVERLAP"
+    ]
+    | None = "TYPE",
     extend: bool | None = False,
     use_active_channel: bool | None = False,
 ):
@@ -1681,7 +1751,7 @@ def select_grouped(
 
     OVERLAP
     Overlap -- Overlapping time.
-        :type type: str | None
+        :type type: typing.Literal['TYPE','TYPE_BASIC','TYPE_EFFECT','DATA','EFFECT','EFFECT_LINK','OVERLAP'] | None
         :param extend: Extend, Extend selection instead of deselecting everything first
         :type extend: bool | None
         :param use_active_channel: Same Channel, Only consider strips on the same channel as the active one
@@ -1719,7 +1789,10 @@ def select_handles(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    side: str | None = "BOTH",
+    side: typing.Literal[
+        "LEFT", "RIGHT", "BOTH", "LEFT_NEIGHBOR", "RIGHT_NEIGHBOR", "BOTH_NEIGHBORS"
+    ]
+    | None = "BOTH",
 ):
     """Select gizmo handles on the sides of the selected strip
 
@@ -1727,7 +1800,7 @@ def select_handles(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param side: Side, The side of the handle that is selected
-    :type side: str | None
+    :type side: typing.Literal['LEFT','RIGHT','BOTH','LEFT_NEIGHBOR','RIGHT_NEIGHBOR','BOTH_NEIGHBORS'] | None
     """
 
     ...
@@ -1797,7 +1870,7 @@ def select_side(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    side: str | None = "BOTH",
+    side: typing.Literal["MOUSE", "LEFT", "RIGHT", "BOTH", "NO_CHANGE"] | None = "BOTH",
 ):
     """Select strips on the nominated side of the selected strips
 
@@ -1805,7 +1878,7 @@ def select_side(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param side: Side, The side to which the selection is applied
-    :type side: str | None
+    :type side: typing.Literal['MOUSE','LEFT','RIGHT','BOTH','NO_CHANGE'] | None
     """
 
     ...
@@ -1816,7 +1889,7 @@ def select_side_of_frame(
     undo: bool | None = None,
     *,
     extend: bool | None = False,
-    side: str | None = "LEFT",
+    side: typing.Literal["LEFT", "RIGHT", "CURRENT"] | None = "LEFT",
 ):
     """Select strips relative to the current frame
 
@@ -1835,7 +1908,7 @@ def select_side_of_frame(
 
     CURRENT
     Current Frame -- Select intersecting with the current frame.
-        :type side: str | None
+        :type side: typing.Literal['LEFT','RIGHT','CURRENT'] | None
     """
 
     ...
@@ -1923,8 +1996,18 @@ def sound_strip_add(
     filter_blenlib: bool | None = False,
     filemode: int | None = 9,
     relative_path: bool | None = True,
-    display_type: str | None = "DEFAULT",
-    sort_method: str | None = "",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
+    sort_method: typing.Literal[
+        "DEFAULT",
+        "FILE_SORT_ALPHA",
+        "FILE_SORT_EXTENSION",
+        "FILE_SORT_TIME",
+        "FILE_SORT_SIZE",
+    ]
+    | None = "",
     frame_start: int | None = 0,
     channel: int | None = 1,
     replace_sel: bool | None = True,
@@ -1997,7 +2080,7 @@ def sound_strip_add(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
 
     DEFAULT
@@ -2014,7 +2097,7 @@ def sound_strip_add(
 
     FILE_SORT_SIZE
     Size -- Sort files by size.
-        :type sort_method: str | None
+        :type sort_method: typing.Literal['DEFAULT','FILE_SORT_ALPHA','FILE_SORT_EXTENSION','FILE_SORT_TIME','FILE_SORT_SIZE'] | None
         :param frame_start: Start Frame, Start frame of the sequence strip
         :type frame_start: int | None
         :param channel: Channel, Channel to place this strip into
@@ -2040,9 +2123,10 @@ def split(
     *,
     frame: int | None = 0,
     channel: int | None = 0,
-    type: str | None = "SOFT",
+    type: typing.Literal["SOFT", "HARD"] | None = "SOFT",
     use_cursor_position: bool | None = False,
-    side: str | None = "MOUSE",
+    side: typing.Literal["MOUSE", "LEFT", "RIGHT", "BOTH", "NO_CHANGE"]
+    | None = "MOUSE",
     ignore_selection: bool | None = False,
 ):
     """Split the selected strips in two
@@ -2055,11 +2139,11 @@ def split(
     :param channel: Channel, Channel in which strip will be cut
     :type channel: int | None
     :param type: Type, The type of split operation to perform on strips
-    :type type: str | None
+    :type type: typing.Literal['SOFT','HARD'] | None
     :param use_cursor_position: Use Cursor Position, Split at position of the cursor instead of current frame
     :type use_cursor_position: bool | None
     :param side: Side, The side that remains selected after splitting
-    :type side: str | None
+    :type side: typing.Literal['MOUSE','LEFT','RIGHT','BOTH','NO_CHANGE'] | None
     :param ignore_selection: Ignore Selection, Make cut even if strip is not selected preserving selection state after cut
     :type ignore_selection: bool | None
     """
@@ -2089,7 +2173,19 @@ def strip_color_tag_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    color: str | None = "NONE",
+    color: typing.Literal[
+        "NONE",
+        "COLOR_01",
+        "COLOR_02",
+        "COLOR_03",
+        "COLOR_04",
+        "COLOR_05",
+        "COLOR_06",
+        "COLOR_07",
+        "COLOR_08",
+        "COLOR_09",
+    ]
+    | None = "NONE",
 ):
     """Set a color tag for the selected strips
 
@@ -2097,7 +2193,7 @@ def strip_color_tag_set(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param color: Color Tag
-    :type color: str | None
+    :type color: typing.Literal['NONE', 'COLOR_01', 'COLOR_02', 'COLOR_03', 'COLOR_04', 'COLOR_05', 'COLOR_06', 'COLOR_07', 'COLOR_08', 'COLOR_09'] | None
     """
 
     ...
@@ -2146,7 +2242,7 @@ def strip_modifier_copy(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "REPLACE",
+    type: typing.Literal["REPLACE", "APPEND"] | None = "REPLACE",
 ):
     """Copy modifiers of the active strip to all selected strips
 
@@ -2160,7 +2256,7 @@ def strip_modifier_copy(
 
     APPEND
     Append -- Append active modifiers to selected strips.
-        :type type: str | None
+        :type type: typing.Literal['REPLACE','APPEND'] | None
     """
 
     ...
@@ -2170,7 +2266,7 @@ def strip_modifier_equalizer_redefine(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    graphs: str | None = "SIMPLE",
+    graphs: typing.Literal["SIMPLE", "DOUBLE", "TRIPLE"] | None = "SIMPLE",
     name: str = "Name",
 ):
     """Redefine equalizer graphs
@@ -2188,7 +2284,7 @@ def strip_modifier_equalizer_redefine(
 
     TRIPLE
     Triplet -- Graphical definition in 3 sections.
-        :type graphs: str | None
+        :type graphs: typing.Literal['SIMPLE','DOUBLE','TRIPLE'] | None
         :param name: Name, Name of modifier to redefine
         :type name: str
     """
@@ -2201,7 +2297,7 @@ def strip_modifier_move(
     undo: bool | None = None,
     *,
     name: str = "Name",
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move modifier up and down in the stack
 
@@ -2217,7 +2313,7 @@ def strip_modifier_move(
 
     DOWN
     Down -- Move modifier down in the stack.
-        :type direction: str | None
+        :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -2245,7 +2341,7 @@ def strip_transform_clear(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    property: str | None = "ALL",
+    property: typing.Literal["POSITION", "SCALE", "ROTATION", "ALL"] | None = "ALL",
 ):
     """Reset image transformation to default value
 
@@ -2265,7 +2361,7 @@ def strip_transform_clear(
 
     ALL
     All -- Reset strip transform location, scale and rotation.
-        :type property: str | None
+        :type property: typing.Literal['POSITION','SCALE','ROTATION','ALL'] | None
     """
 
     ...
@@ -2275,7 +2371,7 @@ def strip_transform_fit(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    fit_method: str | None = "FIT",
+    fit_method: typing.Literal["FIT", "FILL", "STRETCH"] | None = "FIT",
 ):
     """Undocumented, consider contributing.
 
@@ -2292,7 +2388,7 @@ def strip_transform_fit(
 
     STRETCH
     Stretch to Fill -- Stretch image so it fills preview.
-        :type fit_method: str | None
+        :type fit_method: typing.Literal['FIT','FILL','STRETCH'] | None
     """
 
     ...
@@ -2302,7 +2398,7 @@ def swap(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    side: str | None = "RIGHT",
+    side: typing.Literal["LEFT", "RIGHT"] | None = "RIGHT",
 ):
     """Swap active strip with strip to the right or left
 
@@ -2310,7 +2406,7 @@ def swap(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param side: Side, Side of the strip to swap
-    :type side: str | None
+    :type side: typing.Literal['LEFT','RIGHT'] | None
     """
 
     ...