providers

class BufferProxy(provider: 'Provider', identifier: Union[ForwardRef('supriya.nonrealtime.Buffer'), int], channel_count: int | None = None, frame_count: int | None = None, file_path: os.PathLike | None = None, starting_frame: int | None = None)

Bases: object

__float__() → float
__int__() → int
as_allocate_request() → BufferAllocateRequest | BufferAllocateReadRequest | BufferAllocateReadChannelRequest
as_free_request() → BufferFreeRequest
close() → None
free() → None
normalize(new_maximum: float = 1.0) → None
read(file_path: PathLike, leave_open: bool = False) → None
write(file_path: PathLike, frame_count: int | None = None, header_format: HeaderFormat | SupportsInt | str | None = 'aiff', leave_open: bool = False, sample_format: SampleFormat | SupportsInt | str | None = 'int24', starting_frame: int | None = None) → None
class BusGroupProxy(provider: 'Provider', calculation_rate: supriya.enums.CalculationRate, channel_count: int, identifier: Union[ForwardRef('supriya.nonrealtime.BusGroup'), int])

Bases: Proxy

__float__() → float
__getitem__(item) → BusProxy
__int__() → int
__len__() → int
__post_init__()
free() → None
property map_symbol : str
class BusProxy(provider: 'Provider', calculation_rate: supriya.enums.CalculationRate, identifier: Union[ForwardRef('supriya.nonrealtime.Bus'), int])

Bases: Proxy

__float__() → float
__int__() → int
free() → None
property map_symbol : str
set_(value) → None
class GroupProxy(provider: 'Provider', identifier: Union[ForwardRef('supriya.nonrealtime.Node'), int], parallel: bool = False)

Bases: NodeProxy

as_add_request(add_action, target_node) → GroupNewRequest | ParallelGroupNewRequest
as_free_request(force=False) → NodeFreeRequest
class NodeProxy(provider: 'Provider', identifier: Union[ForwardRef('supriya.nonrealtime.Node'), int])

Bases: Proxy

__float__() → float
__int__() → int
__setitem__(key, value)
add_group(*, add_action: AddAction | SupportsInt | str | None = AddAction.ADD_TO_HEAD, name: str | None = None, parallel: bool = False) → GroupProxy
add_synth(*, synthdef: SynthDef | None = None, add_action: AddAction | SupportsInt | str | None = AddAction.ADD_TO_HEAD, name: str | None = None, **settings) → SynthProxy
as_move_request(add_action: AddAction | SupportsInt | str | None, target_node: NodeProxy) → MoveRequest
as_set_request(**settings) → NodeSetRequest
dispose() → None
free() → None
move(add_action: AddAction | SupportsInt | str | None, target_node: NodeProxy) → None
class NonrealtimeProvider(session: Session, latency: float = 0.1)

Bases: Provider

add_buffer(*, channel_count: int | None = None, file_path: PathLike | None = None, frame_count: int | None = None, starting_frame: int | None = None) → BufferProxy
add_bus(calculation_rate=CalculationRate.CONTROL) → BusProxy
add_bus_group(channel_count=1, calculation_rate=CalculationRate.CONTROL) → BusGroupProxy
add_group(*, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, parallel: bool = False) → GroupProxy
add_synth(*, synthdef: SynthDef | None = None, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, **settings) → SynthProxy
dispose(node_proxy: NodeProxy) → None
free_buffer(buffer_: BufferProxy) → None
free_bus(bus: BusProxy) → None
free_bus_group(bus_group: BusGroupProxy) → None
free_node(node_proxy: NodeProxy) → None
move_node(node_proxy: NodeProxy, add_action: AddAction | SupportsInt | str | None, target_node: NodeProxy | Node) → None
register_osc_callback(pattern: tuple[str | float, ...], procedure: Callable) → OscCallbackProxy
property session : Session | None
set_bus(bus_proxy: BusProxy, value: float) → None
set_node(node_proxy: NodeProxy, **settings) → None
unregister_osc_callback(proxy: OscCallbackProxy) → None
class OscCallbackProxy(provider: 'Provider', identifier: Any)

Bases: Proxy

unregister() → None
class Provider(latency=0.1)

Bases: object

Provides limited realtime/non-realtime compatibility layer.

abstract add_buffer(*, channel_count: int | None = None, file_path: PathLike | None = None, frame_count: int | None = None, starting_frame: int | None = None) → BufferProxy
abstract add_bus(calculation_rate=CalculationRate.CONTROL) → BusProxy
abstract add_bus_group(channel_count=1, calculation_rate=CalculationRate.CONTROL) → BusGroupProxy
abstract add_group(*, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, parallel: bool = False) → GroupProxy
abstract add_synth(*, synthdef: SynthDef | None = None, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, **settings) → SynthProxy
property annotation_map : Mapping[Node | int, str]
at(seconds=None, wait=False) → ProviderMoment
abstract dispose(node_proxy: NodeProxy) → None
abstract free_buffer(buffer_proxy) → None
abstract free_bus(bus_proxy: BusProxy) → None
abstract free_bus_group(bus_group_proxy: BusGroupProxy) → None
abstract free_node(node_proxy: NodeProxy) → None
classmethod from_context(context, latency=0.1) → Provider
property latency : float
property moment : ProviderMoment | None
abstract move_node(node_proxy: NodeProxy, add_action: AddAction | SupportsInt | str | None, target_node: NodeProxy) → None
classmethod nonrealtime() → NonrealtimeProvider
classmethod realtime(*, options: Options | None = None, **kwargs) → RealtimeProvider
async classmethod realtime_async(*, options: Options | None = None, **kwargs) → RealtimeProvider
abstract register_osc_callback(pattern: tuple[str | float, ...], procedure: Callable) → OscCallbackProxy
property server : BaseServer | None
property session : Session | None
abstract set_bus(bus_proxy: BusProxy, value: float) → None
abstract set_node(node_proxy: NodeProxy, **settings) → None
abstract unregister_osc_callback(proxy: OscCallbackProxy) → None
class ProviderMoment(provider: 'Provider', seconds: float, bus_settings: List[Tuple[supriya.providers.BusProxy, float]] = <factory>, buffer_additions: List[supriya.providers.BufferProxy] = <factory>, buffer_removals: List[supriya.providers.BufferProxy] = <factory>, node_reorderings: List[Tuple[supriya.providers.NodeProxy, supriya.enums.AddAction, supriya.providers.NodeProxy]] = <factory>, node_additions: List[Tuple[supriya.providers.NodeProxy, supriya.enums.AddAction, supriya.providers.NodeProxy]] = <factory>, node_removals: List[supriya.providers.NodeProxy] = <factory>, node_settings: List[Tuple[supriya.providers.NodeProxy, Dict[str, Union[float, supriya.providers.BusGroupProxy]]]] = <factory>, wait: bool = False)

Bases: object

async __aenter__()
async __aexit__(*args)
__enter__()
__exit__(*args)
class Proxy(provider: 'Provider')

Bases: object

class RealtimeProvider(server: BaseServer, latency: float = 0.1)

Bases: Provider

add_buffer(*, channel_count: int | None = None, file_path: PathLike | None = None, frame_count: int | None = None, starting_frame: int | None = None) → BufferProxy
add_bus(calculation_rate=CalculationRate.CONTROL) → BusProxy
add_bus_group(channel_count=1, calculation_rate=CalculationRate.CONTROL) → BusGroupProxy
add_group(*, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, parallel: bool = False) → GroupProxy
add_synth(*, synthdef: SynthDef | None = None, target_node=None, add_action=AddAction.ADD_TO_HEAD, name: str | None = None, **settings) → SynthProxy
dispose(node_proxy: NodeProxy) → None
free_buffer(buffer_: BufferProxy) → None
free_bus(bus_proxy: BusProxy) → None
free_bus_group(bus_group_proxy: BusGroupProxy) → None
free_node(node_proxy: NodeProxy) → None
move_node(node_proxy: NodeProxy, add_action: AddAction | SupportsInt | str | None, target_node: NodeProxy) → None
register_osc_callback(pattern: tuple[str | float, ...], procedure: Callable) → OscCallbackProxy
property server : BaseServer | None
set_bus(bus_proxy: BusProxy, value: float) → None
set_node(node_proxy: NodeProxy, **settings) → None
unregister_osc_callback(proxy: OscCallbackProxy) → None
class SynthProxy(provider: 'Provider', identifier: Union[ForwardRef('supriya.nonrealtime.Node'), int], synthdef: supriya.synthdefs.synthdefs.SynthDef, settings: dict[str, float | supriya.providers.BusGroupProxy])

Bases: NodeProxy

as_add_request(add_action, target_node) → SynthNewRequest
as_free_request(force=False) → NodeFreeRequest | NodeSetRequest