SoundActuator(Actuator)

base classes — bpy_struct, Actuator

class bpy.types.SoundActuator(Actuator)

Sound file

cone_inner_angle_3d

The angle of the inner cone (in [-inf, inf], default 0.0)

Type:

float

cone_outer_angle_3d

The angle of the outer cone (in [-inf, inf], default 0.0)

Type:

float

cone_outer_gain_3d

The gain outside the outer cone (the gain in the outer cone will be interpolated between this value and the normal gain in the inner cone) (in [-inf, inf], default 0.0)

Type:

float

distance_3d_max

The maximum distance at which you can hear the sound (in [-inf, inf], default 0.0)

Type:

float

distance_3d_reference

The distance where the sound has a gain of 1.0 (in [-inf, inf], default 0.0)

Type:

float

gain_3d_max

The maximum gain of the sound, no matter how near it is (in [-inf, inf], default 0.0)

Type:

float

gain_3d_min

The minimum gain of the sound, no matter how far it is away (in [-inf, inf], default 0.0)

Type:

float

mode

(default 'PLAYSTOP')

Type:

Literal[‘PLAYSTOP’, ‘PLAYEND’, ‘LOOPSTOP’, ‘LOOPEND’, ‘LOOPBIDIRECTIONAL’, ‘LOOPBIDIRECTIONALSTOP’]

pitch

Pitch of the sound (in [-inf, inf], default 0.0)

Type:

float

rolloff_factor_3d

The influence factor on volume depending on distance (in [-inf, inf], default 0.0)

Type:

float

sound
Type:

Sound

use_preload

Preload sound. Improves playing for small/medium repetitive sounds (default False)

Type:

bool

use_sound_3d

Enable/Disable 3D Sound (default False)

Type:

bool

volume

Initial volume of the sound (in [0, 2], default 0.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions