Skip to content

node-av / lib / avSampleFmtIsPlanar

Function: avSampleFmtIsPlanar()

avSampleFmtIsPlanar(sampleFmt): boolean

Defined in: src/lib/utilities.ts:169

Check if sample format is planar.

Returns whether the audio sample format stores channels in separate planes (planar) rather than interleaved.

Direct mapping to av_sample_fmt_is_planar().

Parameters

sampleFmt

AVSampleFormat

Audio sample format to check

Returns

boolean

True if planar, false if packed/interleaved

Example

typescript
import { AV_SAMPLE_FMT_S16, AV_SAMPLE_FMT_S16P } from 'node-av/constants';

const isPacked = avSampleFmtIsPlanar(AV_SAMPLE_FMT_S16);  // Returns false
const isPlanar = avSampleFmtIsPlanar(AV_SAMPLE_FMT_S16P); // Returns true

See

av_sample_fmt_is_planar - FFmpeg Doxygen