node-av / lib/native-types / NativeIOContext

Interface: NativeIOContext

Defined in: src/lib/native-types.ts:376

Internal

Native AVIOContext binding interface

Bytestream I/O context for custom I/O. Used for reading/writing data from/to files, network, memory, etc.

Extends

• Disposable.AsyncDisposable

Properties

__brand

readonly __brand: "NativeIOContext"

Defined in: src/lib/native-types.ts:377

---

bufferSize

readonly bufferSize: number

Defined in: src/lib/native-types.ts:411

---

direct

direct: number

Defined in: src/lib/native-types.ts:414

---

eof

readonly eof: boolean

Defined in: src/lib/native-types.ts:407

---

error

readonly error: number

Defined in: src/lib/native-types.ts:408

---

maxPacketSize

maxPacketSize: number

Defined in: src/lib/native-types.ts:413

---

pos

readonly pos: bigint

Defined in: src/lib/native-types.ts:410

---

seekable

readonly seekable: number

Defined in: src/lib/native-types.ts:409

---

writeFlag

readonly writeFlag: boolean

Defined in: src/lib/native-types.ts:412

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: src/lib/native-types.ts:417

Returns

Promise<void>

Overrides

AsyncDisposable.[asyncDispose]

---

[dispose]()

[dispose](): void

Defined in: src/lib/native-types.ts:416

Returns

void

Overrides

Disposable.[dispose]

---

allocContext()

allocContext(bufferSize, writeFlag): void

Defined in: src/lib/native-types.ts:379

Parameters

bufferSize

number

writeFlag

number

Returns

void

---

allocContextWithCallbacks()

allocContextWithCallbacks(bufferSize, writeFlag, readCallback?, writeCallback?, seekCallback?): void

Defined in: src/lib/native-types.ts:380

Parameters

bufferSize

number

writeFlag

0 | 1

readCallback?

(size) => number | Buffer<ArrayBufferLike> | Promise<number | Buffer<ArrayBufferLike> | null> | null | null

writeCallback?

(buffer) => number | void | Promise<number | void> | null

seekCallback?

(offset, whence) => number | bigint | Promise<number | bigint> | null

Returns

void

---

closep()

closep(): Promise<number>

Defined in: src/lib/native-types.ts:390

Returns

Promise<number>

---

closepSync()

closepSync(): number

Defined in: src/lib/native-types.ts:391

Returns

number

---

flush()

flush(): Promise<void>

Defined in: src/lib/native-types.ts:400

Returns

Promise<void>

---

flushSync()

flushSync(): void

Defined in: src/lib/native-types.ts:401

Returns

void

---

freeContext()

freeContext(): void

Defined in: src/lib/native-types.ts:387

Returns

void

---

open2()

open2(url, flags): Promise<number>

Defined in: src/lib/native-types.ts:388

Parameters

url

string

flags

AVIOFlag

Returns

Promise<number>

---

open2Sync()

open2Sync(url, flags): number

Defined in: src/lib/native-types.ts:389

Parameters

url

string

flags

AVIOFlag

Returns

number

---

read()

read(size): Promise<number | Buffer<ArrayBufferLike>>

Defined in: src/lib/native-types.ts:392

Parameters

size

number

Returns

Promise<number | Buffer<ArrayBufferLike>>

---

readSync()

readSync(size): number | Buffer<ArrayBufferLike>

Defined in: src/lib/native-types.ts:393

Parameters

size

number

Returns

number | Buffer<ArrayBufferLike>

---

seek()

seek(offset, whence): Promise<bigint>

Defined in: src/lib/native-types.ts:396

Parameters

offset

bigint

whence

AVSeekWhence

Returns

Promise<bigint>

---

seekSync()

seekSync(offset, whence): bigint

Defined in: src/lib/native-types.ts:397

Parameters

offset

bigint

whence

AVSeekWhence

Returns

bigint

---

size()

size(): Promise<bigint>

Defined in: src/lib/native-types.ts:398

Returns

Promise<bigint>

---

sizeSync()

sizeSync(): bigint

Defined in: src/lib/native-types.ts:399

Returns

bigint

---

skip()

skip(offset): Promise<bigint>

Defined in: src/lib/native-types.ts:402

Parameters

offset

bigint

Returns

Promise<bigint>

---

skipSync()

skipSync(offset): bigint

Defined in: src/lib/native-types.ts:403

Parameters

offset

bigint

Returns

bigint

---

tell()

tell(): bigint

Defined in: src/lib/native-types.ts:404

Returns

bigint

---

write()

write(buffer): Promise<void>

Defined in: src/lib/native-types.ts:394

Parameters

buffer

Buffer

Returns

Promise<void>

---

writeSync()

writeSync(buffer): void

Defined in: src/lib/native-types.ts:395

Parameters

buffer

Buffer

Returns

void