ipytone.Panner3D#

class ipytone.Panner3D(**kwargs: Any)#

Bases: AudioNode

A spatialized panner audio node that provides equal power or HRTF panning.

For more details about the 3D spatial reference system, see Listener.

__init__(position=(0, 0, 0), orientation=(0, 0, 0), **kwargs)#: Public constructor

Methods

`chain`(*nodes)	Connect the output of this audio node to the other audio nodes in series.
`connect`(destination[, output_number, ...])	Connect the output of this audio node to the input of another node.
`disconnect`(destination[, output_number, ...])	Disconnect the ouput of this audio node from a connected node.
`dispose`()	Dispose and disconnect this audio node (as well as its input/output).
`fan`(*destinations)	Connect the output of this audio node to the `destinations` audio nodes in parallel.
`set_orientation`(x, y, z)	Convenient method to set the x-y-z coordinate orientation of the source.
`set_position`(x, y, z)	Convenient method to set the x-y-z coordinate position of the source.
`to_destination`()	Convenience method to directly connect the output of this audio node to the main output (speakers) node.

Attributes

`channel_count`	An int trait.
`channel_count_mode`	An enum whose value must be in a given sequence.
`channel_interpretation`	An enum whose value must be in a given sequence.
`cone_inner_angle`	angle inside of which there is no volume reduction (degrees)
`cone_outer_angle`	angle outside of which volume is reduced to a constant (degrees)
`cone_outer_gain`	gain value outside of the cone outer angle
`disposed`	Returns True if the node was disposed (i.e., disconnected and web audio node freed for garbage collection).
`distance_model`	distance model for source volume reduction
`input`	Returns the input node, or None if this node is a source.
`log`	A trait whose value must be an instance of a specified class.
`max_distance`	max distance between the source and listener (beyond, no volume reduction)
`name`	A trait for unicode strings.
`number_of_inputs`	Returns the number of input slots for the input node (0 for source nodes).
`number_of_outputs`	Returns the number of output slots for the output node (0 for sink nodes).
`orientation_x`	source orientation x-coordinate.
`orientation_y`	source orientation y-coordinate.
`orientation_z`	source orientation z-coordinate.
`output`	Returns the output node, or None if this node is a sink.
`panning_model`	panning model
`position_x`	source position x-coordinate.
`position_y`	source position y-coordinate.
`position_z`	source position z-coordinate.
`ref_distance`	reference distance for source volume reduction
`rolloff_factor`	controls the amount of source volume reduction with distance

chain(*nodes)#: Connect the output of this audio node to the other audio nodes in series.

cone_inner_angle#: angle inside of which there is no volume reduction (degrees)

cone_outer_angle#: angle outside of which volume is reduced to a constant (degrees)

connect(destination, output_number=0, input_number=0)#

Connect the output of this audio node to the input of another node.

Parameters:

destination (AudioNode or NativeAudioNode or Param or NativeAudioParam) – The destination node.
output_number (int) – The channel number of the output of this node (default: 0).
input_number (int) – The channel number of the input of the destination node (default: 0).

disconnect(destination, output_number=0, input_number=0)#

Disconnect the ouput of this audio node from a connected node.

Parameters:

destination (AudioNode or NativeAudioNode or Param or NativeAudioParam) – The connected destination node.
output_number (int) – The channel number of the output of this node (default: 0).
input_number (int) – The channel number of the input of the destination node (default: 0).

dispose()#: Dispose and disconnect this audio node (as well as its input/output).

property disposed#: Returns True if the node was disposed (i.e., disconnected and web audio node freed for garbage collection).

fan(*destinations)#: Connect the output of this audio node to the destinations audio nodes in parallel.

property input#: Returns the input node, or None if this node is a source.

max_distance#: max distance between the source and listener (beyond, no volume reduction)

property number_of_inputs#: Returns the number of input slots for the input node (0 for source nodes).

property number_of_outputs#: Returns the number of output slots for the output node (0 for sink nodes).

property output#: Returns the output node, or None if this node is a sink.

rolloff_factor#: controls the amount of source volume reduction with distance

set_orientation(x, y, z)#: Convenient method to set the x-y-z coordinate orientation of the source.

set_position(x, y, z)#: Convenient method to set the x-y-z coordinate position of the source.

to_destination()#: Convenience method to directly connect the output of this audio node to the main output (speakers) node.