OscCallback

class supriya.tools.osctools.OscCallback(address_pattern=None, argument_template=None, is_one_shot=False, procedure=None)[source]

An OSC callback.

>>> from supriya import osctools
>>> callback = osctools.OscCallback(
...     address_pattern='/*',
...     procedure=lambda x: print('GOT:', x),
...     )

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=1, group=0, label=object, shape=box]; } subgraph cluster_osctools { graph [label=osctools]; "supriya.tools.osctools.OscCallback.OscCallback" [color=black, fontcolor=white, group=1, label=<<B>OscCallback</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_systemtools { graph [label=systemtools]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" [color=3, group=2, label=AbstractBase, shape=box]; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" [color=3, group=2, label=SupriyaObject, shape=box]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" -> "supriya.tools.systemtools.SupriyaObject.SupriyaObject"; } "builtins.object" -> "supriya.tools.systemtools.SupriyaObject.AbstractBase"; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" -> "supriya.tools.osctools.OscCallback.OscCallback"; }

Bases

Attribute summary

address_pattern The address pattern of the callback.
argument_template
is_one_shot Is true when the callback should be unregistered after being called.
procedure Gets the procedure to be called.
__call__(message)
__eq__(expr) Is true when ID of expr equals ID of Supriya object.
__format__([format_specification]) Formats Supriya object.
__hash__() Hashes Supriya object.
__repr__() Gets interpreter representation of Supriya object.

Read-only properties

OscCallback.address_pattern

The address pattern of the callback.

>>> callback.address_pattern
'/*'

Returns string.

OscCallback.argument_template
OscCallback.is_one_shot

Is true when the callback should be unregistered after being called.

>>> callback.is_one_shot
False

Returns boolean.

OscCallback.procedure

Gets the procedure to be called.

Returns callable.

Special methods

OscCallback.__call__(message)[source]
(SupriyaObject).__eq__(expr)

Is true when ID of expr equals ID of Supriya object. Otherwise false.

Returns boolean.

(SupriyaObject).__format__(format_specification='')

Formats Supriya object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(SupriyaObject).__hash__()

Hashes Supriya object.

Required to be explicitely re-defined on Python 3 if __eq__ changes.

Returns integer.

(SupriyaObject).__repr__()

Gets interpreter representation of Supriya object.

Returns string.