Speaker(ID)

base classes — bpy_struct, ID

class bpy.types.Speaker(ID)

Speaker data-block for 3D audio speaker objects

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

attenuation

How strong the distance affects volume, depending on distance model (in [0, inf], default 1.0)

Type:

float

cone_angle_inner

Angle of the inner cone, in degrees, inside the cone the volume is 100% (in [0, 360], default 360.0)

Type:

float

cone_angle_outer

Angle of the outer cone, in degrees, outside this cone the volume is the outer cone volume, between inner and outer cone the volume is interpolated (in [0, 360], default 360.0)

Type:

float

cone_volume_outer

Volume outside the outer cone (in [0, 1], default 1.0)

Type:

float

distance_max

Maximum distance for volume calculation, no matter how far away the object is (in [0, inf], default 3.40282e+38)

Type:

float

distance_reference

Reference distance at which volume is 100% (in [0, inf], default 1.0)

Type:

float

muted

Mute the speaker (default False)

Type:

bool

pitch

Playback pitch of the sound (in [0.1, 10], default 1.0)

Type:

float

sound

Sound data-block used by this speaker

Type:

Sound

volume

How loud the sound is (in [0, 1], default 1.0)

Type:

float

volume_max

Maximum volume, no matter how near the object is (in [0, 1], default 1.0)

Type:

float

volume_min

Minimum volume, no matter how far away the object is (in [0, 1], default 0.0)

Type:

float

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

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

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.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References