Skip to content

node-av / lib/native-types / NativeFormatContext

Interface: NativeFormatContext ​

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

Internal

Native AVFormatContext binding interface

Main interface for demuxing and muxing operations. Must be allocated before use and properly disposed after.

Extends ​

  • AsyncDisposable

Properties ​

__brand ​

readonly __brand: "NativeFormatContext"

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


bitRate ​

readonly bitRate: bigint

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


duration ​

readonly duration: bigint

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


flags ​

flags: AVFormatFlag

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


iformat ​

readonly iformat: NativeInputFormat | null

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


maxAnalyzeDuration ​

maxAnalyzeDuration: bigint

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


maxInterleaveDelta ​

maxInterleaveDelta: bigint

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


maxStreams ​

maxStreams: number

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


metadata ​

metadata: NativeDictionary | null

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


nbPrograms ​

readonly nbPrograms: number

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


nbStreams ​

readonly nbStreams: number

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


oformat ​

oformat: NativeOutputFormat | null

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


pb ​

pb: NativeIOContext | null

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


pbBytes ​

readonly pbBytes: bigint

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


probeScore ​

readonly probeScore: number

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


probesize ​

probesize: bigint

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


startTime ​

readonly startTime: bigint

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


streams ​

readonly streams: NativeStream[] | null

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


strictStdCompliance ​

strictStdCompliance: number

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


url ​

url: string | null

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

Methods ​

[asyncDispose]() ​

[asyncDispose](): PromiseLike<void>

Defined in: node_modules/typescript/lib/lib.esnext.disposable.d.ts:40

Returns ​

PromiseLike<void>

Inherited from ​

AsyncDisposable.[asyncDispose]


allocContext() ​

allocContext(): void

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

Returns ​

void


allocOutputContext2() ​

allocOutputContext2(oformat, formatName, filename): number

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

Parameters ​

oformat ​

NativeOutputFormat | null

formatName ​

string | null

filename ​

string | null

Returns ​

number


closeInput() ​

closeInput(detachPb?): Promise<void>

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

Parameters ​

detachPb? ​

boolean

Returns ​

Promise<void>


closeInputSync() ​

closeInputSync(detachPb?): void

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

Parameters ​

detachPb? ​

boolean

Returns ​

void


closeOutput() ​

closeOutput(): Promise<void>

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

Returns ​

Promise<void>


closeOutputSync() ​

closeOutputSync(): void

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

Returns ​

void


dumpFormat() ​

dumpFormat(index, url, isOutput): void

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

Parameters ​

index ​

number

url ​

string

isOutput ​

boolean

Returns ​

void


findBestStream() ​

findBestStream(type, wantedStreamNb, relatedStream, wantDecoder, flags): number | { decoder: NativeCodec | null; streamIndex: number; }

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

Parameters ​

type ​

AVMediaType

wantedStreamNb ​

number

relatedStream ​

number

wantDecoder ​

boolean

flags ​

number

Returns ​

number | { decoder: NativeCodec | null; streamIndex: number; }


findStreamInfo() ​

findStreamInfo(options): Promise<number>

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

Parameters ​

options ​

NativeDictionary[] | null

Returns ​

Promise<number>


findStreamInfoSync() ​

findStreamInfoSync(options): number

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

Parameters ​

options ​

NativeDictionary[] | null

Returns ​

number


flush() ​

flush(): Promise<void>

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

Returns ​

Promise<void>


flushSync() ​

flushSync(): void

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

Returns ​

void


freeContext() ​

freeContext(): void

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

Returns ​

void


getRTSPStreamInfo() ​

getRTSPStreamInfo(): RTSPStreamInfo[] | null

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

Returns ​

RTSPStreamInfo[] | null


interleavedWriteFrame() ​

interleavedWriteFrame(pkt): Promise<number>

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

Parameters ​

pkt ​

NativePacket | null

Returns ​

Promise<number>


interleavedWriteFrameSync() ​

interleavedWriteFrameSync(pkt): number

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

Parameters ​

pkt ​

NativePacket | null

Returns ​

number


interrupt() ​

interrupt(): void

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

Returns ​

void


newStream() ​

newStream(c): NativeStream

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

Parameters ​

c ​

NativeCodec | null

Returns ​

NativeStream


openInput() ​

openInput(url, fmt, options): Promise<number>

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

Parameters ​

url ​

string

fmt ​

NativeInputFormat | null

options ​

NativeDictionary | null

Returns ​

Promise<number>


openInputSync() ​

openInputSync(url, fmt, options): number

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

Parameters ​

url ​

string

fmt ​

NativeInputFormat | null

options ​

NativeDictionary | null

Returns ​

number


openOutput() ​

openOutput(): Promise<number>

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

Returns ​

Promise<number>


openOutputSync() ​

openOutputSync(): number

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

Returns ​

number


readFrame() ​

readFrame(pkt): Promise<number>

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

Parameters ​

pkt ​

NativePacket

Returns ​

Promise<number>


readFrameSync() ​

readFrameSync(pkt): number

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

Parameters ​

pkt ​

NativePacket

Returns ​

number


seekFile() ​

seekFile(streamIndex, minTs, ts, maxTs, flags): Promise<number>

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

Parameters ​

streamIndex ​

number

minTs ​

bigint

ts ​

bigint

maxTs ​

bigint

flags ​

AVSeekFlag

Returns ​

Promise<number>


seekFileSync() ​

seekFileSync(streamIndex, minTs, ts, maxTs, flags): number

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

Parameters ​

streamIndex ​

number

minTs ​

bigint

ts ​

bigint

maxTs ​

bigint

flags ​

AVSeekFlag

Returns ​

number


seekFrame() ​

seekFrame(streamIndex, timestamp, flags): Promise<number>

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

Parameters ​

streamIndex ​

number

timestamp ​

bigint

flags ​

AVSeekFlag

Returns ​

Promise<number>


seekFrameSync() ​

seekFrameSync(streamIndex, timestamp, flags): number

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

Parameters ​

streamIndex ​

number

timestamp ​

bigint

flags ​

AVSeekFlag

Returns ​

number


sendRTSPPacket() ​

sendRTSPPacket(streamIndex, rtpData): Promise<number>

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

Parameters ​

streamIndex ​

number

rtpData ​

Buffer

Returns ​

Promise<number>


sendRTSPPacketSync() ​

sendRTSPPacketSync(streamIndex, rtpData): number

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

Parameters ​

streamIndex ​

number

rtpData ​

Buffer

Returns ​

number


writeFrame() ​

writeFrame(pkt): Promise<number>

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

Parameters ​

pkt ​

NativePacket | null

Returns ​

Promise<number>


writeFrameSync() ​

writeFrameSync(pkt): number

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

Parameters ​

pkt ​

NativePacket | null

Returns ​

number


writeHeader() ​

writeHeader(options): Promise<number>

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

Parameters ​

options ​

NativeDictionary | null

Returns ​

Promise<number>


writeHeaderSync() ​

writeHeaderSync(options): number

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

Parameters ​

options ​

NativeDictionary | null

Returns ​

number


writeTrailer() ​

writeTrailer(): Promise<number>

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

Returns ​

Promise<number>


writeTrailerSync() ​

writeTrailerSync(): number

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

Returns ​

number