foxglove-sdk 0.14.1__cp312-cp312-musllinux_1_2_i686.whl → 0.16.6__cp312-cp312-musllinux_1_2_i686.whl

foxglove/_foxglove_py/cloud.pyi

@@ -0,0 +1,9 @@
+class CloudSink:
+    """
+    A cloud sink for remote visualization and teleop.
+    """
+
+    def __init__(self) -> None: ...
+    def stop(self) -> None:
+        """Gracefully disconnect from the cloud sink, waiting for shutdown to complete."""
+        ...

foxglove/_foxglove_py/mcap.pyi

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Any, Optional
+from typing import Any
 
 class MCAPCompression(Enum):
     """
@@ -23,6 +23,10 @@ class MCAPWriteOptions:
     :param emit_message_indexes: Specifies whether to write message index records after each chunk.
     :param emit_chunk_indexes: Specifies whether to write chunk index records in the summary
         section.
+    :param disable_seeking: Specifies whether to disable seeking backwards/forwards when writing.
+        Use this when writing to a non-seekable file-like object (e.g. a wrapped pipe or network
+        socket). The seek() implementation must still support `seek(0, SEEK_CUR)` and
+        `seek(current_position, SEEK_SET)`.
     :param repeat_channels: Specifies whether to repeat each channel record from the data section
         in the summary section.
     :param repeat_schemas: Specifies whether to repeat each schema record from the data section in
@@ -34,23 +38,24 @@ class MCAPWriteOptions:
         CRC into the Footer record.
     """
 
-    def __new__(
-        cls,
+    def __init__(
+        self,
         *,
-        compression: Optional[MCAPCompression] = MCAPCompression.Zstd,
-        profile: Optional[str] = None,
-        chunk_size: Optional[int] = None,
+        compression: MCAPCompression | None = MCAPCompression.Zstd,
+        profile: str | None = None,
+        chunk_size: int | None = None,
         use_chunks: bool = False,
         emit_statistics: bool = True,
         emit_summary_offsets: bool = True,
         emit_message_indexes: bool = True,
         emit_chunk_indexes: bool = True,
+        disable_seeking: bool = False,
         repeat_channels: bool = True,
         repeat_schemas: bool = True,
         calculate_chunk_crcs: bool = True,
         calculate_data_section_crc: bool = True,
         calculate_summary_section_crc: bool = True,
-    ) -> "MCAPWriteOptions": ...
+    ) -> None: ...
 
 class MCAPWriter:
     """
@@ -65,12 +70,12 @@ class MCAPWriter:
     closed automatically, and any errors will be logged.
     """
 
-    def __new__(
-        cls,
+    def __init__(
+        self,
         *,
-        allow_overwrite: Optional[bool] = False,
-        writer_options: Optional[MCAPWriteOptions] = None,
-    ) -> "MCAPWriter": ...
+        allow_overwrite: bool | None = False,
+        writer_options: MCAPWriteOptions | None = None,
+    ) -> None: ...
     def __enter__(self) -> "MCAPWriter": ...
     def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None: ...
     def close(self) -> None:
@@ -82,3 +87,39 @@ class MCAPWriter:
         exiting the context manager.
         """
         ...
+
+    def write_metadata(self, name: str, metadata: dict[str, str]) -> None:
+        """
+        Write metadata to the MCAP file.
+
+        Metadata consists of key-value string pairs associated with a name.
+        If the metadata dictionary is empty, this method does nothing.
+
+        :param name: Name identifier for this metadata record
+        :param metadata: Dictionary of key-value pairs to store
+        """
+        ...
+
+    def attach(
+        self,
+        *,
+        log_time: int,
+        create_time: int,
+        name: str,
+        media_type: str,
+        data: bytes,
+    ) -> None:
+        """
+        Write an attachment to the MCAP file.
+
+        Attachments are arbitrary binary data that can be stored alongside messages.
+        Common uses include storing configuration files, calibration data, or other
+        reference material related to the recording.
+
+        :param log_time: Time at which the attachment was logged, in nanoseconds since epoch.
+        :param create_time: Time at which the attachment data was created, in nanoseconds since epoch.
+        :param name: Name of the attachment (e.g., "config.json").
+        :param media_type: MIME type of the attachment (e.g., "application/json").
+        :param data: Binary content of the attachment.
+        """
+        ...