node-av / lib/native-types / NativeFrame

Interface: NativeFrame

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

Internal

Native AVFrame binding interface

Represents uncompressed audio/video data. Must be allocated before use and properly disposed after.

Extends

• Disposable

Properties

__brand

readonly __brand: "NativeFrame"

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

---

bestEffortTimestamp

bestEffortTimestamp: bigint

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

---

channelLayout

channelLayout: ChannelLayout

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

---

channels

readonly channels: number

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

---

chromaLocation

chromaLocation: AVChromaLocation

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

---

colorPrimaries

colorPrimaries: AVColorPrimaries

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

---

colorRange

colorRange: AVColorRange

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

---

colorSpace

colorSpace: AVColorSpace

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

---

colorTrc

colorTrc: AVColorTransferCharacteristic

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

---

data

readonly data: null | Buffer<ArrayBufferLike>[]

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

---

extendedData

readonly extendedData: null | Buffer<ArrayBufferLike>[]

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

---

format

format: AVPixelFormat | AVSampleFormat

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

---

height

height: number

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

---

hwFramesCtx

hwFramesCtx: null | NativeHardwareFramesContext

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

---

isWritable

readonly isWritable: boolean

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

---

keyFrame

keyFrame: number

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

---

linesize

readonly linesize: number[]

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

---

nbSamples

nbSamples: number

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

---

pictType

pictType: AVPictureType

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

---

pktDts

pktDts: bigint

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

---

pts

pts: bigint

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

---

sampleAspectRatio

sampleAspectRatio: IRational

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

---

sampleRate

sampleRate: number

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

---

timeBase

timeBase: IRational

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

---

width

width: number

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

Methods

[dispose]()

[dispose](): void

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

Returns

void

Overrides

Disposable.[dispose]

---

alloc()

alloc(): void

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

Returns

void

---

allocBuffer()

allocBuffer(): number

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

Returns

number

---

clone()

clone(): null | NativeFrame

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

Returns

null | NativeFrame

---

copy()

copy(src): number

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

Parameters

src

NativeFrame

Returns

number

---

copyProps()

copyProps(src): number

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

Parameters

src

NativeFrame

Returns

number

---

free()

free(): void

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

Returns

void

---

fromBuffer()

fromBuffer(buffer): number

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

Parameters

buffer

Buffer

Returns

number

---

getBuffer()

getBuffer(align?): number

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

Parameters

align?

number

Returns

number

---

getSideData()

getSideData(type): null | Buffer<ArrayBufferLike>

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

Parameters

type

AVFrameSideDataType

Returns

null | Buffer<ArrayBufferLike>

---

hwframeTransferData()

hwframeTransferData(dst, flags?): Promise<number>

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

Parameters

dst

NativeFrame

flags?

number

Returns

Promise<number>

---

hwframeTransferDataSync()

hwframeTransferDataSync(dst, flags?): number

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

Parameters

dst

NativeFrame

flags?

number

Returns

number

---

isHwFrame()

isHwFrame(): boolean

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

Returns

boolean

---

isSwFrame()

isSwFrame(): boolean

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

Returns

boolean

---

makeWritable()

makeWritable(): number

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

Returns

number

---

newSideData()

newSideData(type, size): Buffer

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

Parameters

type

AVFrameSideDataType

size

number

Returns

Buffer

---

ref()

ref(src): number

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

Parameters

src

NativeFrame

Returns

number

---

removeSideData()

removeSideData(type): void

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

Parameters

type

AVFrameSideDataType

Returns

void

---

toBuffer()

toBuffer(): Buffer

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

Returns

Buffer

---

unref()

unref(): void

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

Returns

void