GroupFreeAllRequest

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph cluster_builtins { graph [label=builtins]; node [color=1]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } subgraph "cluster_supriya.commands" { graph [label="supriya.commands"]; node [color=2]; "supriya.commands.GroupFreeAllRequest.GroupFreeAllRequest" [URL="../api/supriya/commands/GroupFreeAllRequest.html#supriya.commands.GroupFreeAllRequest.GroupFreeAllRequest", color=black, fontcolor=white, label="Group\nFree\nAll\nRequest", target=_top]; "supriya.commands.Request.Request" [URL="../api/supriya/commands/Request.html#supriya.commands.Request.Request", label=Request, shape=oval, style=bold, target=_top]; "supriya.commands.Requestable.Requestable" [URL="../api/supriya/commands/Requestable.html#supriya.commands.Requestable.Requestable", label=Requestable, target=_top]; "supriya.commands.Request.Request" -> "supriya.commands.GroupFreeAllRequest.GroupFreeAllRequest"; "supriya.commands.Requestable.Requestable" -> "supriya.commands.Request.Request"; } subgraph "cluster_supriya.system" { graph [label="supriya.system"]; node [color=3]; "supriya.system.SupriyaObject.SupriyaObject" [URL="../api/supriya/commands/../system/SupriyaObject.html#supriya.system.SupriyaObject.SupriyaObject", label="Supriya\nObject", target=_top]; "supriya.system.SupriyaValueObject.SupriyaValueObject" [URL="../api/supriya/commands/../system/SupriyaValueObject.html#supriya.system.SupriyaValueObject.SupriyaValueObject", label="Supriya\nValue\nObject", target=_top]; "supriya.system.SupriyaObject.SupriyaObject" -> "supriya.system.SupriyaValueObject.SupriyaValueObject"; } "builtins.object" -> "supriya.system.SupriyaObject.SupriyaObject"; "supriya.system.SupriyaValueObject.SupriyaValueObject" -> "supriya.commands.Requestable.Requestable"; }

class supriya.commands.GroupFreeAllRequest.GroupFreeAllRequest(group_id)[source]

A /g_freeAll request.

>>> import supriya
>>> server = supriya.Server().boot()
>>> group = supriya.Group().allocate()
>>> group.extend([supriya.Synth(), supriya.Group()])
>>> group[1].extend([supriya.Synth(), supriya.Group()])
>>> group[1][1].extend([supriya.Synth(), supriya.Group()])
>>> print(server)
NODE TREE 0 group
    1 group
        1000 group
            1001 default
                out: 0.0, amplitude: 0.1, frequency: 440.0, gate: 1.0, pan: 0.5
            1002 group
                1003 default
                    out: 0.0, amplitude: 0.1, frequency: 440.0, gate: 1.0, pan: 0.5
                1004 group
                    1005 default
                        out: 0.0, amplitude: 0.1, frequency: 440.0, gate: 1.0, pan: 0.5
                    1006 group
>>> request = supriya.commands.GroupFreeAllRequest(group)
>>> request.to_osc(True)
OscMessage('/g_freeAll', 1000)
>>> with server.osc_io.capture() as transcript:
...     request.communicate(server=server)
...     _ = server.sync()
...
>>> for entry in transcript:
...     (entry.label, entry.message)
...
('S', OscMessage(24, 1000))
('S', OscMessage(52, 2))
('R', OscMessage('/n_end', 1001, -1, -1, -1, 0))
('R', OscMessage('/n_end', 1003, -1, -1, -1, 0))
('R', OscMessage('/n_end', 1005, -1, -1, -1, 0))
('R', OscMessage('/n_end', 1006, -1, -1, -1, 1, -1, -1))
('R', OscMessage('/n_end', 1004, -1, -1, -1, 1, -1, -1))
('R', OscMessage('/n_end', 1002, -1, -1, -1, 1, -1, -1))
('R', OscMessage('/synced', 2))
>>> print(server)
NODE TREE 0 group
    1 group
        1000 group
>>> print(server.query_local_nodes(True))
NODE TREE 0 group
    1 group
        1000 group

Attributes Summary

group_id
request_id
to_osc

Special methods

(SupriyaValueObject).__copy__(*args)
(SupriyaValueObject).__eq__(expr)

Return self==value.

(SupriyaValueObject).__hash__()

Return hash(self).

(SupriyaObject).__repr__()

Return repr(self).


Methods

(Requestable).communicate(server=None, sync=True, timeout=1.0, apply_local=True)
(Request).to_datagram()
(Request).to_list(with_request_name=False)
to_osc(with_request_name=False)[source]

Read-only properties

(Requestable).condition
group_id
(Request).request_name
(Requestable).response
(Request).response_patterns