python-osc/pythonosc/osc_bundle_builder.py at main · ZipFile/python-osc · GitHub

History

62 lines (49 loc) · 2.06 KB

Raw

"""Build OSC bundles for client applications."""

from typing import List

from pythonosc import osc_bundle

from pythonosc import osc_message

from pythonosc.parsing import osc_types

# Shortcut to specify an immediate execution of messages in the bundle.

IMMEDIATELY = osc_types.IMMEDIATELY

class BuildError(Exception):

"""Error raised when an error occurs building the bundle."""

class OscBundleBuilder(object):

"""Builds arbitrary OscBundle instances."""

def __init__(self, timestamp: int) -> None:

"""Build a new bundle with the associated timestamp.

Args:

- timestamp: system time represented as a floating point number of

seconds since the epoch in UTC or IMMEDIATELY.

"""

self._timestamp = timestamp

self._contents: List[osc_bundle.OscBundle | osc_message.OscMessage] = []

def add_content(

self, content: osc_bundle.OscBundle | osc_message.OscMessage

) -> None:

"""Add a new content to this bundle.

Args:

- content: Either an OscBundle or an OscMessage

"""

self._contents.append(content)

def build(self) -> osc_bundle.OscBundle:

"""Build an OscBundle with the current state of this builder.

Raises:

- BuildError: if we could not build the bundle.

"""

dgram = b"#bundle\x00"

try:

dgram += osc_types.write_date(self._timestamp)

for content in self._contents:

if isinstance(content, osc_message.OscMessage) or isinstance(

content, osc_bundle.OscBundle

size = content.size

dgram += osc_types.write_int(size)

dgram += content.dgram

else:

raise BuildError(

f"Content must be either OscBundle or OscMessage, found {type(content)}"

)

return osc_bundle.OscBundle(dgram)

except osc_types.BuildError as be:

raise BuildError(f"Could not build the bundle {be}")

python-osc/pythonosc/osc_bundle_builder.py at main · ZipFile/python-osc · GitHub

Expand file tree

Breadcrumbs

osc_bundle_builder.py

Latest commit

History

Breadcrumbs

osc_bundle_builder.py

File metadata and controls