6. API documentation

This section presents the different modules that constitute the toolkit Boing. The documentation of the classes and functions of the toolkit’s API is hereinafter provided.

Users API:

• 6.1. boing — Creating and managing pipelines

The pipeline architecture:

• 6.2. boing.core — The pipeline infrastructure
• 6.3. boing.core.observer — Observables and observers

Preconfigured nodes:

• 6.4. boing.nodes — The nodes of the pipeline

Filtering algorithms:

• 6.5. boing.filtering - Filters and noise generators

Gesture recognition algorithms:

• 6.6. boing.gesture.rubine — The Rubine’s recognition algorithm
• 6.7. boing.gesture.utils — Recognizers’ common utilities

Networking utilities:

• 6.8. boing.net — Networking and encoding tools
• 6.9. boing.net.bytes — UNICODE encoding
• 6.10. boing.net.slip — SLIP encoding
• 6.11. boing.net.json — JSON encoding
• 6.12. boing.net.osc — OSC encoding
• 6.13. boing.net.pickle — Python pickle encoding
• 6.14. boing.net.ip — IP utilities
• 6.15. boing.net.tcp — TCP utilities
• 6.16. boing.net.udp — UDP utilities
• 6.17. boing.net.ntp — NTP utilities

Generic utilitities:

• 6.18. boing.utils — Common utilities
• 6.19. boing.utils.fileutils — File utilities
• 6.20. boing.utils.querypath — A query path language
• 6.21. boing.utils.url — Uniform Resource Locator