node-av / lib/native-types / NativeIOContext

Interface: NativeIOContext

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

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:406

---

bufferSize

readonly bufferSize: number

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

---

direct

direct: number

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

---

eof

readonly eof: boolean

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

---

error

readonly error: number

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

---

maxPacketSize

maxPacketSize: number

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

---

pos

readonly pos: bigint

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

---

seekable

readonly seekable: number

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

---

writeFlag

readonly writeFlag: boolean

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

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

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

Returns

Promise<void>

Overrides

AsyncDisposable.[asyncDispose]

---

[dispose]()

[dispose](): void

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

Returns

void

Overrides

Disposable.[dispose]

---

allocContext()

allocContext(bufferSize, writeFlag): void

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

Parameters

bufferSize

number

writeFlag

number

Returns

void

---

allocContextWithCallbacks()

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

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

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:419

Returns

Promise<number>

---

closepSync()

closepSync(): number

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

Returns

number

---

flush()

flush(): Promise<void>

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

Returns

Promise<void>

---

flushSync()

flushSync(): void

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

Returns

void

---

freeContext()

freeContext(): void

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

Returns

void

---

open2()

open2(url, flags): Promise<number>

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

Parameters

url

string

flags

AVIOFlag

Returns

Promise<number>

---

open2Sync()

open2Sync(url, flags): number

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

Parameters

url

string

flags

AVIOFlag

Returns

number

---

read()

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

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

Parameters

size

number

Returns

Promise<number | Buffer<ArrayBufferLike>>

---

readSync()

readSync(size): number | Buffer<ArrayBufferLike>

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

Parameters

size

number

Returns

number | Buffer<ArrayBufferLike>

---

seek()

seek(offset, whence): Promise<bigint>

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

Parameters

offset

bigint

whence

AVSeekWhence

Returns

Promise<bigint>

---

seekSync()

seekSync(offset, whence): bigint

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

Parameters

offset

bigint

whence

AVSeekWhence

Returns

bigint

---

size()

size(): Promise<bigint>

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

Returns

Promise<bigint>

---

sizeSync()

sizeSync(): bigint

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

Returns

bigint

---

skip()

skip(offset): Promise<bigint>

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

Parameters

offset

bigint

Returns

Promise<bigint>

---

skipSync()

skipSync(offset): bigint

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

Parameters

offset

bigint

Returns

bigint

---

tell()

tell(): bigint

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

Returns

bigint

---

write()

write(buffer): Promise<void>

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

Parameters

buffer

Buffer

Returns

Promise<void>

---

writeSync()

writeSync(buffer): void

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

Parameters

buffer

Buffer

Returns

void