diff --git a/rosbag-docs/classes/_foxglove_rosbag.Bag.html b/rosbag-docs/classes/_foxglove_rosbag.Bag.html index eef73ee..82d9f97 100644 --- a/rosbag-docs/classes/_foxglove_rosbag.Bag.html +++ b/rosbag-docs/classes/_foxglove_rosbag.Bag.html @@ -1,4 +1,4 @@ -Bag | @foxglove/rosbag

Class Bag

Constructors

constructor +Bag | @foxglove/rosbag

Class Bag

Constructors

constructor

Properties

chunkInfos connections endTime? @@ -8,5 +8,5 @@

Methods

messageIterator open readMessages -

Constructors

constructor

Properties

chunkInfos

chunkInfos: ChunkInfo[] = []

connections

connections: Map<number, Connection>

OptionalendTime

endTime?: Time

Optionalheader

header?: BagHeader

reader

reader: BagReader

OptionalstartTime

startTime?: Time

Methods

messageIterator

  • messageIterator(opt?: MessageIteratorOpt): MessageIterator

  • Parameters

    • Optionalopt: MessageIteratorOpt

    Returns MessageIterator

open

  • open(): Promise<void>

  • Returns Promise<void>

readMessages

  • readMessages<T = unknown>(
        opts: ReadOptions,
        callback: (msg: ReadResult<T>) => void,
    ): Promise<void>

  • Type Parameters

    • T = unknown

    Parameters

    • opts: ReadOptions
    • callback: (msg: ReadResult<T>) => void

    Returns Promise<void>

    Deprecated

    Prefer the messageIterator method instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

chunkInfos

chunkInfos: ChunkInfo[] = []

connections

connections: Map<number, Connection>

OptionalendTime

endTime?: Time

Optionalheader

header?: BagHeader

reader

reader: BagReader

OptionalstartTime

startTime?: Time

Methods

messageIterator

  • messageIterator(opt?: MessageIteratorOpt): MessageIterator

  • Parameters

    • Optionalopt: MessageIteratorOpt

    Returns MessageIterator

open

  • open(): Promise<void>

  • Returns Promise<void>

readMessages

  • readMessages<T = unknown>(
        opts: ReadOptions,
        callback: (msg: ReadResult<T>) => void,
    ): Promise<void>

  • Type Parameters

    • T = unknown

    Parameters

    • opts: ReadOptions
    • callback: (msg: ReadResult<T>) => void

    Returns Promise<void>

    Deprecated

    Prefer the messageIterator method instead.

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/rosbag-docs/classes/_foxglove_rosbag_node.FileReader.html b/rosbag-docs/classes/_foxglove_rosbag_node.FileReader.html index 125d5e5..fd96c38 100644 --- a/rosbag-docs/classes/_foxglove_rosbag_node.FileReader.html +++ b/rosbag-docs/classes/_foxglove_rosbag_node.FileReader.html @@ -1,8 +1,8 @@ -FileReader | @foxglove/rosbag

Class FileReader

Implements

Constructors

constructor +FileReader | @foxglove/rosbag

Class FileReader

Implements

Constructors

constructor

Properties

_file? _filename _size

Methods

close read size -

Constructors

constructor

Properties

Optional_file

_file?: FileHandle

_filename

_filename: string

_size

_size: number

Methods

close

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Optional_file

_file?: FileHandle

_filename

_filename: string

_size

_size: number

Methods

close

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/rosbag-docs/classes/_foxglove_rosbag_web.BlobReader.html b/rosbag-docs/classes/_foxglove_rosbag_web.BlobReader.html index 8cd24d4..8718f65 100644 --- a/rosbag-docs/classes/_foxglove_rosbag_web.BlobReader.html +++ b/rosbag-docs/classes/_foxglove_rosbag_web.BlobReader.html @@ -1,6 +1,6 @@ -BlobReader | @foxglove/rosbag

Class BlobReader

Implements

Constructors

constructor +BlobReader | @foxglove/rosbag

Class BlobReader

Implements

Constructors

constructor

Properties

_blob _size

Methods

read size -

Constructors

constructor

Properties

_blob

_blob: Blob

_size

_size: number

Methods

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

_blob

_blob: Blob

_size

_size: number

Methods

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/rosbag-docs/interfaces/_foxglove_rosbag.Filelike.html b/rosbag-docs/interfaces/_foxglove_rosbag.Filelike.html index 3b09c5b..c04a27a 100644 --- a/rosbag-docs/interfaces/_foxglove_rosbag.Filelike.html +++ b/rosbag-docs/interfaces/_foxglove_rosbag.Filelike.html @@ -1,3 +1,3 @@ -Filelike | @foxglove/rosbag

Interface Filelike

interface Filelike {
    read(offset: number, length: number): Promise<Uint8Array>;
    size(): number;
}

Implemented by

Methods

read +Filelike | @foxglove/rosbag

Interface Filelike

interface Filelike {
    read(offset: number, length: number): Promise<Uint8Array>;
    size(): number;
}

Implemented by

Methods

read size -

Methods

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Methods
+

Methods

read

  • read(offset: number, length: number): Promise<Uint8Array>

  • Parameters

    • offset: number
    • length: number

    Returns Promise<Uint8Array>

size

Settings

Member Visibility

On This Page

Methods
diff --git a/rosbag-docs/types/_foxglove_rosbag.MessageEvent.html b/rosbag-docs/types/_foxglove_rosbag.MessageEvent.html index ffaf491..f32d5e5 100644 --- a/rosbag-docs/types/_foxglove_rosbag.MessageEvent.html +++ b/rosbag-docs/types/_foxglove_rosbag.MessageEvent.html @@ -1 +1 @@ -MessageEvent | @foxglove/rosbag

Type Alias MessageEvent

MessageEvent: {
    connectionId: number;
    data: Uint8Array;
    message?: unknown;
    timestamp: Time;
    topic: string;
}

Type declaration

  • connectionId: number
  • data: Uint8Array
  • Optionalmessage?: unknown
  • timestamp: Time
  • topic: string

Settings

Member Visibility
+MessageEvent | @foxglove/rosbag

Type Alias MessageEvent

MessageEvent: {
    connectionId: number;
    data: Uint8Array;
    message?: unknown;
    timestamp: Time;
    topic: string;
}

Type declaration

  • connectionId: number
  • data: Uint8Array
  • Optionalmessage?: unknown
  • timestamp: Time
  • topic: string

Settings

Member Visibility