NodeAV

Appearance

node-av / lib / OptionMember

Interface: OptionMember<T> ​

Defined in: src/lib/option.ts:998

Base class for FFmpeg objects that support AVOptions.

Provides a common interface for getting, setting, and listing options on FFmpeg objects that have an AVClass structure. This includes codecs, formats, filters, and various processing contexts.

Classes that support AVOptions should extend this class to inherit the option management functionality.

Example ​

typescript
import { OptionMember, FFmpegError } from 'node-av';
import { AV_OPT_TYPE_INT, AV_OPT_TYPE_STRING, AV_OPT_TYPE_RATIONAL } from 'node-av/constants';

class CodecContext extends OptionMember<NativeCodecContext> {
  constructor(native: NativeCodecContext) {
    super(native);
  }
}

// Use inherited methods
const codec = new CodecContext(native);

// Set options with automatic type handling
let ret = codec.setOption('preset', 'fast');
FFmpegError.throwIfError(ret, 'set preset');

ret = codec.setOption('bitrate', 2000000, AV_OPT_TYPE_INT);
FFmpegError.throwIfError(ret, 'set bitrate');

ret = codec.setOption('framerate', { num: 30, den: 1 }, AV_OPT_TYPE_RATIONAL);
FFmpegError.throwIfError(ret, 'set framerate');

// Get typed options
const preset = codec.getOption('preset');
const bitrate = codec.getOption('bitrate', AV_OPT_TYPE_INT);
const framerate = codec.getOption('framerate', AV_OPT_TYPE_RATIONAL);

// List all available options
const options = codec.listOptions();
for (const opt of options) {
  console.log(`${opt.name}: ${opt.help}`);
}

See ​

Extended by ​

Type Parameters ​

T ​

T extends OptionCapableObject

The native FFmpeg object type that supports AVOptions

Properties ​

native ​

protected native: T

Defined in: src/lib/option.ts:999

Methods ​

getOption() ​

Get an option value from this object.

Uses the AVOption API to retrieve options.

Direct mapping to av_opt_get* functions.

Param ​

Option name

Param ​

Option type (defaults to AV_OPT_TYPE_STRING)

Param ​

Search flags (default: AV_OPT_SEARCH_CHILDREN)

Example ​

typescript
import { AV_OPT_TYPE_STRING, AV_OPT_TYPE_RATIONAL, AV_OPT_TYPE_PIXEL_FMT, AV_OPT_TYPE_INT64 } from 'node-av/constants';

// String options (default)
const preset = obj.getOption('preset');
const codec = obj.getOption('codec', AV_OPT_TYPE_STRING);

// Typed options
const framerate = obj.getOption('framerate', AV_OPT_TYPE_RATIONAL); // Returns {num, den}
const pixFmt = obj.getOption('pix_fmt', AV_OPT_TYPE_PIXEL_FMT); // Returns AVPixelFormat
const bitrate = obj.getOption('bitrate', AV_OPT_TYPE_INT64); // Returns bigint

Call Signature ​

getOption(name, type?, searchFlags?): null | string

Defined in: src/lib/option.ts:1217

Parameters ​
name ​

string

type? ​

AVOptionTypeString

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | string

Call Signature ​

getOption(name, type, searchFlags?): null | string

Defined in: src/lib/option.ts:1218

Parameters ​
name ​

string

type ​

AVOptionTypeColor

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | string

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1221

Parameters ​
name ​

string

type ​

AVOptionTypeInt

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | bigint

Defined in: src/lib/option.ts:1222

Parameters ​
name ​

string

type ​

AVOptionTypeInt64

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | bigint

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1223

Parameters ​
name ​

string

type ​

AVOptionTypeUint

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | bigint

Defined in: src/lib/option.ts:1224

Parameters ​
name ​

string

type ​

AVOptionTypeUint64

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | bigint

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1225

Parameters ​
name ​

string

type ​

AVOptionTypeFlags

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | boolean

Defined in: src/lib/option.ts:1226

Parameters ​
name ​

string

type ​

AVOptionTypeBool

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | boolean

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1227

Parameters ​
name ​

string

type ​

AVOptionTypeDuration

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1228

Parameters ​
name ​

string

type ​

AVOptionTypeConst

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1231

Parameters ​
name ​

string

type ​

AVOptionTypeDouble

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | number

Defined in: src/lib/option.ts:1232

Parameters ​
name ​

string

type ​

AVOptionTypeFloat

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | number

Call Signature ​

getOption(name, type, searchFlags?): null | IRational

Defined in: src/lib/option.ts:1235

Parameters ​
name ​

string

type ​

AVOptionTypeRational

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | IRational

Call Signature ​

getOption(name, type, searchFlags?): null | IRational

Defined in: src/lib/option.ts:1236

Parameters ​
name ​

string

type ​

AVOptionTypeVideoRate

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | IRational

Call Signature ​

getOption(name, type, searchFlags?): null | AVPixelFormat

Defined in: src/lib/option.ts:1237

Parameters ​
name ​

string

type ​

AVOptionTypePixelFmt

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | AVPixelFormat

Call Signature ​

getOption(name, type, searchFlags?): null | AVSampleFormat

Defined in: src/lib/option.ts:1238

Parameters ​
name ​

string

type ​

AVOptionTypeSampleFmt

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | AVSampleFormat

Call Signature ​

getOption(name, type, searchFlags?): null | { height: number; width: number; }

Defined in: src/lib/option.ts:1239

Parameters ​
name ​

string

type ​

AVOptionTypeImageSize

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | { height: number; width: number; }

Call Signature ​

getOption(name, type, searchFlags?): null | ChannelLayout

Defined in: src/lib/option.ts:1240

Parameters ​
name ​

string

type ​

AVOptionTypeChLayout

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | ChannelLayout

Call Signature ​

getOption(name, type, searchFlags?): null | Dictionary

Defined in: src/lib/option.ts:1241

Parameters ​
name ​

string

type ​

AVOptionTypeDict

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | Dictionary

Call Signature ​

getOption(name, type, searchFlags?): null | string

Defined in: src/lib/option.ts:1242

Parameters ​
name ​

string

type ​

AVOptionTypeBinary

searchFlags? ​

AVOptionSearchFlags

Returns ​

null | string

listOptions() ​

listOptions(): OptionInfo[]

Defined in: src/lib/option.ts:1358

List all available options for this object.

Uses the AVOption API to enumerate all options. Useful for discovering available settings and their types.

Direct mapping to av_opt_next() iteration.

Returns ​

OptionInfo[]

Array of option information objects

Example ​

typescript
const options = obj.listOptions();
for (const opt of options) {
  console.log(`${opt.name}: ${opt.help}`);
  console.log(`  Type: ${opt.type}, Default: ${opt.defaultValue}`);
  console.log(`  Range: ${opt.min} - ${opt.max}`);
}

See ​

OptionInfo For option metadata structure

setOption() ​

Set an option on this object.

Uses the AVOption API to set options. Available options depend on the specific object type.

Direct mapping to av_opt_set* functions.

Param ​

Option name

Param ​

Option value

Param ​

Option type (defaults to AV_OPT_TYPE_STRING)

Param ​

Search flags (default: AV_OPT_SEARCH_CHILDREN)

Example ​

typescript
import { FFmpegError } from 'node-av';
import { AV_OPT_TYPE_STRING, AV_OPT_TYPE_INT64, AV_OPT_TYPE_RATIONAL, AV_OPT_TYPE_PIXEL_FMT } from 'node-av/constants';

// String options (default)
let ret = obj.setOption('preset', 'fast');
FFmpegError.throwIfError(ret, 'set preset');

ret = obj.setOption('codec', 'h264', AV_OPT_TYPE_STRING);
FFmpegError.throwIfError(ret, 'set codec');

// Integer options
ret = obj.setOption('bitrate', 2000000, AV_OPT_TYPE_INT64);
FFmpegError.throwIfError(ret, 'set bitrate');

ret = obj.setOption('threads', 4, AV_OPT_TYPE_INT);
FFmpegError.throwIfError(ret, 'set threads');

// Complex types with proper types
ret = obj.setOption('framerate', {num: 30, den: 1}, AV_OPT_TYPE_RATIONAL);
FFmpegError.throwIfError(ret, 'set framerate');

ret = obj.setOption('pix_fmt', AV_PIX_FMT_YUV420P, AV_OPT_TYPE_PIXEL_FMT);
FFmpegError.throwIfError(ret, 'set pixel format');

Call Signature ​

setOption(name, value, type?, searchFlags?): number

Defined in: src/lib/option.ts:1006

Parameters ​
name ​

string

value ​

string

type? ​

AVOptionTypeString

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1007

Parameters ​
name ​

string

value ​

string

type ​

AVOptionTypeColor

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1010

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeInt

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1011

Parameters ​
name ​

string

value ​

bigint

type ​

AVOptionTypeInt64

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1012

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeUint

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1013

Parameters ​
name ​

string

value ​

bigint

type ​

AVOptionTypeUint64

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1014

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeFlags

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1015

Parameters ​
name ​

string

value ​

boolean

type ​

AVOptionTypeBool

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1016

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeDuration

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1017

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeConst

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1020

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeDouble

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1021

Parameters ​
name ​

string

value ​

number

type ​

AVOptionTypeFloat

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1024

Parameters ​
name ​

string

value ​

IRational

type ​

AVOptionTypeRational

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1025

Parameters ​
name ​

string

value ​

IRational

type ​

AVOptionTypeVideoRate

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1026

Parameters ​
name ​

string

value ​

AVPixelFormat

type ​

AVOptionTypePixelFmt

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1027

Parameters ​
name ​

string

value ​

AVSampleFormat

type ​

AVOptionTypeSampleFmt

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1028

Parameters ​
name ​

string

value ​
height ​

number

width ​

number

type ​

AVOptionTypeImageSize

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1029

Parameters ​
name ​

string

value ​

number | bigint

type ​

AVOptionTypeChLayout

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1030

Parameters ​
name ​

string

value ​

Buffer

type ​

AVOptionTypeBinary

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1031

Parameters ​
name ​

string

value ​

number[]

type ​

AVOptionTypeBinaryIntArray

searchFlags? ​

AVOptionSearchFlags

Returns ​

number

Call Signature ​

setOption(name, value, type, searchFlags?): number

Defined in: src/lib/option.ts:1032

Parameters ​
name ​

string

value ​

Dictionary

type ​

AVOptionTypeDict

searchFlags? ​

AVOptionSearchFlags

Returns ​

number