Options
All
  • Public
  • Public/Protected
  • All
Menu

@mcap/core

Index

Type aliases

Mcap0WriterOptions: { chunkSize?: number; repeatChannels?: boolean; repeatSchemas?: boolean; startChannelId?: number; useAttachmentIndex?: boolean; useChunkIndex?: boolean; useChunks?: boolean; useMessageIndex?: boolean; useMetadataIndex?: boolean; useStatistics?: boolean; useSummaryOffsets?: boolean; writable: IWritable; compressChunk?: any }

Type declaration

  • Optional chunkSize?: number
  • Optional repeatChannels?: boolean
  • Optional repeatSchemas?: boolean
  • Optional startChannelId?: number
  • Optional useAttachmentIndex?: boolean
  • Optional useChunkIndex?: boolean
  • Optional useChunks?: boolean
  • Optional useMessageIndex?: boolean
  • Optional useMetadataIndex?: boolean
  • Optional useStatistics?: boolean
  • Optional useSummaryOffsets?: boolean
  • writable: IWritable
  • compressChunk?:function
    • compressChunk(chunkData: Uint8Array): { compressedData: Uint8Array; compression: string }
    • Parameters

      • chunkData: Uint8Array

      Returns { compressedData: Uint8Array; compression: string }

      • compressedData: Uint8Array
      • compression: string
McapVersion: "pre0" | "0"

Variables

DETECT_VERSION_BYTES_REQUIRED: 8 = 8

Functions

  • detectVersion(prefix: DataView): McapVersion | undefined
  • Detect MCAP version from file prefix. At least DETECT_VERSION_BYTES_REQUIRED bytes must be provided for the version to be detectable.

    Parameters

    • prefix: DataView

    Returns McapVersion | undefined

Generated using TypeDoc