Sound Operators

bpy.ops.sound.bake_animation()

Update the audio animation cache

bpy.ops.sound.mixdown(filepath="", check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=True, filter_text=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_folder=True, filter_blenlib=False, filemode=9, relative_path=True, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA')

Mix the scene’s audio to a sound file

Parameters:

• filepath (string, (optional, never None)) – File Path, Path to file
• check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_backup (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_alembic (boolean, (optional)) – Filter Alembic files
• filter_folder (boolean, (optional)) – Filter folders
• filter_blenlib (boolean, (optional)) – Filter Blender IDs
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file
• display_type (enum in ['DEFAULT', 'LIST_SHORT', 'LIST_LONG', 'THUMBNAIL'], (optional)) –

  Display Type

  • DEFAULT Default, Automatically determine display type for files.
  • LIST_SHORT Short List, Display files as short list.
  • LIST_LONG Long List, Display files as a detailed list.
  • THUMBNAIL Thumbnails, Display files as thumbnails.
• sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) –

  File sorting mode

  • FILE_SORT_ALPHA Sort alphabetically, Sort the file list alphabetically.
  • FILE_SORT_EXTENSION Sort by extension, Sort the file list by extension/type.
  • FILE_SORT_TIME Sort by time, Sort files by modification time.
  • FILE_SORT_SIZE Sort by size, Sort files by size.

bpy.ops.sound.open(filepath="", filter_blender=False, filter_backup=False, filter_image=False, filter_movie=True, filter_python=False, filter_font=False, filter_sound=True, filter_text=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_folder=True, filter_blenlib=False, filemode=9, relative_path=True, show_multiview=False, use_multiview=False, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA', cache=False, mono=False)

Load a sound file

Parameters:

• filepath (string, (optional, never None)) – File Path, Path to file
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_backup (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_alembic (boolean, (optional)) – Filter Alembic files
• filter_folder (boolean, (optional)) – Filter folders
• filter_blenlib (boolean, (optional)) – Filter Blender IDs
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file
• show_multiview (boolean, (optional)) – Enable Multi-View
• use_multiview (boolean, (optional)) – Use Multi-View
• display_type (enum in ['DEFAULT', 'LIST_SHORT', 'LIST_LONG', 'THUMBNAIL'], (optional)) –

  Display Type

  • DEFAULT Default, Automatically determine display type for files.
  • LIST_SHORT Short List, Display files as short list.
  • LIST_LONG Long List, Display files as a detailed list.
  • THUMBNAIL Thumbnails, Display files as thumbnails.
• sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) –

  File sorting mode

  • FILE_SORT_ALPHA Sort alphabetically, Sort the file list alphabetically.
  • FILE_SORT_EXTENSION Sort by extension, Sort the file list by extension/type.
  • FILE_SORT_TIME Sort by time, Sort files by modification time.
  • FILE_SORT_SIZE Sort by size, Sort files by size.
• cache (boolean, (optional)) – Cache, Cache the sound in memory
• mono (boolean, (optional)) – Mono, Merge all the sound’s channels into one

bpy.ops.sound.open_mono(filepath="", filter_blender=False, filter_backup=False, filter_image=False, filter_movie=True, filter_python=False, filter_font=False, filter_sound=True, filter_text=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_folder=True, filter_blenlib=False, filemode=9, relative_path=True, show_multiview=False, use_multiview=False, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA', cache=False, mono=True)

Load a sound file as mono

Parameters:

• filepath (string, (optional, never None)) – File Path, Path to file
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_backup (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_alembic (boolean, (optional)) – Filter Alembic files
• filter_folder (boolean, (optional)) – Filter folders
• filter_blenlib (boolean, (optional)) – Filter Blender IDs
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file
• show_multiview (boolean, (optional)) – Enable Multi-View
• use_multiview (boolean, (optional)) – Use Multi-View
• display_type (enum in ['DEFAULT', 'LIST_SHORT', 'LIST_LONG', 'THUMBNAIL'], (optional)) –

  Display Type

  • DEFAULT Default, Automatically determine display type for files.
  • LIST_SHORT Short List, Display files as short list.
  • LIST_LONG Long List, Display files as a detailed list.
  • THUMBNAIL Thumbnails, Display files as thumbnails.
• sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) –

  File sorting mode

  • FILE_SORT_ALPHA Sort alphabetically, Sort the file list alphabetically.
  • FILE_SORT_EXTENSION Sort by extension, Sort the file list by extension/type.
  • FILE_SORT_TIME Sort by time, Sort files by modification time.
  • FILE_SORT_SIZE Sort by size, Sort files by size.
• cache (boolean, (optional)) – Cache, Cache the sound in memory
• mono (boolean, (optional)) – Mono, Mixdown the sound to mono

bpy.ops.sound.pack()

Pack the sound into the current blend file

bpy.ops.sound.unpack(method='USE_LOCAL', id="")

Unpack the sound to the samples filename

Parameters:

• method (enum in ['USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL'], (optional)) – Method, How to unpack
• id (string, (optional, never None)) – Sound Name, Sound data-block name to unpack

bpy.ops.sound.update_animation_flags()

Update animation flags