fake-bpy-module-latest 20260113__py3-none-any.whl → 20260114__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (251) hide show
  1. _bl_console_utils/autocomplete/complete_calltip/__init__.pyi +0 -13
  2. _bl_console_utils/autocomplete/complete_import/__init__.pyi +0 -5
  3. _bl_console_utils/autocomplete/complete_namespace/__init__.pyi +0 -11
  4. _bl_console_utils/autocomplete/intellisense/__init__.pyi +0 -10
  5. _bpy_types/__init__.pyi +1 -122
  6. _rna_info/__init__.pyi +0 -1
  7. addon_utils/__init__.pyi +0 -13
  8. aud/__init__.pyi +0 -146
  9. bl_math/__init__.pyi +0 -12
  10. bl_operators/add_mesh_torus/__init__.pyi +0 -2
  11. bl_operators/anim/__init__.pyi +0 -26
  12. bl_operators/assets/__init__.pyi +0 -6
  13. bl_operators/bone_selection_sets/__init__.pyi +0 -28
  14. bl_operators/clip/__init__.pyi +0 -20
  15. bl_operators/connect_to_output/__init__.pyi +0 -2
  16. bl_operators/console/__init__.pyi +0 -10
  17. bl_operators/constraint/__init__.pyi +0 -8
  18. bl_operators/copy_global_transform/__init__.pyi +0 -10
  19. bl_operators/file/__init__.pyi +0 -6
  20. bl_operators/freestyle/__init__.pyi +0 -8
  21. bl_operators/geometry_nodes/__init__.pyi +0 -8
  22. bl_operators/grease_pencil/__init__.pyi +0 -2
  23. bl_operators/image/__init__.pyi +0 -10
  24. bl_operators/image_as_planes/__init__.pyi +0 -4
  25. bl_operators/mesh/__init__.pyi +0 -4
  26. bl_operators/node/__init__.pyi +0 -44
  27. bl_operators/object/__init__.pyi +0 -30
  28. bl_operators/object_align/__init__.pyi +0 -2
  29. bl_operators/object_quick_effects/__init__.pyi +0 -8
  30. bl_operators/object_randomize_transform/__init__.pyi +0 -2
  31. bl_operators/presets/__init__.pyi +0 -50
  32. bl_operators/rigidbody/__init__.pyi +0 -6
  33. bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
  34. bl_operators/sequencer/__init__.pyi +0 -16
  35. bl_operators/spreadsheet/__init__.pyi +0 -2
  36. bl_operators/userpref/__init__.pyi +0 -50
  37. bl_operators/uvcalc_follow_active/__init__.pyi +0 -2
  38. bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
  39. bl_operators/uvcalc_transform/__init__.pyi +0 -4
  40. bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
  41. bl_operators/view3d/__init__.pyi +0 -16
  42. bl_operators/wm/__init__.pyi +0 -92
  43. bl_operators/world/__init__.pyi +0 -2
  44. bl_ui/__init__.pyi +0 -4
  45. bl_ui/anim/__init__.pyi +0 -2
  46. bl_ui/asset_shelf/__init__.pyi +0 -2
  47. bl_ui/generic_ui_list/__init__.pyi +1 -17
  48. bl_ui/node_add_menu/__init__.pyi +0 -10
  49. bl_ui/node_add_menu_compositor/__init__.pyi +0 -38
  50. bl_ui/node_add_menu_geometry/__init__.pyi +0 -112
  51. bl_ui/node_add_menu_shader/__init__.pyi +0 -20
  52. bl_ui/node_add_menu_texture/__init__.pyi +0 -16
  53. bl_ui/properties_collection/__init__.pyi +0 -14
  54. bl_ui/properties_constraint/__init__.pyi +0 -154
  55. bl_ui/properties_data_armature/__init__.pyi +0 -36
  56. bl_ui/properties_data_bone/__init__.pyi +0 -20
  57. bl_ui/properties_data_camera/__init__.pyi +0 -30
  58. bl_ui/properties_data_curve/__init__.pyi +0 -30
  59. bl_ui/properties_data_curves/__init__.pyi +0 -16
  60. bl_ui/properties_data_empty/__init__.pyi +0 -4
  61. bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
  62. bl_ui/properties_data_lattice/__init__.pyi +0 -8
  63. bl_ui/properties_data_light/__init__.pyi +0 -20
  64. bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
  65. bl_ui/properties_data_mesh/__init__.pyi +0 -42
  66. bl_ui/properties_data_metaball/__init__.pyi +0 -12
  67. bl_ui/properties_data_modifier/__init__.pyi +0 -18
  68. bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
  69. bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
  70. bl_ui/properties_data_speaker/__init__.pyi +0 -12
  71. bl_ui/properties_data_volume/__init__.pyi +0 -18
  72. bl_ui/properties_freestyle/__init__.pyi +0 -50
  73. bl_ui/properties_grease_pencil_common/__init__.pyi +0 -14
  74. bl_ui/properties_mask_common/__init__.pyi +0 -14
  75. bl_ui/properties_material/__init__.pyi +0 -32
  76. bl_ui/properties_material_gpencil/__init__.pyi +0 -22
  77. bl_ui/properties_object/__init__.pyi +0 -44
  78. bl_ui/properties_output/__init__.pyi +0 -40
  79. bl_ui/properties_paint_common/__init__.pyi +0 -4
  80. bl_ui/properties_particle/__init__.pyi +0 -106
  81. bl_ui/properties_physics_cloth/__init__.pyi +0 -28
  82. bl_ui/properties_physics_common/__init__.pyi +0 -2
  83. bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
  84. bl_ui/properties_physics_field/__init__.pyi +0 -20
  85. bl_ui/properties_physics_fluid/__init__.pyi +0 -56
  86. bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
  87. bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
  88. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
  89. bl_ui/properties_physics_softbody/__init__.pyi +0 -30
  90. bl_ui/properties_render/__init__.pyi +0 -90
  91. bl_ui/properties_scene/__init__.pyi +0 -34
  92. bl_ui/properties_strip/__init__.pyi +0 -42
  93. bl_ui/properties_strip_modifier/__init__.pyi +0 -2
  94. bl_ui/properties_texture/__init__.pyi +0 -54
  95. bl_ui/properties_view_layer/__init__.pyi +0 -28
  96. bl_ui/properties_workspace/__init__.pyi +0 -8
  97. bl_ui/properties_world/__init__.pyi +0 -22
  98. bl_ui/space_clip/__init__.pyi +0 -150
  99. bl_ui/space_console/__init__.pyi +0 -12
  100. bl_ui/space_dopesheet/__init__.pyi +0 -64
  101. bl_ui/space_filebrowser/__init__.pyi +0 -60
  102. bl_ui/space_graph/__init__.pyi +0 -44
  103. bl_ui/space_image/__init__.pyi +0 -142
  104. bl_ui/space_info/__init__.pyi +0 -12
  105. bl_ui/space_nla/__init__.pyi +0 -36
  106. bl_ui/space_node/__init__.pyi +0 -66
  107. bl_ui/space_outliner/__init__.pyi +0 -30
  108. bl_ui/space_properties/__init__.pyi +0 -8
  109. bl_ui/space_sequencer/__init__.pyi +0 -136
  110. bl_ui/space_spreadsheet/__init__.pyi +0 -6
  111. bl_ui/space_statusbar/__init__.pyi +0 -2
  112. bl_ui/space_text/__init__.pyi +0 -32
  113. bl_ui/space_time/__init__.pyi +0 -12
  114. bl_ui/space_topbar/__init__.pyi +0 -52
  115. bl_ui/space_userpref/__init__.pyi +0 -186
  116. bl_ui/space_view3d/__init__.pyi +0 -536
  117. bl_ui/space_view3d_sidebar/__init__.pyi +0 -8
  118. bl_ui/space_view3d_toolbar/__init__.pyi +0 -162
  119. blf/__init__.pyi +0 -47
  120. bmesh/__init__.pyi +0 -7
  121. bmesh/geometry/__init__.pyi +0 -3
  122. bmesh/ops/__init__.pyi +0 -451
  123. bmesh/types/__init__.pyi +65 -427
  124. bmesh/utils/__init__.pyi +0 -44
  125. bpy/app/__init__.pyi +0 -5
  126. bpy/app/icons/__init__.pyi +0 -6
  127. bpy/app/timers/__init__.pyi +0 -6
  128. bpy/app/translations/__init__.pyi +0 -15
  129. bpy/msgbus/__init__.pyi +1 -4
  130. bpy/ops/action/__init__.pyi +15 -165
  131. bpy/ops/anim/__init__.pyi +27 -274
  132. bpy/ops/armature/__init__.pyi +17 -191
  133. bpy/ops/asset/__init__.pyi +11 -97
  134. bpy/ops/boid/__init__.pyi +7 -38
  135. bpy/ops/brush/__init__.pyi +3 -72
  136. bpy/ops/buttons/__init__.pyi +4 -71
  137. bpy/ops/cachefile/__init__.pyi +2 -63
  138. bpy/ops/camera/__init__.pyi +0 -11
  139. bpy/ops/clip/__init__.pyi +43 -427
  140. bpy/ops/cloth/__init__.pyi +0 -5
  141. bpy/ops/collection/__init__.pyi +2 -34
  142. bpy/ops/console/__init__.pyi +10 -88
  143. bpy/ops/constraint/__init__.pyi +3 -80
  144. bpy/ops/curve/__init__.pyi +23 -254
  145. bpy/ops/curves/__init__.pyi +15 -164
  146. bpy/ops/cycles/__init__.pyi +1 -14
  147. bpy/ops/dpaint/__init__.pyi +3 -21
  148. bpy/ops/ed/__init__.pyi +10 -82
  149. bpy/ops/export_anim/__init__.pyi +0 -11
  150. bpy/ops/export_scene/__init__.pyi +0 -154
  151. bpy/ops/extensions/__init__.pyi +15 -150
  152. bpy/ops/file/__init__.pyi +27 -217
  153. bpy/ops/fluid/__init__.pyi +13 -70
  154. bpy/ops/font/__init__.pyi +10 -134
  155. bpy/ops/geometry/__init__.pyi +3 -41
  156. bpy/ops/gizmogroup/__init__.pyi +1 -12
  157. bpy/ops/gpencil/__init__.pyi +5 -38
  158. bpy/ops/graph/__init__.pyi +18 -316
  159. bpy/ops/grease_pencil/__init__.pyi +27 -522
  160. bpy/ops/image/__init__.pyi +19 -379
  161. bpy/ops/import_anim/__init__.pyi +0 -14
  162. bpy/ops/import_curve/__init__.pyi +0 -6
  163. bpy/ops/import_scene/__init__.pyi +0 -50
  164. bpy/ops/info/__init__.pyi +4 -35
  165. bpy/ops/lattice/__init__.pyi +3 -33
  166. bpy/ops/marker/__init__.pyi +2 -50
  167. bpy/ops/mask/__init__.pyi +17 -176
  168. bpy/ops/material/__init__.pyi +3 -15
  169. bpy/ops/mball/__init__.pyi +1 -30
  170. bpy/ops/mesh/__init__.pyi +30 -913
  171. bpy/ops/nla/__init__.pyi +19 -183
  172. bpy/ops/node/__init__.pyi +53 -745
  173. bpy/ops/object/__init__.pyi +75 -1285
  174. bpy/ops/outliner/__init__.pyi +47 -327
  175. bpy/ops/paint/__init__.pyi +14 -279
  176. bpy/ops/paintcurve/__init__.pyi +4 -36
  177. bpy/ops/palette/__init__.pyi +3 -27
  178. bpy/ops/particle/__init__.pyi +20 -160
  179. bpy/ops/pointcloud/__init__.pyi +3 -35
  180. bpy/ops/pose/__init__.pyi +25 -230
  181. bpy/ops/poselib/__init__.pyi +4 -47
  182. bpy/ops/preferences/__init__.pyi +9 -177
  183. bpy/ops/ptcache/__init__.pyi +5 -31
  184. bpy/ops/render/__init__.pyi +3 -70
  185. bpy/ops/rigidbody/__init__.pyi +6 -56
  186. bpy/ops/scene/__init__.pyi +22 -167
  187. bpy/ops/screen/__init__.pyi +19 -214
  188. bpy/ops/script/__init__.pyi +1 -12
  189. bpy/ops/sculpt/__init__.pyi +7 -271
  190. bpy/ops/sculpt_curves/__init__.pyi +1 -20
  191. bpy/ops/sequencer/__init__.pyi +36 -672
  192. bpy/ops/sound/__init__.pyi +3 -109
  193. bpy/ops/spreadsheet/__init__.pyi +5 -32
  194. bpy/ops/surface/__init__.pyi +0 -48
  195. bpy/ops/text/__init__.pyi +25 -226
  196. bpy/ops/text_editor/__init__.pyi +0 -5
  197. bpy/ops/texture/__init__.pyi +3 -18
  198. bpy/ops/transform/__init__.pyi +2 -381
  199. bpy/ops/ui/__init__.pyi +21 -158
  200. bpy/ops/uilist/__init__.pyi +0 -13
  201. bpy/ops/uv/__init__.pyi +9 -316
  202. bpy/ops/view2d/__init__.pyi +3 -73
  203. bpy/ops/view3d/__init__.pyi +37 -339
  204. bpy/ops/wm/__init__.pyi +25 -1308
  205. bpy/ops/workspace/__init__.pyi +7 -39
  206. bpy/ops/world/__init__.pyi +2 -10
  207. bpy/path/__init__.pyi +0 -34
  208. bpy/props/__init__.pyi +12 -148
  209. bpy/types/__init__.pyi +9867 -55713
  210. bpy/utils/__init__.pyi +2 -73
  211. bpy/utils/previews/__init__.pyi +0 -9
  212. bpy/utils/units/__init__.pyi +0 -12
  213. bpy_extras/anim_utils/__init__.pyi +0 -8
  214. bpy_extras/bmesh_utils/__init__.pyi +0 -1
  215. bpy_extras/id_map_utils/__init__.pyi +4 -5
  216. bpy_extras/image_utils/__init__.pyi +0 -9
  217. bpy_extras/io_utils/__init__.pyi +2 -22
  218. bpy_extras/mesh_utils/__init__.pyi +0 -12
  219. bpy_extras/object_utils/__init__.pyi +0 -14
  220. bpy_extras/view3d_utils/__init__.pyi +0 -18
  221. {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/METADATA +2 -1
  222. fake_bpy_module_latest-20260114.dist-info/RECORD +382 -0
  223. freestyle/chainingiterators/__init__.pyi +0 -22
  224. freestyle/functions/__init__.pyi +0 -139
  225. freestyle/predicates/__init__.pyi +0 -51
  226. freestyle/shaders/__init__.pyi +0 -65
  227. freestyle/types/__init__.pyi +139 -777
  228. freestyle/utils/ContextFunctions/__init__.pyi +0 -23
  229. freestyle/utils/__init__.pyi +0 -6
  230. gpu/capabilities/__init__.pyi +0 -21
  231. gpu/matrix/__init__.pyi +0 -9
  232. gpu/platform/__init__.pyi +0 -5
  233. gpu/shader/__init__.pyi +0 -5
  234. gpu/state/__init__.pyi +0 -29
  235. gpu/texture/__init__.pyi +0 -2
  236. gpu/types/__init__.pyi +10 -149
  237. gpu_extras/batch/__init__.pyi +0 -4
  238. gpu_extras/presets/__init__.pyi +0 -9
  239. idprop/types/__init__.pyi +0 -4
  240. imbuf/__init__.pyi +0 -7
  241. imbuf/types/__init__.pyi +5 -25
  242. keyingsets_builtins/__init__.pyi +0 -44
  243. mathutils/__init__.pyi +46 -2160
  244. mathutils/bvhtree/__init__.pyi +1 -24
  245. mathutils/geometry/__init__.pyi +0 -129
  246. mathutils/interpolate/__init__.pyi +0 -3
  247. mathutils/kdtree/__init__.pyi +0 -11
  248. mathutils/noise/__init__.pyi +0 -62
  249. fake_bpy_module_latest-20260113.dist-info/RECORD +0 -382
  250. {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/WHEEL +0 -0
  251. {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/top_level.txt +0 -0
_rna_info/__init__.pyi CHANGED
@@ -83,7 +83,6 @@ class InfoPropertyRNA:
83
83
  :param collection_id:
84
84
  :param enum_descr_override: Optionally override items for enum.
85
85
  Otherwise expand the literal items.
86
- :type enum_descr_override: None | str | None
87
86
  """
88
87
 
89
88
  class InfoStructRNA:
addon_utils/__init__.pyi CHANGED
@@ -11,9 +11,7 @@ def check(module_name: str) -> tuple[bool, bool]:
11
11
  """Returns the loaded state of the addon.
12
12
 
13
13
  :param module_name: The name of the addon and module.
14
- :type module_name: str
15
14
  :return: (loaded_default, loaded_state)
16
- :rtype: tuple[bool, bool]
17
15
  """
18
16
 
19
17
  def check_extension(module_name) -> None:
@@ -29,11 +27,8 @@ def disable(
29
27
  """Disables an addon by name.
30
28
 
31
29
  :param module_name: The name of the addon and module.
32
- :type module_name: str
33
30
  :param default_set: Set the user-preference.
34
- :type default_set: bool
35
31
  :param handle_error: Called in the case of an error, taking an exception argument.
36
- :type handle_error: None | collections.abc.Callable[None] | None
37
32
  """
38
33
 
39
34
  def disable_all() -> None: ...
@@ -48,17 +43,12 @@ def enable(
48
43
  """Enables an addon by name.
49
44
 
50
45
  :param module_name: the name of the addon and module.
51
- :type module_name: str
52
46
  :param default_set: Set the user-preference.
53
- :type default_set: bool
54
47
  :param persistent: Ensure the addon is enabled for the entire session (after loading new files).
55
- :type persistent: bool
56
48
  :param refresh_handled: When true, `extensions_refresh` must have been called with module_name
57
49
  included in addon_modules_pending.
58
50
  This should be used to avoid many calls to refresh extensions when enabling multiple add-ons at once.
59
- :type refresh_handled: bool
60
51
  :param handle_error: Called in the case of an error, taking an exception argument.
61
- :type handle_error: None | collections.abc.Callable[None] | None
62
52
  :return: the loaded module or None on failure.
63
53
  """
64
54
 
@@ -71,12 +61,9 @@ def extensions_refresh(
71
61
  This should be called after extensions on the file-system have changed.
72
62
 
73
63
  :param ensure_wheels: When true, refresh installed wheels with wheels used by extensions.
74
- :type ensure_wheels: bool
75
64
  :param addon_modules_pending: Refresh these add-ons by listing their package names, as if they are enabled.
76
65
  This is needed so wheels can be setup before the add-on is enabled.
77
- :type addon_modules_pending: None | collections.abc.Sequence[str] | None
78
66
  :param handle_error: Called in the case of an error, taking an exception argument.
79
- :type handle_error: None | collections.abc.Callable[None] | None
80
67
  """
81
68
 
82
69
  def module_bl_info(mod, *, info_basis=None) -> None: ...
aud/__init__.pyi CHANGED
@@ -29,7 +29,6 @@ class AnimateableProperty:
29
29
  """Reads the properties value at the given position.
30
30
 
31
31
  :param position: The position in the animation in frames.
32
- :type position: float
33
32
  :return: A numpy array of values representing the properties value.
34
33
  """
35
34
 
@@ -37,9 +36,7 @@ class AnimateableProperty:
37
36
  """Reads the properties value at the given position, assuming there is exactly one value.
38
37
 
39
38
  :param position: The position in the animation in frames.
40
- :type position: float
41
39
  :return: The value at that position.
42
- :rtype: float
43
40
  """
44
41
 
45
42
  def write(self, data, position: int) -> None:
@@ -48,7 +45,6 @@ class AnimateableProperty:
48
45
 
49
46
  :param data: numpy array of float32 values.
50
47
  :param position: The starting position in frames.
51
- :type position: int
52
48
  """
53
49
 
54
50
  def writeConstantRange(self, data, position_start: int, position_end: int) -> None:
@@ -56,9 +52,7 @@ class AnimateableProperty:
56
52
 
57
53
  :param data: numpy array of float values representing the constant value.
58
54
  :param position_start: The start position in frames.
59
- :type position_start: int
60
55
  :param position_end: The end position in frames.
61
- :type position_end: int
62
56
  """
63
57
 
64
58
  class Device:
@@ -108,12 +102,9 @@ The speed of sound in air is typically 343.3 m/s."""
108
102
  """Plays a sound.
109
103
 
110
104
  :param sound: The sound to play.
111
- :type sound: Sound
112
105
  :param keep: See `Handle.keep`.
113
- :type keep: bool
114
106
  :return: The playback handle with which playback can be
115
107
  controlled with.
116
- :rtype: Handle
117
108
  """
118
109
 
119
110
  def stopAll(self) -> None:
@@ -149,43 +140,34 @@ class DynamicMusic:
149
140
  """Adds a new scene.
150
141
 
151
142
  :param scene: The scene sound.
152
- :type scene: Sound
153
143
  :return: The new scene id.
154
- :rtype: int
155
144
  """
156
145
 
157
146
  def addTransition(self, ini: int, end: int, transition: Sound) -> bool:
158
147
  """Adds a new scene.
159
148
 
160
149
  :param ini: the initial scene foor the transition.
161
- :type ini: int
162
150
  :param end: The final scene for the transition.
163
- :type end: int
164
151
  :param transition: The transition sound.
165
- :type transition: Sound
166
152
  :return: false if the ini or end scenes dont exist, true otherwise.
167
- :rtype: bool
168
153
  """
169
154
 
170
155
  def pause(self) -> bool:
171
156
  """Pauses playback of the scene.
172
157
 
173
158
  :return: Whether the action succeeded.
174
- :rtype: bool
175
159
  """
176
160
 
177
161
  def resume(self) -> bool:
178
162
  """Resumes playback of the scene.
179
163
 
180
164
  :return: Whether the action succeeded.
181
- :rtype: bool
182
165
  """
183
166
 
184
167
  def stop(self) -> bool:
185
168
  """Stops playback of the scene.
186
169
 
187
170
  :return: Whether the action succeeded.
188
- :rtype: bool
189
171
  """
190
172
 
191
173
  class HRTF:
@@ -195,20 +177,16 @@ class HRTF:
195
177
  """Loads all HRTFs from a directory.
196
178
 
197
179
  :param extension: The file extension of the hrtfs.
198
- :type extension: str
199
180
  :param directory: The path to where the HRTF files are located.
200
181
  :return: The loaded `HRTF` object.
201
- :rtype: typing_extensions.Self
202
182
  """
203
183
 
204
184
  def loadRightHrtfSet(self, extension: str, directory) -> typing_extensions.Self:
205
185
  """Loads all HRTFs from a directory.
206
186
 
207
187
  :param extension: The file extension of the hrtfs.
208
- :type extension: str
209
188
  :param directory: The path to where the HRTF files are located.
210
189
  :return: The loaded `HRTF` object.
211
- :rtype: typing_extensions.Self
212
190
  """
213
191
 
214
192
  def addImpulseResponseFromSound(
@@ -217,13 +195,9 @@ class HRTF:
217
195
  """Adds a new hrtf to the HRTF object
218
196
 
219
197
  :param sound: The sound that contains the hrtf.
220
- :type sound: Sound
221
198
  :param azimuth: The azimuth angle of the hrtf.
222
- :type azimuth: float
223
199
  :param elevation: The elevation angle of the hrtf.
224
- :type elevation: float
225
200
  :return: Whether the action succeeded.
226
- :rtype: bool
227
201
  """
228
202
 
229
203
  class Handle:
@@ -291,21 +265,18 @@ This can be used to seek the sound to some position and start playback again."""
291
265
  """Pauses playback.
292
266
 
293
267
  :return: Whether the action succeeded.
294
- :rtype: bool
295
268
  """
296
269
 
297
270
  def resume(self) -> bool:
298
271
  """Resumes playback.
299
272
 
300
273
  :return: Whether the action succeeded.
301
- :rtype: bool
302
274
  """
303
275
 
304
276
  def stop(self) -> bool:
305
277
  """Stops playback.
306
278
 
307
279
  :return: Whether the action succeeded.
308
- :rtype: bool
309
280
  """
310
281
 
311
282
  class ImpulseResponse:
@@ -318,9 +289,7 @@ class PlaybackManager:
318
289
  """Adds a category with a custom volume.
319
290
 
320
291
  :param volume: The volume for ther new category.
321
- :type volume: float
322
292
  :return: The key of the new category.
323
- :rtype: int
324
293
  """
325
294
 
326
295
  def clean(self) -> None:
@@ -330,59 +299,45 @@ class PlaybackManager:
330
299
  """Retrieves the volume of a category.
331
300
 
332
301
  :param catKey: the key of the category.
333
- :type catKey: int
334
302
  :return: The volume of the category.
335
- :rtype: float
336
303
  """
337
304
 
338
305
  def pause(self, catKey: int) -> bool:
339
306
  """Pauses playback of the category.
340
307
 
341
308
  :param catKey: the key of the category.
342
- :type catKey: int
343
309
  :return: Whether the action succeeded.
344
- :rtype: bool
345
310
  """
346
311
 
347
312
  def play(self, sound: Sound, catKey: int) -> Handle:
348
313
  """Plays a sound through the playback manager and assigns it to a category.
349
314
 
350
315
  :param sound: The sound to play.
351
- :type sound: Sound
352
316
  :param catKey: the key of the category in which the sound will be added,
353
317
  if it doesnt exist, a new one will be created.
354
- :type catKey: int
355
318
  :return: The playback handle with which playback can be controlled with.
356
- :rtype: Handle
357
319
  """
358
320
 
359
321
  def resume(self, catKey: int) -> bool:
360
322
  """Resumes playback of the catgory.
361
323
 
362
324
  :param catKey: the key of the category.
363
- :type catKey: int
364
325
  :return: Whether the action succeeded.
365
- :rtype: bool
366
326
  """
367
327
 
368
328
  def setVolume(self, volume: float, catKey: int) -> int:
369
329
  """Changes the volume of a category.
370
330
 
371
331
  :param volume: the new volume value.
372
- :type volume: float
373
332
  :param catKey: the key of the category.
374
- :type catKey: int
375
333
  :return: Whether the action succeeded.
376
- :rtype: int
377
334
  """
378
335
 
379
336
  def stop(self, catKey: int) -> bool:
380
337
  """Stops playback of the category.
381
338
 
382
339
  :param catKey: the key of the category.
383
- :type catKey: int
384
340
  :return: Whether the action succeeded.
385
- :rtype: bool
386
341
  """
387
342
 
388
343
  class Sequence:
@@ -415,7 +370,6 @@ The speed of sound in air is typically 343.3 m/s."""
415
370
  """Adds a new entry to the sequence.
416
371
 
417
372
  :return: The entry added.
418
- :rtype: SequenceEntry
419
373
  """
420
374
 
421
375
  def remove(self) -> None:
@@ -484,9 +438,7 @@ class Sound:
484
438
 
485
439
  :param data: The data as two dimensional numpy array.
486
440
  :param rate: The sample rate.
487
- :type rate: float
488
441
  :return: The created `Sound` object.
489
- :rtype: typing_extensions.Self
490
442
  """
491
443
 
492
444
  @classmethod
@@ -494,9 +446,7 @@ class Sound:
494
446
  """Creates a sound object of a sound file.
495
447
 
496
448
  :param filename: Path of the file.
497
- :type filename: str
498
449
  :return: The created `Sound` object.
499
- :rtype: typing_extensions.Self
500
450
  """
501
451
 
502
452
  @classmethod
@@ -504,7 +454,6 @@ class Sound:
504
454
  """Creates an empty sound list that can contain several sounds.
505
455
 
506
456
  :return: The created `Sound` object.
507
- :rtype: typing_extensions.Self
508
457
  """
509
458
 
510
459
  @classmethod
@@ -512,12 +461,9 @@ class Sound:
512
461
  """Creates a sawtooth sound which plays a sawtooth wave.
513
462
 
514
463
  :param frequency: The frequency of the sawtooth wave in Hz.
515
- :type frequency: float
516
464
  :param rate: The sampling rate in Hz. Its recommended to set this
517
465
  value to the playback devices sampling rate to avoid resampling.
518
- :type rate: int
519
466
  :return: The created `Sound` object.
520
- :rtype: typing_extensions.Self
521
467
  """
522
468
 
523
469
  @classmethod
@@ -526,9 +472,7 @@ class Sound:
526
472
 
527
473
  :param rate: The sampling rate in Hz. Its recommended to set this
528
474
  value to the playback devices sampling rate to avoid resampling.
529
- :type rate: int
530
475
  :return: The created `Sound` object.
531
- :rtype: typing_extensions.Self
532
476
  """
533
477
 
534
478
  @classmethod
@@ -536,12 +480,9 @@ class Sound:
536
480
  """Creates a sine sound which plays a sine wave.
537
481
 
538
482
  :param frequency: The frequency of the sine wave in Hz.
539
- :type frequency: float
540
483
  :param rate: The sampling rate in Hz. Its recommended to set this
541
484
  value to the playback devices sampling rate to avoid resampling.
542
- :type rate: int
543
485
  :return: The created `Sound` object.
544
- :rtype: typing_extensions.Self
545
486
  """
546
487
 
547
488
  @classmethod
@@ -549,12 +490,9 @@ class Sound:
549
490
  """Creates a square sound which plays a square wave.
550
491
 
551
492
  :param frequency: The frequency of the square wave in Hz.
552
- :type frequency: float
553
493
  :param rate: The sampling rate in Hz. Its recommended to set this
554
494
  value to the playback devices sampling rate to avoid resampling.
555
- :type rate: int
556
495
  :return: The created `Sound` object.
557
- :rtype: typing_extensions.Self
558
496
  """
559
497
 
560
498
  @classmethod
@@ -562,12 +500,9 @@ class Sound:
562
500
  """Creates a triangle sound which plays a triangle wave.
563
501
 
564
502
  :param frequency: The frequency of the triangle wave in Hz.
565
- :type frequency: float
566
503
  :param rate: The sampling rate in Hz. Its recommended to set this
567
504
  value to the playback devices sampling rate to avoid resampling.
568
- :type rate: int
569
505
  :return: The created `Sound` object.
570
- :rtype: typing_extensions.Self
571
506
  """
572
507
 
573
508
  def ADSR(
@@ -577,15 +512,10 @@ class Sound:
577
512
  Note: there is currently no way to trigger the release with this API.
578
513
 
579
514
  :param attack: The attack time in seconds.
580
- :type attack: float
581
515
  :param decay: The decay time in seconds.
582
- :type decay: float
583
516
  :param sustain: The sustain level.
584
- :type sustain: float
585
517
  :param release: The release level.
586
- :type release: float
587
518
  :return: The created `Sound` object.
588
- :rtype: typing_extensions.Self
589
519
  """
590
520
 
591
521
  def accumulate(self, additive=False) -> typing_extensions.Self:
@@ -596,14 +526,12 @@ class Sound:
596
526
 
597
527
  :param additive: Whether the accumulation should be additive or not.
598
528
  :return: The created `Sound` object.
599
- :rtype: typing_extensions.Self
600
529
  """
601
530
 
602
531
  def addSound(self, sound: typing_extensions.Self) -> None:
603
532
  """Adds a new sound to a sound list.
604
533
 
605
534
  :param sound: The sound that will be added to the list.
606
- :type sound: typing_extensions.Self
607
535
  """
608
536
 
609
537
  def animateableTimeStretchPitchScale(
@@ -617,24 +545,17 @@ class Sound:
617
545
  """Applies time-stretching and pitch-scaling to the sound.
618
546
 
619
547
  :param fps: The FPS of the animation system.
620
- :type fps: float
621
548
  :param time_stretch: The factor by which to stretch or compress time.
622
- :type time_stretch: float
623
549
  :param pitch_scale: The factor by which to adjust the pitch.
624
- :type pitch_scale: float
625
550
  :param quality:
626
- :type quality: int
627
551
  :param preserve_formant: Whether to preserve the vocal formants during pitch-shifting.
628
- :type preserve_formant: bool
629
552
  :return: The created `Sound` object.
630
- :rtype: typing_extensions.Self
631
553
  """
632
554
 
633
555
  def binaural(self) -> typing_extensions.Self:
634
556
  """Creates a binaural sound using another sound as source. The original sound must be mono
635
557
 
636
558
  :return: The created `Sound` object.
637
- :rtype: typing_extensions.Self
638
559
  """
639
560
 
640
561
  def cache(self) -> typing_extensions.Self:
@@ -643,14 +564,12 @@ class Sound:
643
564
  but it consumes a lot of memory.
644
565
 
645
566
  :return: The created `Sound` object.
646
- :rtype: typing_extensions.Self
647
567
  """
648
568
 
649
569
  def convolver(self) -> typing_extensions.Self:
650
570
  """Creates a sound that will apply convolution to another sound.
651
571
 
652
572
  :return: The created `Sound` object.
653
- :rtype: typing_extensions.Self
654
573
  """
655
574
 
656
575
  def data(self) -> None:
@@ -663,22 +582,16 @@ class Sound:
663
582
  """Delays by playing adding silence in front of the other sounds data.
664
583
 
665
584
  :param time: How many seconds of silence should be added before the sound.
666
- :type time: float
667
585
  :return: The created `Sound` object.
668
- :rtype: typing_extensions.Self
669
586
  """
670
587
 
671
588
  def Echo(self, delay: float, feedback: float, mix: float) -> typing_extensions.Self:
672
589
  """Adds Echo effect to the sound.
673
590
 
674
591
  :param delay: The delay time in seconds.
675
- :type delay: float
676
592
  :param feedback: The feedback amount (0.0 to 1.0).
677
- :type feedback: float
678
593
  :param mix: The wet/dry mix (0.0 to 1.0).
679
- :type mix: float
680
594
  :return: The created `Sound` object.
681
- :rtype: typing_extensions.Self
682
595
  """
683
596
 
684
597
  def envelope(
@@ -687,15 +600,10 @@ class Sound:
687
600
  """Delays by playing adding silence in front of the other sounds data.
688
601
 
689
602
  :param attack: The attack factor.
690
- :type attack: float
691
603
  :param release: The release factor.
692
- :type release: float
693
604
  :param threshold: The general threshold value.
694
- :type threshold: float
695
605
  :param arthreshold: The attack/release threshold value.
696
- :type arthreshold: float
697
606
  :return: The created `Sound` object.
698
- :rtype: typing_extensions.Self
699
607
  """
700
608
 
701
609
  def fadein(self, start: float, length: float) -> typing_extensions.Self:
@@ -703,11 +611,8 @@ class Sound:
703
611
  time interval.
704
612
 
705
613
  :param start: Time in seconds when the fading should start.
706
- :type start: float
707
614
  :param length: Time in seconds how long the fading should last.
708
- :type length: float
709
615
  :return: The created `Sound` object.
710
- :rtype: typing_extensions.Self
711
616
  """
712
617
 
713
618
  def fadeout(self, start: float, length: float) -> typing_extensions.Self:
@@ -715,11 +620,8 @@ class Sound:
715
620
  time interval.
716
621
 
717
622
  :param start: Time in seconds when the fading should start.
718
- :type start: float
719
623
  :param length: Time in seconds how long the fading should last.
720
- :type length: float
721
624
  :return: The created `Sound` object.
722
- :rtype: typing_extensions.Self
723
625
  """
724
626
 
725
627
  def filter(self, b: list[float], a: list[float] = (1)) -> typing_extensions.Self:
@@ -731,11 +633,8 @@ class Sound:
731
633
  in the end, you dont have to scale yourself.
732
634
 
733
635
  :param b: The nominator filter coefficients.
734
- :type b: list[float]
735
636
  :param a: The denominator filter coefficients.
736
- :type a: list[float]
737
637
  :return: The created `Sound` object.
738
- :rtype: typing_extensions.Self
739
638
  """
740
639
 
741
640
  def highpass(self, frequency: float, Q: float = 0.5) -> typing_extensions.Self:
@@ -743,31 +642,23 @@ class Sound:
743
642
  function H(s) = s^2 / (s^2 + s/Q + 1)
744
643
 
745
644
  :param frequency: The cut off trequency of the highpass.
746
- :type frequency: float
747
645
  :param Q: Q factor of the lowpass.
748
- :type Q: float
749
646
  :return: The created `Sound` object.
750
- :rtype: typing_extensions.Self
751
647
  """
752
648
 
753
649
  def join(self, sound: typing_extensions.Self) -> typing_extensions.Self:
754
650
  """Plays two factories in sequence.
755
651
 
756
652
  :param sound: The sound to play second.
757
- :type sound: typing_extensions.Self
758
653
  :return: The created `Sound` object.
759
- :rtype: typing_extensions.Self
760
654
  """
761
655
 
762
656
  def limit(self, start: float, end: float) -> typing_extensions.Self:
763
657
  """Limits a sound within a specific start and end time.
764
658
 
765
659
  :param start: Start time in seconds.
766
- :type start: float
767
660
  :param end: End time in seconds.
768
- :type end: float
769
661
  :return: The created `Sound` object.
770
- :rtype: typing_extensions.Self
771
662
  """
772
663
 
773
664
  def loop(self, count: int) -> typing_extensions.Self:
@@ -775,38 +666,29 @@ class Sound:
775
666
 
776
667
  :param count: How often the sound should be looped.
777
668
  Negative values mean endlessly.
778
- :type count: int
779
669
  :return: The created `Sound` object.
780
- :rtype: typing_extensions.Self
781
670
  """
782
671
 
783
672
  def lowpass(self, frequency: float, Q: float = 0.5) -> typing_extensions.Self:
784
673
  """Creates a second order lowpass filter based on the transfer function H(s) = 1 / (s^2 + s/Q + 1)
785
674
 
786
675
  :param frequency: The cut off trequency of the lowpass.
787
- :type frequency: float
788
676
  :param Q: Q factor of the lowpass.
789
- :type Q: float
790
677
  :return: The created `Sound` object.
791
- :rtype: typing_extensions.Self
792
678
  """
793
679
 
794
680
  def mix(self, sound: typing_extensions.Self) -> typing_extensions.Self:
795
681
  """Mixes two factories.
796
682
 
797
683
  :param sound: The sound to mix over the other.
798
- :type sound: typing_extensions.Self
799
684
  :return: The created `Sound` object.
800
- :rtype: typing_extensions.Self
801
685
  """
802
686
 
803
687
  def modulate(self, sound: typing_extensions.Self) -> typing_extensions.Self:
804
688
  """Modulates two factories.
805
689
 
806
690
  :param sound: The sound to modulate over the other.
807
- :type sound: typing_extensions.Self
808
691
  :return: The created `Sound` object.
809
- :rtype: typing_extensions.Self
810
692
  """
811
693
 
812
694
  def mutable(self) -> typing_extensions.Self:
@@ -814,7 +696,6 @@ class Sound:
814
696
  If the original sound is a sound list, the playing sound can change.
815
697
 
816
698
  :return: The created `Sound` object.
817
- :rtype: typing_extensions.Self
818
699
  """
819
700
 
820
701
  def pingpong(self) -> typing_extensions.Self:
@@ -822,50 +703,40 @@ class Sound:
822
703
  This is like joining a sound with its reverse.
823
704
 
824
705
  :return: The created `Sound` object.
825
- :rtype: typing_extensions.Self
826
706
  """
827
707
 
828
708
  def pitch(self, factor: float) -> typing_extensions.Self:
829
709
  """Changes the pitch of a sound with a specific factor.
830
710
 
831
711
  :param factor: The factor to change the pitch with.
832
- :type factor: float
833
712
  :return: The created `Sound` object.
834
- :rtype: typing_extensions.Self
835
713
  """
836
714
 
837
715
  def rechannel(self, channels: int) -> typing_extensions.Self:
838
716
  """Rechannels the sound.
839
717
 
840
718
  :param channels: The new channel configuration.
841
- :type channels: int
842
719
  :return: The created `Sound` object.
843
- :rtype: typing_extensions.Self
844
720
  """
845
721
 
846
722
  def resample(self, rate: float, quality: int) -> typing_extensions.Self:
847
723
  """Resamples the sound.
848
724
 
849
725
  :param rate: The new sample rate.
850
- :type rate: float
851
726
  :param quality: Resampler performance vs quality choice (0=fastest, 3=slowest).
852
- :type quality: int
853
727
  :return: The created `Sound` object.
854
- :rtype: typing_extensions.Self
855
728
  """
856
729
 
857
730
  def reverse(self) -> typing_extensions.Self:
858
731
  """Plays a sound reversed.
859
732
 
860
733
  :return: The created `Sound` object.
861
- :rtype: typing_extensions.Self
862
734
  """
863
735
 
864
736
  def sum(self) -> typing_extensions.Self:
865
737
  """Sums the samples of a sound.
866
738
 
867
739
  :return: The created `Sound` object.
868
- :rtype: typing_extensions.Self
869
740
  """
870
741
 
871
742
  def threshold(self, threshold: float = 0) -> typing_extensions.Self:
@@ -875,9 +746,7 @@ class Sound:
875
746
 
876
747
  :param threshold: Threshold value over which an amplitude counts
877
748
  non-zero.
878
- :type threshold: float
879
749
  :return: The created `Sound` object.
880
- :rtype: typing_extensions.Self
881
750
  """
882
751
 
883
752
  def timeStretchPitchScale(
@@ -890,24 +759,17 @@ class Sound:
890
759
  """Applies time-stretching and pitch-scaling to the sound.
891
760
 
892
761
  :param time_stretch: The factor by which to stretch or compress time.
893
- :type time_stretch: float
894
762
  :param pitch_scale: The factor by which to adjust the pitch.
895
- :type pitch_scale: float
896
763
  :param quality: Rubberband stretcher quality (STRETCHER_QUALITY_*).
897
- :type quality: int
898
764
  :param preserve_formant: Whether to preserve the vocal formants during pitch-shifting.
899
- :type preserve_formant: bool
900
765
  :return: The created `Sound` object.
901
- :rtype: typing_extensions.Self
902
766
  """
903
767
 
904
768
  def volume(self, volume: float) -> typing_extensions.Self:
905
769
  """Changes the volume of a sound.
906
770
 
907
771
  :param volume: The new volume..
908
- :type volume: float
909
772
  :return: The created `Sound` object.
910
- :rtype: typing_extensions.Self
911
773
  """
912
774
 
913
775
  def write(
@@ -924,21 +786,13 @@ class Sound:
924
786
  """Writes the sound to a file.
925
787
 
926
788
  :param filename: The path to write to.
927
- :type filename: str
928
789
  :param rate: The sample rate to write with.
929
- :type rate: int
930
790
  :param channels: The number of channels to write with.
931
- :type channels: int
932
791
  :param format: The sample format to write with.
933
- :type format: int
934
792
  :param container: The container format for the file.
935
- :type container: int
936
793
  :param codec: The codec to use in the file.
937
- :type codec: int
938
794
  :param bitrate: The bitrate to write with.
939
- :type bitrate: int
940
795
  :param buffersize: The size of the writing buffer.
941
- :type buffersize: int
942
796
  """
943
797
 
944
798
  class Source: