NodeAV

Appearance

node-av / lib/native-types / NativeFrame

Interface: NativeFrame ​

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

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

alphaMode ​

alphaMode: AVAlphaMode

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

bestEffortTimestamp ​

bestEffortTimestamp: bigint

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

channelLayout ​

channelLayout: ChannelLayout

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

channels ​

readonly channels: number

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

chromaLocation ​

chromaLocation: AVChromaLocation

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

colorPrimaries ​

colorPrimaries: AVColorPrimaries

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

colorRange ​

colorRange: AVColorRange

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

colorSpace ​

colorSpace: AVColorSpace

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

colorTrc ​

colorTrc: AVColorTransferCharacteristic

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

data ​

readonly data: Buffer<ArrayBufferLike>[] | null

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

decodeErrorFlags ​

decodeErrorFlags: number

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

duration ​

duration: bigint

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

extendedData ​

readonly extendedData: Buffer<ArrayBufferLike>[] | null

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

flags ​

flags: number

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

format ​

format: AVPixelFormat | AVSampleFormat

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

height ​

height: number

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

hwFramesCtx ​

hwFramesCtx: NativeHardwareFramesContext | null

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

isWritable ​

readonly isWritable: boolean

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

keyFrame ​

keyFrame: number

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

linesize ​

readonly linesize: number[]

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

nbSamples ​

nbSamples: number

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

pictType ​

pictType: AVPictureType

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

pktDts ​

pktDts: bigint

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

pts ​

pts: bigint

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

quality ​

quality: number

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

repeatPict ​

repeatPict: number

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

sampleAspectRatio ​

sampleAspectRatio: IRational

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

sampleRate ​

sampleRate: number

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

timeBase ​

timeBase: IRational

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

width ​

width: number

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

Methods ​

[dispose]() ​

[dispose](): void

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

Returns ​

void

Overrides ​

Disposable.[dispose]

alloc() ​

alloc(): void

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

Returns ​

void

allocBuffer() ​

allocBuffer(): number

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

Returns ​

number

applyCropping() ​

applyCropping(flags?): number

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

Parameters ​

flags? ​

number

Returns ​

number

clone() ​

clone(): NativeFrame | null

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

Returns ​

NativeFrame | null

copy() ​

copy(src): number

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

Parameters ​

src ​

NativeFrame

Returns ​

number

copyProps() ​

copyProps(src): number

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

Parameters ​

src ​

NativeFrame

Returns ​

number

free() ​

free(): void

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

Returns ​

void

fromBuffer() ​

fromBuffer(buffer): number

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

Parameters ​

buffer ​

Buffer

Returns ​

number

getBuffer() ​

getBuffer(align?): number

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

Parameters ​

align? ​

number

Returns ​

number

getMetadata() ​

getMetadata(): NativeDictionary

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

Returns ​

NativeDictionary

getSideData() ​

getSideData(type): Buffer<ArrayBufferLike> | null

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

Parameters ​

type ​

AVFrameSideDataType

Returns ​

Buffer<ArrayBufferLike> | null

hwframeTransferData() ​

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

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

Parameters ​

dst ​

NativeFrame

flags? ​

number

Returns ​

Promise<number>

hwframeTransferDataSync() ​

hwframeTransferDataSync(dst, flags?): number

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

Parameters ​

dst ​

NativeFrame

flags? ​

number

Returns ​

number

importD3D11Texture() ​

importD3D11Texture(handleData, hwDeviceCtx): number

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

Parameters ​

handleData ​

Buffer

hwDeviceCtx ​

NativeHardwareDeviceContext

Returns ​

number

importDmaBuf() ​

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

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

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

Parameters ​

handleData ​

Buffer

hwFramesCtx ​

NativeHardwareFramesContext

Returns ​

number

importNSImage() ​

importNSImage(handleData): number

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

Parameters ​

handleData ​

Buffer

Returns ​

number

isHwFrame() ​

isHwFrame(): boolean

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

Returns ​

boolean

isSwFrame() ​

isSwFrame(): boolean

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

Returns ​

boolean

makeWritable() ​

makeWritable(): number

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

Returns ​

number

newSideData() ​

newSideData(type, size): Buffer

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

Parameters ​

type ​

AVFrameSideDataType

size ​

number

Returns ​

Buffer

ref() ​

ref(src): number

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

Parameters ​

src ​

NativeFrame

Returns ​

number

removeSideData() ​

removeSideData(type): void

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

Parameters ​

type ​

AVFrameSideDataType

Returns ​

void

toBuffer() ​

toBuffer(): Buffer

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

Returns ​

Buffer

unref() ​

unref(): void

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

Returns ​

void