mcap package

Submodules

• mcap.data_stream module
  • ReadDataStream
    • ReadDataStream.checksum()
    • ReadDataStream.count
    • ReadDataStream.read()
    • ReadDataStream.read1()
    • ReadDataStream.read2()
    • ReadDataStream.read4()
    • ReadDataStream.read8()
    • ReadDataStream.read_prefixed_string()
  • RecordBuilder
    • RecordBuilder.count
    • RecordBuilder.end()
    • RecordBuilder.finish_record()
    • RecordBuilder.start_record()
    • RecordBuilder.write()
    • RecordBuilder.write1()
    • RecordBuilder.write2()
    • RecordBuilder.write4()
    • RecordBuilder.write8()
    • RecordBuilder.write_prefixed_string()
• mcap.decoder module
  • DecoderFactory
    • DecoderFactory.decoder_for()
• mcap.exceptions module
  • DecoderNotFoundError
  • EndOfFile
  • InvalidMagic
  • McapError
• mcap.opcode module
  • Opcode
    • Opcode.ATTACHMENT
    • Opcode.ATTACHMENT_INDEX
    • Opcode.CHANNEL
    • Opcode.CHUNK
    • Opcode.CHUNK_INDEX
    • Opcode.DATA_END
    • Opcode.FOOTER
    • Opcode.HEADER
    • Opcode.MESSAGE
    • Opcode.MESSAGE_INDEX
    • Opcode.METADATA
    • Opcode.METADATA_INDEX
    • Opcode.SCHEMA
    • Opcode.STATISTICS
    • Opcode.SUMMARY_OFFSET
• mcap.reader module
  • DecodedMessageTuple
    • DecodedMessageTuple.channel
    • DecodedMessageTuple.decoded_message
    • DecodedMessageTuple.message
    • DecodedMessageTuple.schema
  • McapReader
    • McapReader.get_header()
    • McapReader.get_summary()
    • McapReader.iter_attachments()
    • McapReader.iter_decoded_messages()
    • McapReader.iter_messages()
    • McapReader.iter_metadata()
  • NonSeekingReader
    • NonSeekingReader.get_header()
    • NonSeekingReader.get_summary()
    • NonSeekingReader.iter_attachments()
    • NonSeekingReader.iter_messages()
    • NonSeekingReader.iter_metadata()
  • SeekingReader
    • SeekingReader.get_header()
    • SeekingReader.get_summary()
    • SeekingReader.iter_attachments()
    • SeekingReader.iter_messages()
    • SeekingReader.iter_metadata()
  • make_reader()
• mcap.records module
  • Attachment
    • Attachment.create_time
    • Attachment.data
    • Attachment.log_time
    • Attachment.media_type
    • Attachment.name
    • Attachment.read()
    • Attachment.write()
  • AttachmentIndex
    • AttachmentIndex.create_time
    • AttachmentIndex.data_size
    • AttachmentIndex.length
    • AttachmentIndex.log_time
    • AttachmentIndex.media_type
    • AttachmentIndex.name
    • AttachmentIndex.offset
    • AttachmentIndex.read()
    • AttachmentIndex.write()
  • Channel
    • Channel.id
    • Channel.message_encoding
    • Channel.metadata
    • Channel.read()
    • Channel.schema_id
    • Channel.topic
    • Channel.write()
  • Chunk
    • Chunk.compression
    • Chunk.data
    • Chunk.message_end_time
    • Chunk.message_start_time
    • Chunk.read()
    • Chunk.uncompressed_crc
    • Chunk.uncompressed_size
    • Chunk.write()
  • ChunkIndex
    • ChunkIndex.chunk_length
    • ChunkIndex.chunk_start_offset
    • ChunkIndex.compressed_size
    • ChunkIndex.compression
    • ChunkIndex.message_end_time
    • ChunkIndex.message_index_length
    • ChunkIndex.message_index_offsets
    • ChunkIndex.message_start_time
    • ChunkIndex.read()
    • ChunkIndex.uncompressed_size
    • ChunkIndex.write()
  • DataEnd
    • DataEnd.data_section_crc
    • DataEnd.read()
    • DataEnd.write()
  • Footer
    • Footer.read()
    • Footer.summary_crc
    • Footer.summary_offset_start
    • Footer.summary_start
    • Footer.write()
  • Header
    • Header.library
    • Header.profile
    • Header.read()
    • Header.write()
  • McapRecord
    • McapRecord.write()
  • Message
    • Message.channel_id
    • Message.data
    • Message.log_time
    • Message.publish_time
    • Message.read()
    • Message.sequence
    • Message.write()
  • MessageIndex
    • MessageIndex.channel_id
    • MessageIndex.read()
    • MessageIndex.records
    • MessageIndex.write()
  • Metadata
    • Metadata.metadata
    • Metadata.name
    • Metadata.read()
    • Metadata.write()
  • MetadataIndex
    • MetadataIndex.length
    • MetadataIndex.name
    • MetadataIndex.offset
    • MetadataIndex.read()
    • MetadataIndex.write()
  • Schema
    • Schema.data
    • Schema.encoding
    • Schema.id
    • Schema.name
    • Schema.read()
    • Schema.write()
  • Statistics
    • Statistics.attachment_count
    • Statistics.channel_count
    • Statistics.channel_message_counts
    • Statistics.chunk_count
    • Statistics.message_count
    • Statistics.message_end_time
    • Statistics.message_start_time
    • Statistics.metadata_count
    • Statistics.read()
    • Statistics.schema_count
    • Statistics.write()
  • SummaryOffset
    • SummaryOffset.group_length
    • SummaryOffset.group_opcode
    • SummaryOffset.group_start
    • SummaryOffset.read()
    • SummaryOffset.write()
• mcap.serialization module
  • normalize_value()
  • stringify_record()
• mcap.stream_reader module
  • StreamReader
    • StreamReader.records
• mcap.summary module
  • Summary
• mcap.well_known module
  • MessageEncoding
    • MessageEncoding.CBOR
    • MessageEncoding.CDR
    • MessageEncoding.Flatbuffer
    • MessageEncoding.JSON
    • MessageEncoding.Protobuf
    • MessageEncoding.ROS1
  • Profile
    • Profile.ROS1
    • Profile.ROS2
  • SchemaEncoding
    • SchemaEncoding.Flatbuffer
    • SchemaEncoding.JSONSchema
    • SchemaEncoding.Protobuf
    • SchemaEncoding.ROS1
    • SchemaEncoding.ROS2
    • SchemaEncoding.ROS2IDL
    • SchemaEncoding.SelfDescribing
• mcap.writer module
  • CompressionType
    • CompressionType.LZ4
    • CompressionType.NONE
    • CompressionType.ZSTD
  • IndexType
    • IndexType.ALL
    • IndexType.ATTACHMENT
    • IndexType.CHUNK
    • IndexType.MESSAGE
    • IndexType.METADATA
    • IndexType.NONE
  • Writer
    • Writer.add_attachment()
    • Writer.add_message()
    • Writer.add_metadata()
    • Writer.finish()
    • Writer.register_channel()
    • Writer.register_schema()
    • Writer.start()

Module contents