fake-bpy-module 20240915__py3-none-any.whl → 20240917__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.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- _bpy_internal/__init__.pyi +2 -2
- _bpy_internal/addons/__init__.pyi +2 -2
- _bpy_internal/addons/cli/__init__.pyi +2 -2
- _bpy_internal/extensions/__init__.pyi +2 -2
- _bpy_internal/extensions/junction_module/__init__.pyi +2 -8
- _bpy_internal/extensions/stale_file_manager/__init__.pyi +2 -6
- _bpy_internal/extensions/wheel_manager/__init__.pyi +2 -6
- _bpy_internal/freedesktop/__init__.pyi +2 -2
- _bpy_internal/grease_pencil/__init__.pyi +2 -2
- _bpy_internal/grease_pencil/stroke/__init__.pyi +2 -16
- _bpy_internal/system_info/__init__.pyi +2 -2
- _bpy_internal/system_info/text_generate_runtime/__init__.pyi +2 -2
- _bpy_internal/system_info/url_prefill_runtime/__init__.pyi +2 -2
- _bpy_internal/system_info/url_prefill_startup/__init__.pyi +2 -2
- addon_utils/__init__.pyi +2 -12
- animsys_refactor/__init__.pyi +2 -3
- aud/__init__.pyi +2 -71
- bgl/__init__.pyi +2 -526
- bl_app_override/__init__.pyi +2 -2
- bl_app_override/helpers/__init__.pyi +2 -2
- bl_app_template_utils/__init__.pyi +2 -4
- bl_console_utils/__init__.pyi +2 -2
- bl_console_utils/autocomplete/__init__.pyi +2 -2
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +2 -12
- bl_console_utils/autocomplete/complete_import/__init__.pyi +2 -8
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -12
- bl_console_utils/autocomplete/intellisense/__init__.pyi +2 -6
- bl_i18n_utils/__init__.pyi +2 -2
- bl_i18n_utils/bl_extract_messages/__init__.pyi +2 -6
- bl_i18n_utils/merge_po/__init__.pyi +2 -2
- bl_i18n_utils/settings/__init__.pyi +2 -6
- bl_i18n_utils/utils/__init__.pyi +2 -45
- bl_i18n_utils/utils_cli/__init__.pyi +2 -2
- bl_i18n_utils/utils_languages_menu/__init__.pyi +2 -2
- bl_i18n_utils/utils_rtl/__init__.pyi +2 -6
- bl_keymap_utils/__init__.pyi +2 -2
- bl_keymap_utils/io/__init__.pyi +2 -4
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -4
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +2 -2
- bl_keymap_utils/platform_helpers/__init__.pyi +2 -4
- bl_keymap_utils/versioning/__init__.pyi +2 -2
- bl_math/__init__.pyi +2 -8
- bl_operators/__init__.pyi +2 -2
- bl_operators/add_mesh_torus/__init__.pyi +2 -8
- bl_operators/anim/__init__.pyi +2 -48
- bl_operators/assets/__init__.pyi +2 -17
- bl_operators/bmesh/__init__.pyi +2 -2
- bl_operators/bmesh/find_adjacent/__init__.pyi +2 -6
- bl_operators/bone_selection_sets/__init__.pyi +2 -46
- bl_operators/clip/__init__.pyi +2 -43
- bl_operators/connect_to_output/__init__.pyi +2 -18
- bl_operators/console/__init__.pyi +2 -22
- bl_operators/constraint/__init__.pyi +2 -18
- bl_operators/file/__init__.pyi +2 -14
- bl_operators/freestyle/__init__.pyi +2 -19
- bl_operators/geometry_nodes/__init__.pyi +2 -21
- bl_operators/image/__init__.pyi +2 -19
- bl_operators/image_as_planes/__init__.pyi +2 -43
- bl_operators/mesh/__init__.pyi +2 -15
- bl_operators/node/__init__.pyi +2 -41
- bl_operators/node_editor/__init__.pyi +2 -2
- bl_operators/node_editor/node_functions/__init__.pyi +2 -3
- bl_operators/object/__init__.pyi +2 -63
- bl_operators/object_align/__init__.pyi +2 -6
- bl_operators/object_quick_effects/__init__.pyi +2 -18
- bl_operators/object_randomize_transform/__init__.pyi +2 -6
- bl_operators/presets/__init__.pyi +2 -70
- bl_operators/rigidbody/__init__.pyi +2 -15
- bl_operators/screen_play_rendered_anim/__init__.pyi +2 -5
- bl_operators/sequencer/__init__.pyi +2 -36
- bl_operators/spreadsheet/__init__.pyi +2 -8
- bl_operators/userpref/__init__.pyi +2 -93
- bl_operators/uvcalc_follow_active/__init__.pyi +2 -7
- bl_operators/uvcalc_lightmap/__init__.pyi +2 -11
- bl_operators/uvcalc_transform/__init__.pyi +2 -19
- bl_operators/vertexpaint_dirt/__init__.pyi +2 -6
- bl_operators/view3d/__init__.pyi +2 -37
- bl_operators/wm/__init__.pyi +2 -168
- bl_operators/world/__init__.pyi +2 -6
- bl_previews_utils/__init__.pyi +2 -2
- bl_previews_utils/bl_previews_render/__init__.pyi +2 -2
- bl_rna_utils/__init__.pyi +2 -2
- bl_rna_utils/data_path/__init__.pyi +2 -6
- bl_text_utils/__init__.pyi +2 -2
- bl_text_utils/external_editor/__init__.pyi +2 -2
- bl_ui/__init__.pyi +2 -11
- bl_ui/anim/__init__.pyi +2 -5
- bl_ui/asset_shelf/__init__.pyi +2 -6
- bl_ui/generic_ui_list/__init__.pyi +2 -16
- bl_ui/node_add_menu/__init__.pyi +2 -11
- bl_ui/node_add_menu_compositor/__init__.pyi +2 -53
- bl_ui/node_add_menu_geometry/__init__.pyi +2 -152
- bl_ui/node_add_menu_shader/__init__.pyi +2 -31
- bl_ui/node_add_menu_texture/__init__.pyi +2 -29
- bl_ui/properties_animviz/__init__.pyi +2 -4
- bl_ui/properties_collection/__init__.pyi +2 -20
- bl_ui/properties_constraint/__init__.pyi +2 -288
- bl_ui/properties_data_armature/__init__.pyi +2 -60
- bl_ui/properties_data_bone/__init__.pyi +2 -42
- bl_ui/properties_data_camera/__init__.pyi +2 -51
- bl_ui/properties_data_curve/__init__.pyi +2 -58
- bl_ui/properties_data_curves/__init__.pyi +2 -24
- bl_ui/properties_data_empty/__init__.pyi +2 -10
- bl_ui/properties_data_gpencil/__init__.pyi +2 -57
- bl_ui/properties_data_grease_pencil/__init__.pyi +2 -49
- bl_ui/properties_data_lattice/__init__.pyi +2 -14
- bl_ui/properties_data_light/__init__.pyi +2 -50
- bl_ui/properties_data_lightprobe/__init__.pyi +2 -48
- bl_ui/properties_data_mesh/__init__.pyi +2 -69
- bl_ui/properties_data_metaball/__init__.pyi +2 -20
- bl_ui/properties_data_modifier/__init__.pyi +2 -36
- bl_ui/properties_data_pointcloud/__init__.pyi +2 -19
- bl_ui/properties_data_shaderfx/__init__.pyi +2 -5
- bl_ui/properties_data_speaker/__init__.pyi +2 -19
- bl_ui/properties_data_volume/__init__.pyi +2 -29
- bl_ui/properties_freestyle/__init__.pyi +2 -98
- bl_ui/properties_grease_pencil_common/__init__.pyi +2 -74
- bl_ui/properties_mask_common/__init__.pyi +2 -37
- bl_ui/properties_material/__init__.pyi +2 -59
- bl_ui/properties_material_gpencil/__init__.pyi +2 -36
- bl_ui/properties_object/__init__.pyi +2 -52
- bl_ui/properties_output/__init__.pyi +2 -65
- bl_ui/properties_paint_common/__init__.pyi +2 -41
- bl_ui/properties_particle/__init__.pyi +2 -205
- bl_ui/properties_physics_cloth/__init__.pyi +2 -49
- bl_ui/properties_physics_common/__init__.pyi +2 -6
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +2 -103
- bl_ui/properties_physics_field/__init__.pyi +2 -44
- bl_ui/properties_physics_fluid/__init__.pyi +2 -134
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +2 -7
- bl_ui/properties_physics_rigidbody/__init__.pyi +2 -35
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2 -57
- bl_ui/properties_physics_softbody/__init__.pyi +2 -52
- bl_ui/properties_render/__init__.pyi +2 -220
- bl_ui/properties_scene/__init__.pyi +2 -55
- bl_ui/properties_texture/__init__.pyi +2 -93
- bl_ui/properties_view_layer/__init__.pyi +2 -47
- bl_ui/properties_workspace/__init__.pyi +2 -15
- bl_ui/properties_world/__init__.pyi +2 -42
- bl_ui/space_clip/__init__.pyi +2 -224
- bl_ui/space_console/__init__.pyi +2 -20
- bl_ui/space_dopesheet/__init__.pyi +2 -96
- bl_ui/space_filebrowser/__init__.pyi +2 -99
- bl_ui/space_graph/__init__.pyi +2 -62
- bl_ui/space_image/__init__.pyi +2 -211
- bl_ui/space_info/__init__.pyi +2 -20
- bl_ui/space_nla/__init__.pyi +2 -54
- bl_ui/space_node/__init__.pyi +2 -100
- bl_ui/space_outliner/__init__.pyi +2 -48
- bl_ui/space_properties/__init__.pyi +2 -14
- bl_ui/space_sequencer/__init__.pyi +2 -280
- bl_ui/space_spreadsheet/__init__.pyi +2 -11
- bl_ui/space_statusbar/__init__.pyi +2 -5
- bl_ui/space_text/__init__.pyi +2 -51
- bl_ui/space_time/__init__.pyi +2 -27
- bl_ui/space_toolsystem_common/__init__.pyi +3 -13
- bl_ui/space_toolsystem_toolbar/__init__.pyi +7 -126
- bl_ui/space_topbar/__init__.pyi +37 -86
- bl_ui/space_userpref/__init__.pyi +2 -313
- bl_ui/space_view3d/__init__.pyi +30 -881
- bl_ui/space_view3d_toolbar/__init__.pyi +2 -344
- bl_ui/utils/__init__.pyi +2 -5
- bl_ui_utils/__init__.pyi +2 -2
- bl_ui_utils/layout/__init__.pyi +2 -4
- blend_render_info/__init__.pyi +2 -4
- blf/__init__.pyi +2 -32
- bmesh/__init__.pyi +2 -8
- bmesh/geometry/__init__.pyi +2 -4
- bmesh/ops/__init__.pyi +2 -162
- bmesh/types/__init__.pyi +19 -133
- bmesh/utils/__init__.pyi +2 -28
- bpy/__init__.pyi +2 -2
- bpy/app/__init__.pyi +2 -6
- bpy/app/handlers/__init__.pyi +2 -2
- bpy/app/icons/__init__.pyi +2 -8
- bpy/app/timers/__init__.pyi +2 -8
- bpy/app/translations/__init__.pyi +2 -20
- bpy/msgbus/__init__.pyi +2 -8
- bpy/ops/__init__.pyi +2 -2
- bpy/ops/action/__init__.pyi +15 -110
- bpy/ops/anim/__init__.pyi +2 -118
- bpy/ops/armature/__init__.pyi +2 -98
- bpy/ops/asset/__init__.pyi +2 -34
- bpy/ops/boid/__init__.pyi +5 -30
- bpy/ops/brush/__init__.pyi +5 -31
- bpy/ops/buttons/__init__.pyi +2 -14
- bpy/ops/cachefile/__init__.pyi +2 -12
- bpy/ops/camera/__init__.pyi +2 -6
- bpy/ops/clip/__init__.pyi +5 -188
- bpy/ops/cloth/__init__.pyi +2 -4
- bpy/ops/collection/__init__.pyi +2 -20
- bpy/ops/console/__init__.pyi +2 -44
- bpy/ops/constraint/__init__.pyi +2 -38
- bpy/ops/curve/__init__.pyi +7 -143
- bpy/ops/curves/__init__.pyi +11 -64
- bpy/ops/cycles/__init__.pyi +2 -8
- bpy/ops/dpaint/__init__.pyi +5 -14
- bpy/ops/ed/__init__.pyi +2 -26
- bpy/ops/export_anim/__init__.pyi +2 -4
- bpy/ops/export_scene/__init__.pyi +2 -6
- bpy/ops/extensions/__init__.pyi +2 -70
- bpy/ops/file/__init__.pyi +2 -82
- bpy/ops/fluid/__init__.pyi +2 -30
- bpy/ops/font/__init__.pyi +2 -48
- bpy/ops/geometry/__init__.pyi +21 -75
- bpy/ops/gizmogroup/__init__.pyi +2 -6
- bpy/ops/gpencil/__init__.pyi +2 -286
- bpy/ops/graph/__init__.pyi +19 -213
- bpy/ops/grease_pencil/__init__.pyi +9 -196
- bpy/ops/image/__init__.pyi +11 -111
- bpy/ops/import_anim/__init__.pyi +2 -4
- bpy/ops/import_curve/__init__.pyi +2 -4
- bpy/ops/import_scene/__init__.pyi +2 -6
- bpy/ops/info/__init__.pyi +2 -16
- bpy/ops/lattice/__init__.pyi +5 -20
- bpy/ops/marker/__init__.pyi +2 -24
- bpy/ops/mask/__init__.pyi +2 -80
- bpy/ops/material/__init__.pyi +2 -8
- bpy/ops/mball/__init__.pyi +2 -18
- bpy/ops/mesh/__init__.pyi +45 -467
- bpy/ops/nla/__init__.pyi +5 -92
- bpy/ops/node/__init__.pyi +5 -215
- bpy/ops/object/__init__.pyi +73 -870
- bpy/ops/outliner/__init__.pyi +7 -200
- bpy/ops/paint/__init__.pyi +9 -116
- bpy/ops/paintcurve/__init__.pyi +2 -18
- bpy/ops/palette/__init__.pyi +2 -16
- bpy/ops/particle/__init__.pyi +2 -74
- bpy/ops/pose/__init__.pyi +15 -180
- bpy/ops/poselib/__init__.pyi +2 -20
- bpy/ops/preferences/__init__.pyi +2 -72
- bpy/ops/ptcache/__init__.pyi +2 -16
- bpy/ops/render/__init__.pyi +2 -28
- bpy/ops/rigidbody/__init__.pyi +11 -56
- bpy/ops/scene/__init__.pyi +11 -131
- bpy/ops/screen/__init__.pyi +9 -142
- bpy/ops/script/__init__.pyi +2 -8
- bpy/ops/sculpt/__init__.pyi +2 -74
- bpy/ops/sculpt_curves/__init__.pyi +2 -10
- bpy/ops/sequencer/__init__.pyi +5 -194
- bpy/ops/sound/__init__.pyi +5 -21
- bpy/ops/spreadsheet/__init__.pyi +2 -10
- bpy/ops/surface/__init__.pyi +2 -14
- bpy/ops/text/__init__.pyi +2 -88
- bpy/ops/text_editor/__init__.pyi +2 -4
- bpy/ops/texture/__init__.pyi +2 -10
- bpy/ops/transform/__init__.pyi +75 -400
- bpy/ops/ui/__init__.pyi +2 -68
- bpy/ops/uilist/__init__.pyi +2 -8
- bpy/ops/uv/__init__.pyi +5 -102
- bpy/ops/view2d/__init__.pyi +2 -30
- bpy/ops/view3d/__init__.pyi +2 -136
- bpy/ops/wm/__init__.pyi +17 -259
- bpy/ops/workspace/__init__.pyi +2 -16
- bpy/ops/world/__init__.pyi +2 -6
- bpy/path/__init__.pyi +2 -28
- bpy/props/__init__.pyi +2 -24
- bpy/types/__init__.pyi +1230 -31631
- bpy/typing/__init__.pyi +2490 -0
- bpy/utils/__init__.pyi +4 -74
- bpy/utils/previews/__init__.pyi +2 -10
- bpy/utils/units/__init__.pyi +2 -6
- bpy_extras/__init__.pyi +2 -2
- bpy_extras/anim_utils/__init__.pyi +2 -17
- bpy_extras/asset_utils/__init__.pyi +2 -5
- bpy_extras/bmesh_utils/__init__.pyi +2 -4
- bpy_extras/id_map_utils/__init__.pyi +2 -8
- bpy_extras/image_utils/__init__.pyi +2 -4
- bpy_extras/io_utils/__init__.pyi +2 -23
- bpy_extras/keyconfig_utils/__init__.pyi +2 -6
- bpy_extras/mesh_utils/__init__.pyi +2 -16
- bpy_extras/node_shader_utils/__init__.pyi +2 -23
- bpy_extras/node_utils/__init__.pyi +2 -6
- bpy_extras/object_utils/__init__.pyi +2 -15
- bpy_extras/view3d_utils/__init__.pyi +2 -10
- bpy_extras/wm_utils/__init__.pyi +2 -2
- bpy_extras/wm_utils/progress_report/__init__.pyi +2 -10
- bpy_restrict_state/__init__.pyi +2 -2
- bpy_types/__init__.pyi +2 -5
- console_python/__init__.pyi +2 -4
- console_shell/__init__.pyi +2 -2
- {fake_bpy_module-20240915.dist-info → fake_bpy_module-20240917.dist-info}/METADATA +1 -1
- fake_bpy_module-20240917.dist-info/RECORD +365 -0
- {fake_bpy_module-20240915.dist-info → fake_bpy_module-20240917.dist-info}/WHEEL +1 -1
- freestyle/__init__.pyi +2 -2
- freestyle/chainingiterators/__init__.pyi +2 -25
- freestyle/functions/__init__.pyi +2 -109
- freestyle/predicates/__init__.pyi +2 -30
- freestyle/shaders/__init__.pyi +2 -77
- freestyle/types/__init__.pyi +2 -192
- freestyle/utils/ContextFunctions/__init__.pyi +2 -20
- freestyle/utils/__init__.pyi +4 -50
- gpu/__init__.pyi +2 -2
- gpu/capabilities/__init__.pyi +2 -40
- gpu/matrix/__init__.pyi +2 -36
- gpu/platform/__init__.pyi +2 -12
- gpu/select/__init__.pyi +2 -4
- gpu/shader/__init__.pyi +2 -8
- gpu/state/__init__.pyi +5 -45
- gpu/texture/__init__.pyi +2 -4
- gpu/types/__init__.pyi +2 -54
- gpu_extras/__init__.pyi +2 -2
- gpu_extras/batch/__init__.pyi +2 -4
- gpu_extras/presets/__init__.pyi +2 -6
- graphviz_export/__init__.pyi +2 -2
- idprop/__init__.pyi +2 -2
- idprop/types/__init__.pyi +2 -11
- imbuf/__init__.pyi +2 -8
- imbuf/types/__init__.pyi +2 -6
- keyingsets_builtins/__init__.pyi +2 -70
- keyingsets_utils/__init__.pyi +2 -2
- mathutils/__init__.pyi +38 -228
- mathutils/bvhtree/__init__.pyi +2 -10
- mathutils/geometry/__init__.pyi +2 -54
- mathutils/interpolate/__init__.pyi +2 -4
- mathutils/kdtree/__init__.pyi +2 -8
- mathutils/noise/__init__.pyi +2 -36
- nodeitems_builtins/__init__.pyi +2 -4
- nodeitems_utils/__init__.pyi +2 -4
- rna_info/__init__.pyi +2 -7
- rna_keymap_ui/__init__.pyi +2 -2
- rna_prop_ui/__init__.pyi +2 -6
- rna_xml/__init__.pyi +2 -2
- fake_bpy_module-20240915.dist-info/RECORD +0 -364
- {fake_bpy_module-20240915.dist-info → fake_bpy_module-20240917.dist-info}/top_level.txt +0 -0
aud/__init__.pyi
CHANGED
|
@@ -15,8 +15,8 @@ import typing
|
|
|
15
15
|
import collections.abc
|
|
16
16
|
import typing_extensions
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
_GenericType1 = typing.TypeVar("_GenericType1")
|
|
19
|
+
_GenericType2 = typing.TypeVar("_GenericType2")
|
|
20
20
|
|
|
21
21
|
class Device:
|
|
22
22
|
"""Device objects represent an audio output backend like OpenAL or SDL, but might also represent a file output or RAM buffer output."""
|
|
@@ -60,7 +60,6 @@ The speed of sound in air is typically 343.3 m/s."""
|
|
|
60
60
|
sounds at the same time.
|
|
61
61
|
|
|
62
62
|
"""
|
|
63
|
-
...
|
|
64
63
|
|
|
65
64
|
def play(self, sound: Sound, keep: bool = False) -> Handle:
|
|
66
65
|
"""Plays a sound.
|
|
@@ -73,18 +72,15 @@ The speed of sound in air is typically 343.3 m/s."""
|
|
|
73
72
|
controlled with.
|
|
74
73
|
:rtype: Handle
|
|
75
74
|
"""
|
|
76
|
-
...
|
|
77
75
|
|
|
78
76
|
def stopAll(self):
|
|
79
77
|
"""Stops all playing and paused sounds."""
|
|
80
|
-
...
|
|
81
78
|
|
|
82
79
|
def unlock(self):
|
|
83
80
|
"""Unlocks the device after a lock call, see `lock` for
|
|
84
81
|
details.
|
|
85
82
|
|
|
86
83
|
"""
|
|
87
|
-
...
|
|
88
84
|
|
|
89
85
|
class DynamicMusic:
|
|
90
86
|
"""The DynamicMusic object allows to play music depending on a current scene, scene changes are managed by the class, with the possibility of custom transitions.
|
|
@@ -114,7 +110,6 @@ class DynamicMusic:
|
|
|
114
110
|
:return: The new scene id.
|
|
115
111
|
:rtype: int
|
|
116
112
|
"""
|
|
117
|
-
...
|
|
118
113
|
|
|
119
114
|
def addTransition(self, ini: int, end: int, transition: Sound) -> bool:
|
|
120
115
|
"""Adds a new scene.
|
|
@@ -128,7 +123,6 @@ class DynamicMusic:
|
|
|
128
123
|
:return: false if the ini or end scenes don't exist, true othrwise.
|
|
129
124
|
:rtype: bool
|
|
130
125
|
"""
|
|
131
|
-
...
|
|
132
126
|
|
|
133
127
|
def pause(self) -> bool:
|
|
134
128
|
"""Pauses playback of the scene.
|
|
@@ -136,7 +130,6 @@ class DynamicMusic:
|
|
|
136
130
|
:return: Whether the action succeeded.
|
|
137
131
|
:rtype: bool
|
|
138
132
|
"""
|
|
139
|
-
...
|
|
140
133
|
|
|
141
134
|
def resume(self) -> bool:
|
|
142
135
|
"""Resumes playback of the scene.
|
|
@@ -144,7 +137,6 @@ class DynamicMusic:
|
|
|
144
137
|
:return: Whether the action succeeded.
|
|
145
138
|
:rtype: bool
|
|
146
139
|
"""
|
|
147
|
-
...
|
|
148
140
|
|
|
149
141
|
def stop(self) -> bool:
|
|
150
142
|
"""Stops playback of the scene.
|
|
@@ -152,7 +144,6 @@ class DynamicMusic:
|
|
|
152
144
|
:return: Whether the action succeeded.
|
|
153
145
|
:rtype: bool
|
|
154
146
|
"""
|
|
155
|
-
...
|
|
156
147
|
|
|
157
148
|
class HRTF:
|
|
158
149
|
"""An HRTF object represents a set of head related transfer functions as impulse responses. It's used for binaural sound"""
|
|
@@ -166,7 +157,6 @@ class HRTF:
|
|
|
166
157
|
:return: The loaded `HRTF` object.
|
|
167
158
|
:rtype: typing_extensions.Self
|
|
168
159
|
"""
|
|
169
|
-
...
|
|
170
160
|
|
|
171
161
|
def loadRightHrtfSet(self, extension: str, directory) -> typing_extensions.Self:
|
|
172
162
|
"""Loads all HRTFs from a directory.
|
|
@@ -177,7 +167,6 @@ class HRTF:
|
|
|
177
167
|
:return: The loaded `HRTF` object.
|
|
178
168
|
:rtype: typing_extensions.Self
|
|
179
169
|
"""
|
|
180
|
-
...
|
|
181
170
|
|
|
182
171
|
def addImpulseResponseFromSound(
|
|
183
172
|
self, sound: Sound, azimuth: float, elevation: float
|
|
@@ -193,7 +182,6 @@ class HRTF:
|
|
|
193
182
|
:return: Whether the action succeeded.
|
|
194
183
|
:rtype: bool
|
|
195
184
|
"""
|
|
196
|
-
...
|
|
197
185
|
|
|
198
186
|
class Handle:
|
|
199
187
|
"""Handle objects are playback handles that can be used to control playback of a sound. If a sound is played back multiple times then there are as many handles."""
|
|
@@ -262,7 +250,6 @@ This can be used to seek the sound to some position and start playback again."""
|
|
|
262
250
|
:return: Whether the action succeeded.
|
|
263
251
|
:rtype: bool
|
|
264
252
|
"""
|
|
265
|
-
...
|
|
266
253
|
|
|
267
254
|
def resume(self) -> bool:
|
|
268
255
|
"""Resumes playback.
|
|
@@ -270,7 +257,6 @@ This can be used to seek the sound to some position and start playback again."""
|
|
|
270
257
|
:return: Whether the action succeeded.
|
|
271
258
|
:rtype: bool
|
|
272
259
|
"""
|
|
273
|
-
...
|
|
274
260
|
|
|
275
261
|
def stop(self) -> bool:
|
|
276
262
|
"""Stops playback.
|
|
@@ -278,13 +264,10 @@ This can be used to seek the sound to some position and start playback again."""
|
|
|
278
264
|
:return: Whether the action succeeded.
|
|
279
265
|
:rtype: bool
|
|
280
266
|
"""
|
|
281
|
-
...
|
|
282
267
|
|
|
283
268
|
class ImpulseResponse:
|
|
284
269
|
"""An ImpulseResponse object represents a filter with which to convolve a sound."""
|
|
285
270
|
|
|
286
|
-
...
|
|
287
|
-
|
|
288
271
|
class PlaybackManager:
|
|
289
272
|
"""A PlabackManager object allows to easily control groups os sounds organized in categories."""
|
|
290
273
|
|
|
@@ -296,11 +279,9 @@ class PlaybackManager:
|
|
|
296
279
|
:return: The key of the new category.
|
|
297
280
|
:rtype: int
|
|
298
281
|
"""
|
|
299
|
-
...
|
|
300
282
|
|
|
301
283
|
def clean(self):
|
|
302
284
|
"""Cleans all the invalid and finished sound from the playback manager."""
|
|
303
|
-
...
|
|
304
285
|
|
|
305
286
|
def getVolume(self, catKey: int) -> float:
|
|
306
287
|
"""Retrieves the volume of a category.
|
|
@@ -310,7 +291,6 @@ class PlaybackManager:
|
|
|
310
291
|
:return: The volume of the cateogry.
|
|
311
292
|
:rtype: float
|
|
312
293
|
"""
|
|
313
|
-
...
|
|
314
294
|
|
|
315
295
|
def pause(self, catKey: int) -> bool:
|
|
316
296
|
"""Pauses playback of the category.
|
|
@@ -320,7 +300,6 @@ class PlaybackManager:
|
|
|
320
300
|
:return: Whether the action succeeded.
|
|
321
301
|
:rtype: bool
|
|
322
302
|
"""
|
|
323
|
-
...
|
|
324
303
|
|
|
325
304
|
def play(self, sound: Sound, catKey: int) -> Handle:
|
|
326
305
|
"""Plays a sound through the playback manager and assigns it to a category.
|
|
@@ -333,7 +312,6 @@ class PlaybackManager:
|
|
|
333
312
|
:return: The playback handle with which playback can be controlled with.
|
|
334
313
|
:rtype: Handle
|
|
335
314
|
"""
|
|
336
|
-
...
|
|
337
315
|
|
|
338
316
|
def resume(self, catKey: int) -> bool:
|
|
339
317
|
"""Resumes playback of the catgory.
|
|
@@ -343,7 +321,6 @@ class PlaybackManager:
|
|
|
343
321
|
:return: Whether the action succeeded.
|
|
344
322
|
:rtype: bool
|
|
345
323
|
"""
|
|
346
|
-
...
|
|
347
324
|
|
|
348
325
|
def setVolume(self, volume: float, catKey: int) -> int:
|
|
349
326
|
"""Changes the volume of a category.
|
|
@@ -355,7 +332,6 @@ class PlaybackManager:
|
|
|
355
332
|
:return: Whether the action succeeded.
|
|
356
333
|
:rtype: int
|
|
357
334
|
"""
|
|
358
|
-
...
|
|
359
335
|
|
|
360
336
|
def stop(self, catKey: int) -> bool:
|
|
361
337
|
"""Stops playback of the category.
|
|
@@ -365,7 +341,6 @@ class PlaybackManager:
|
|
|
365
341
|
:return: Whether the action succeeded.
|
|
366
342
|
:rtype: bool
|
|
367
343
|
"""
|
|
368
|
-
...
|
|
369
344
|
|
|
370
345
|
class Sequence:
|
|
371
346
|
"""This sound represents sequenced entries to play a sound sequence."""
|
|
@@ -399,15 +374,12 @@ The speed of sound in air is typically 343.3 m/s."""
|
|
|
399
374
|
:return: The entry added.
|
|
400
375
|
:rtype: SequenceEntry
|
|
401
376
|
"""
|
|
402
|
-
...
|
|
403
377
|
|
|
404
378
|
def remove(self):
|
|
405
379
|
"""Removes an entry from the sequence."""
|
|
406
|
-
...
|
|
407
380
|
|
|
408
381
|
def setAnimationData(self):
|
|
409
382
|
"""Writes animation data to a sequence."""
|
|
410
|
-
...
|
|
411
383
|
|
|
412
384
|
class SequenceEntry:
|
|
413
385
|
"""SequenceEntry objects represent an entry of a sequenced sound."""
|
|
@@ -450,11 +422,9 @@ At this distance the volume will be exactly `volume`.:attr:`Device.distance_mode
|
|
|
450
422
|
|
|
451
423
|
def move(self):
|
|
452
424
|
"""Moves the entry."""
|
|
453
|
-
...
|
|
454
425
|
|
|
455
426
|
def setAnimationData(self):
|
|
456
427
|
"""Writes animation data to a sequenced entry."""
|
|
457
|
-
...
|
|
458
428
|
|
|
459
429
|
class Sound:
|
|
460
430
|
"""Sound objects are immutable and represent a sound that can be played simultaneously multiple times. They are called factories because they create reader objects internally that are used for playback."""
|
|
@@ -475,7 +445,6 @@ class Sound:
|
|
|
475
445
|
:return: The created `Sound` object.
|
|
476
446
|
:rtype: typing_extensions.Self
|
|
477
447
|
"""
|
|
478
|
-
...
|
|
479
448
|
|
|
480
449
|
@classmethod
|
|
481
450
|
def file(cls, filename: str) -> typing_extensions.Self:
|
|
@@ -486,7 +455,6 @@ class Sound:
|
|
|
486
455
|
:return: The created `Sound` object.
|
|
487
456
|
:rtype: typing_extensions.Self
|
|
488
457
|
"""
|
|
489
|
-
...
|
|
490
458
|
|
|
491
459
|
@classmethod
|
|
492
460
|
def list(cls) -> typing_extensions.Self:
|
|
@@ -495,7 +463,6 @@ class Sound:
|
|
|
495
463
|
:return: The created `Sound` object.
|
|
496
464
|
:rtype: typing_extensions.Self
|
|
497
465
|
"""
|
|
498
|
-
...
|
|
499
466
|
|
|
500
467
|
@classmethod
|
|
501
468
|
def sawtooth(cls, frequency: float, rate: int = 48000) -> typing_extensions.Self:
|
|
@@ -509,7 +476,6 @@ class Sound:
|
|
|
509
476
|
:return: The created `Sound` object.
|
|
510
477
|
:rtype: typing_extensions.Self
|
|
511
478
|
"""
|
|
512
|
-
...
|
|
513
479
|
|
|
514
480
|
@classmethod
|
|
515
481
|
def silence(cls, rate: int = 48000) -> typing_extensions.Self:
|
|
@@ -521,7 +487,6 @@ class Sound:
|
|
|
521
487
|
:return: The created `Sound` object.
|
|
522
488
|
:rtype: typing_extensions.Self
|
|
523
489
|
"""
|
|
524
|
-
...
|
|
525
490
|
|
|
526
491
|
@classmethod
|
|
527
492
|
def sine(cls, frequency: float, rate: int = 48000) -> typing_extensions.Self:
|
|
@@ -535,7 +500,6 @@ class Sound:
|
|
|
535
500
|
:return: The created `Sound` object.
|
|
536
501
|
:rtype: typing_extensions.Self
|
|
537
502
|
"""
|
|
538
|
-
...
|
|
539
503
|
|
|
540
504
|
@classmethod
|
|
541
505
|
def square(cls, frequency: float, rate: int = 48000) -> typing_extensions.Self:
|
|
@@ -549,7 +513,6 @@ class Sound:
|
|
|
549
513
|
:return: The created `Sound` object.
|
|
550
514
|
:rtype: typing_extensions.Self
|
|
551
515
|
"""
|
|
552
|
-
...
|
|
553
516
|
|
|
554
517
|
@classmethod
|
|
555
518
|
def triangle(cls, frequency: float, rate: int = 48000) -> typing_extensions.Self:
|
|
@@ -563,7 +526,6 @@ class Sound:
|
|
|
563
526
|
:return: The created `Sound` object.
|
|
564
527
|
:rtype: typing_extensions.Self
|
|
565
528
|
"""
|
|
566
|
-
...
|
|
567
529
|
|
|
568
530
|
def ADSR(
|
|
569
531
|
self, attack: float, decay: float, sustain: float, release: float
|
|
@@ -582,7 +544,6 @@ class Sound:
|
|
|
582
544
|
:return: The created `Sound` object.
|
|
583
545
|
:rtype: typing_extensions.Self
|
|
584
546
|
"""
|
|
585
|
-
...
|
|
586
547
|
|
|
587
548
|
def accumulate(self, additive=False) -> typing_extensions.Self:
|
|
588
549
|
"""Accumulates a sound by summing over positive input
|
|
@@ -594,7 +555,6 @@ class Sound:
|
|
|
594
555
|
:return: The created `Sound` object.
|
|
595
556
|
:rtype: typing_extensions.Self
|
|
596
557
|
"""
|
|
597
|
-
...
|
|
598
558
|
|
|
599
559
|
def addSound(self, sound: typing_extensions.Self):
|
|
600
560
|
"""Adds a new sound to a sound list.
|
|
@@ -602,7 +562,6 @@ class Sound:
|
|
|
602
562
|
:param sound: The sound that will be added to the list.
|
|
603
563
|
:type sound: typing_extensions.Self
|
|
604
564
|
"""
|
|
605
|
-
...
|
|
606
565
|
|
|
607
566
|
def binaural(self) -> typing_extensions.Self:
|
|
608
567
|
"""Creates a binaural sound using another sound as source. The original sound must be mono
|
|
@@ -610,7 +569,6 @@ class Sound:
|
|
|
610
569
|
:return: The created `Sound` object.
|
|
611
570
|
:rtype: typing_extensions.Self
|
|
612
571
|
"""
|
|
613
|
-
...
|
|
614
572
|
|
|
615
573
|
def cache(self) -> typing_extensions.Self:
|
|
616
574
|
"""Caches a sound into RAM.This saves CPU usage needed for decoding and file access if the
|
|
@@ -620,7 +578,6 @@ class Sound:
|
|
|
620
578
|
:return: The created `Sound` object.
|
|
621
579
|
:rtype: typing_extensions.Self
|
|
622
580
|
"""
|
|
623
|
-
...
|
|
624
581
|
|
|
625
582
|
def convolver(self) -> typing_extensions.Self:
|
|
626
583
|
"""Creates a sound that will apply convolution to another sound.
|
|
@@ -628,14 +585,12 @@ class Sound:
|
|
|
628
585
|
:return: The created `Sound` object.
|
|
629
586
|
:rtype: typing_extensions.Self
|
|
630
587
|
"""
|
|
631
|
-
...
|
|
632
588
|
|
|
633
589
|
def data(self):
|
|
634
590
|
"""Retrieves the data of the sound as numpy array.
|
|
635
591
|
|
|
636
592
|
:return: A two dimensional numpy float array.
|
|
637
593
|
"""
|
|
638
|
-
...
|
|
639
594
|
|
|
640
595
|
def delay(self, time: float) -> typing_extensions.Self:
|
|
641
596
|
"""Delays by playing adding silence in front of the other sound's data.
|
|
@@ -645,7 +600,6 @@ class Sound:
|
|
|
645
600
|
:return: The created `Sound` object.
|
|
646
601
|
:rtype: typing_extensions.Self
|
|
647
602
|
"""
|
|
648
|
-
...
|
|
649
603
|
|
|
650
604
|
def envelope(
|
|
651
605
|
self, attack: float, release: float, threshold: float, arthreshold: float
|
|
@@ -663,7 +617,6 @@ class Sound:
|
|
|
663
617
|
:return: The created `Sound` object.
|
|
664
618
|
:rtype: typing_extensions.Self
|
|
665
619
|
"""
|
|
666
|
-
...
|
|
667
620
|
|
|
668
621
|
def fadein(self, start: float, length: float) -> typing_extensions.Self:
|
|
669
622
|
"""Fades a sound in by raising the volume linearly in the given
|
|
@@ -676,7 +629,6 @@ class Sound:
|
|
|
676
629
|
:return: The created `Sound` object.
|
|
677
630
|
:rtype: typing_extensions.Self
|
|
678
631
|
"""
|
|
679
|
-
...
|
|
680
632
|
|
|
681
633
|
def fadeout(self, start: float, length: float) -> typing_extensions.Self:
|
|
682
634
|
"""Fades a sound in by lowering the volume linearly in the given
|
|
@@ -689,7 +641,6 @@ class Sound:
|
|
|
689
641
|
:return: The created `Sound` object.
|
|
690
642
|
:rtype: typing_extensions.Self
|
|
691
643
|
"""
|
|
692
|
-
...
|
|
693
644
|
|
|
694
645
|
def filter(self, b: list[float], a: list[float] = 1) -> typing_extensions.Self:
|
|
695
646
|
"""Filters a sound with the supplied IIR filter coefficients.
|
|
@@ -706,7 +657,6 @@ class Sound:
|
|
|
706
657
|
:return: The created `Sound` object.
|
|
707
658
|
:rtype: typing_extensions.Self
|
|
708
659
|
"""
|
|
709
|
-
...
|
|
710
660
|
|
|
711
661
|
def highpass(self, frequency: float, Q: float = 0.5) -> typing_extensions.Self:
|
|
712
662
|
"""Creates a second order highpass filter based on the transfer
|
|
@@ -719,7 +669,6 @@ class Sound:
|
|
|
719
669
|
:return: The created `Sound` object.
|
|
720
670
|
:rtype: typing_extensions.Self
|
|
721
671
|
"""
|
|
722
|
-
...
|
|
723
672
|
|
|
724
673
|
def join(self, sound: typing_extensions.Self) -> typing_extensions.Self:
|
|
725
674
|
"""Plays two factories in sequence.
|
|
@@ -729,7 +678,6 @@ class Sound:
|
|
|
729
678
|
:return: The created `Sound` object.
|
|
730
679
|
:rtype: typing_extensions.Self
|
|
731
680
|
"""
|
|
732
|
-
...
|
|
733
681
|
|
|
734
682
|
def limit(self, start: float, end: float) -> typing_extensions.Self:
|
|
735
683
|
"""Limits a sound within a specific start and end time.
|
|
@@ -741,7 +689,6 @@ class Sound:
|
|
|
741
689
|
:return: The created `Sound` object.
|
|
742
690
|
:rtype: typing_extensions.Self
|
|
743
691
|
"""
|
|
744
|
-
...
|
|
745
692
|
|
|
746
693
|
def loop(self, count: int) -> typing_extensions.Self:
|
|
747
694
|
"""Loops a sound.
|
|
@@ -752,7 +699,6 @@ class Sound:
|
|
|
752
699
|
:return: The created `Sound` object.
|
|
753
700
|
:rtype: typing_extensions.Self
|
|
754
701
|
"""
|
|
755
|
-
...
|
|
756
702
|
|
|
757
703
|
def lowpass(self, frequency: float, Q: float = 0.5) -> typing_extensions.Self:
|
|
758
704
|
"""Creates a second order lowpass filter based on the transfer function H(s) = 1 / (s^2 + s/Q + 1)
|
|
@@ -764,7 +710,6 @@ class Sound:
|
|
|
764
710
|
:return: The created `Sound` object.
|
|
765
711
|
:rtype: typing_extensions.Self
|
|
766
712
|
"""
|
|
767
|
-
...
|
|
768
713
|
|
|
769
714
|
def mix(self, sound: typing_extensions.Self) -> typing_extensions.Self:
|
|
770
715
|
"""Mixes two factories.
|
|
@@ -774,7 +719,6 @@ class Sound:
|
|
|
774
719
|
:return: The created `Sound` object.
|
|
775
720
|
:rtype: typing_extensions.Self
|
|
776
721
|
"""
|
|
777
|
-
...
|
|
778
722
|
|
|
779
723
|
def modulate(self, sound: typing_extensions.Self) -> typing_extensions.Self:
|
|
780
724
|
"""Modulates two factories.
|
|
@@ -784,7 +728,6 @@ class Sound:
|
|
|
784
728
|
:return: The created `Sound` object.
|
|
785
729
|
:rtype: typing_extensions.Self
|
|
786
730
|
"""
|
|
787
|
-
...
|
|
788
731
|
|
|
789
732
|
def mutable(self) -> typing_extensions.Self:
|
|
790
733
|
"""Creates a sound that will be restarted when sought backwards.
|
|
@@ -793,7 +736,6 @@ class Sound:
|
|
|
793
736
|
:return: The created `Sound` object.
|
|
794
737
|
:rtype: typing_extensions.Self
|
|
795
738
|
"""
|
|
796
|
-
...
|
|
797
739
|
|
|
798
740
|
def pingpong(self) -> typing_extensions.Self:
|
|
799
741
|
"""Plays a sound forward and then backward.
|
|
@@ -802,7 +744,6 @@ class Sound:
|
|
|
802
744
|
:return: The created `Sound` object.
|
|
803
745
|
:rtype: typing_extensions.Self
|
|
804
746
|
"""
|
|
805
|
-
...
|
|
806
747
|
|
|
807
748
|
def pitch(self, factor: float) -> typing_extensions.Self:
|
|
808
749
|
"""Changes the pitch of a sound with a specific factor.
|
|
@@ -812,7 +753,6 @@ class Sound:
|
|
|
812
753
|
:return: The created `Sound` object.
|
|
813
754
|
:rtype: typing_extensions.Self
|
|
814
755
|
"""
|
|
815
|
-
...
|
|
816
756
|
|
|
817
757
|
def rechannel(self, channels: int) -> typing_extensions.Self:
|
|
818
758
|
"""Rechannels the sound.
|
|
@@ -822,7 +762,6 @@ class Sound:
|
|
|
822
762
|
:return: The created `Sound` object.
|
|
823
763
|
:rtype: typing_extensions.Self
|
|
824
764
|
"""
|
|
825
|
-
...
|
|
826
765
|
|
|
827
766
|
def resample(self, rate: float, quality: int) -> typing_extensions.Self:
|
|
828
767
|
"""Resamples the sound.
|
|
@@ -834,7 +773,6 @@ class Sound:
|
|
|
834
773
|
:return: The created `Sound` object.
|
|
835
774
|
:rtype: typing_extensions.Self
|
|
836
775
|
"""
|
|
837
|
-
...
|
|
838
776
|
|
|
839
777
|
def reverse(self) -> typing_extensions.Self:
|
|
840
778
|
"""Plays a sound reversed.
|
|
@@ -842,7 +780,6 @@ class Sound:
|
|
|
842
780
|
:return: The created `Sound` object.
|
|
843
781
|
:rtype: typing_extensions.Self
|
|
844
782
|
"""
|
|
845
|
-
...
|
|
846
783
|
|
|
847
784
|
def sum(self) -> typing_extensions.Self:
|
|
848
785
|
"""Sums the samples of a sound.
|
|
@@ -850,7 +787,6 @@ class Sound:
|
|
|
850
787
|
:return: The created `Sound` object.
|
|
851
788
|
:rtype: typing_extensions.Self
|
|
852
789
|
"""
|
|
853
|
-
...
|
|
854
790
|
|
|
855
791
|
def threshold(self, threshold: float = 0) -> typing_extensions.Self:
|
|
856
792
|
"""Makes a threshold wave out of an audio wave by setting all samples
|
|
@@ -863,7 +799,6 @@ class Sound:
|
|
|
863
799
|
:return: The created `Sound` object.
|
|
864
800
|
:rtype: typing_extensions.Self
|
|
865
801
|
"""
|
|
866
|
-
...
|
|
867
802
|
|
|
868
803
|
def volume(self, volume: float) -> typing_extensions.Self:
|
|
869
804
|
"""Changes the volume of a sound.
|
|
@@ -873,7 +808,6 @@ class Sound:
|
|
|
873
808
|
:return: The created `Sound` object.
|
|
874
809
|
:rtype: typing_extensions.Self
|
|
875
810
|
"""
|
|
876
|
-
...
|
|
877
811
|
|
|
878
812
|
def write(
|
|
879
813
|
self,
|
|
@@ -905,7 +839,6 @@ class Sound:
|
|
|
905
839
|
:param buffersize: The size of the writing buffer.
|
|
906
840
|
:type buffersize: int
|
|
907
841
|
"""
|
|
908
|
-
...
|
|
909
842
|
|
|
910
843
|
class Source:
|
|
911
844
|
"""The source object represents the source position of a binaural sound."""
|
|
@@ -922,8 +855,6 @@ class Source:
|
|
|
922
855
|
class ThreadPool:
|
|
923
856
|
"""A ThreadPool is used to parallelize convolution efficiently."""
|
|
924
857
|
|
|
925
|
-
...
|
|
926
|
-
|
|
927
858
|
class error: ...
|
|
928
859
|
|
|
929
860
|
AP_LOCATION: typing.Any
|