node-av / lib/native-types / NativeFrame

Interface: NativeFrame

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

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

---

alphaMode

alphaMode: AVAlphaMode

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

---

bestEffortTimestamp

bestEffortTimestamp: bigint

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

---

channelLayout

channelLayout: ChannelLayout

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

---

channels

readonly channels: number

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

---

chromaLocation

chromaLocation: AVChromaLocation

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

---

colorPrimaries

colorPrimaries: AVColorPrimaries

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

---

colorRange

colorRange: AVColorRange

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

---

colorSpace

colorSpace: AVColorSpace

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

---

colorTrc

colorTrc: AVColorTransferCharacteristic

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

---

data

readonly data: Buffer<ArrayBufferLike>[] | null

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

---

decodeErrorFlags

decodeErrorFlags: number

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

---

duration

duration: bigint

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

---

extendedData

readonly extendedData: Buffer<ArrayBufferLike>[] | null

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

---

flags

flags: number

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

---

format

format: AVPixelFormat | AVSampleFormat

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

---

height

height: number

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

---

hwFramesCtx

hwFramesCtx: NativeHardwareFramesContext | null

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

---

isWritable

readonly isWritable: boolean

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

---

keyFrame

keyFrame: number

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

---

linesize

readonly linesize: number[]

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

---

nbSamples

nbSamples: number

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

---

pictType

pictType: AVPictureType

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

---

pktDts

pktDts: bigint

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

---

pts

pts: bigint

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

---

quality

quality: number

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

---

repeatPict

repeatPict: number

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

---

reportedExternalMemory

readonly reportedExternalMemory: number

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

Internal

Test hook: bytes currently reported to V8 via napi_adjust_external_memory.

---

sampleAspectRatio

sampleAspectRatio: IRational

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

---

sampleRate

sampleRate: number

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

---

timeBase

timeBase: IRational

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

---

width

width: number

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

Methods

[dispose]()

[dispose](): void

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

Returns

void

Overrides

Disposable.[dispose]

---

alloc()

alloc(): void

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

Returns

void

---

allocBuffer()

allocBuffer(): number

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

Returns

number

---

applyCropping()

applyCropping(flags?): number

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

Parameters

flags?

number

Returns

number

---

clone()

clone(): NativeFrame | null

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

Returns

NativeFrame | null

---

copy()

copy(src): number

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

Parameters

src

NativeFrame

Returns

number

---

copyProps()

copyProps(src): number

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

Parameters

src

NativeFrame

Returns

number

---

exportIOSurface()

exportIOSurface(): Buffer<ArrayBufferLike> | null

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

Returns

Buffer<ArrayBufferLike> | null

---

free()

free(): void

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

Returns

void

---

fromBuffer()

fromBuffer(buffer): number

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

Parameters

buffer

Buffer

Returns

number

---

getBuffer()

getBuffer(align?): number

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

Parameters

align?

number

Returns

number

---

getMetadata()

getMetadata(): NativeDictionary

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

Returns

NativeDictionary

---

getSideData()

getSideData(type): Buffer<ArrayBufferLike> | null

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

Parameters

type

AVFrameSideDataType

Returns

Buffer<ArrayBufferLike> | null

---

hwframeTransferData()

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

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

Parameters

dst

NativeFrame

flags?

number

Returns

Promise<number>

---

hwframeTransferDataSync()

hwframeTransferDataSync(dst, flags?): number

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

Parameters

dst

NativeFrame

flags?

number

Returns

number

---

importD3D11Texture()

importD3D11Texture(handleData, hwDeviceCtx): number

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

Parameters

handleData

Buffer

hwDeviceCtx

NativeHardwareDeviceContext

Returns

number

---

importDmaBuf()

importDmaBuf(planes, width, height, modifier, swFormat): number

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

Parameters

planes

object[]

width

number

height

number

modifier

bigint

swFormat

AVPixelFormat

Returns

number

---

importIOSurface()

importIOSurface(handleData, hwFramesCtx): number

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

Parameters

handleData

Buffer

hwFramesCtx

NativeHardwareFramesContext

Returns

number

---

importNSImage()

importNSImage(handleData): number

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

Parameters

handleData

Buffer

Returns

number

---

isHwFrame()

isHwFrame(): boolean

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

Returns

boolean

---

isSwFrame()

isSwFrame(): boolean

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

Returns

boolean

---

makeWritable()

makeWritable(): number

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

Returns

number

---

newSideData()

newSideData(type, size): Buffer

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

Parameters

type

AVFrameSideDataType

size

number

Returns

Buffer

---

ref()

ref(src): number

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

Parameters

src

NativeFrame

Returns

number

---

removeSideData()

removeSideData(type): void

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

Parameters

type

AVFrameSideDataType

Returns

void

---

toBuffer()

toBuffer(): Buffer

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

Returns

Buffer

---

unref()

unref(): void

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

Returns

void