node-av 1.2.0 → 1.3.0

package/dist/lib/option.d.ts

@@ -225,6 +225,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as string, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec preset option
+     * const preset = Option.get(codecContext, 'preset', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Codec preset:', preset); // 'medium', 'fast', etc.
+     * ```
      */
     static get(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): string | null;
     /**
@@ -236,6 +243,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as integer, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec GOP size
+     * const gopSize = Option.getInt(codecContext, 'g', AV_OPT_SEARCH_CHILDREN);
+     * console.log('GOP size:', gopSize); // 60, 120, etc.
+     * ```
      */
     static getInt(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): number | null;
     /**
@@ -247,6 +261,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as double, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec quality scale
+     * const crf = Option.getDouble(codecContext, 'crf', AV_OPT_SEARCH_CHILDREN);
+     * console.log('CRF value:', crf); // 23.0, 18.0, etc.
+     * ```
      */
     static getDouble(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): number | null;
     /**
@@ -258,6 +279,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as rational, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec time base
+     * const timeBase = Option.getRational(codecContext, 'time_base', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Time base:', timeBase); // { num: 1, den: 30 }
+     * ```
      */
     static getRational(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): IRational | null;
     /**
@@ -269,6 +297,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Pixel format value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get filter pixel format
+     * const pixFmt = Option.getPixelFormat(filterContext, 'pix_fmt', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Pixel format:', pixFmt); // AV_PIX_FMT_YUV420P, etc.
+     * ```
      */
     static getPixelFormat(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): AVPixelFormat | null;
     /**
@@ -280,6 +315,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Sample format value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get audio codec sample format
+     * const sampleFmt = Option.getSampleFormat(codecContext, 'sample_fmt', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Sample format:', sampleFmt); // AV_SAMPLE_FMT_FLTP, etc.
+     * ```
      */
     static getSampleFormat(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): AVSampleFormat | null;
     /**
@@ -291,6 +333,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Width and height, or null
+     *
+     * @example
+     * ```typescript
+     * // Get filter output size
+     * const size = Option.getImageSize(filterContext, 'size', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Output size:', size); // { width: 1920, height: 1080 }
+     * ```
      */
     static getImageSize(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): {
         width: number;
@@ -305,6 +354,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Channel layout, or null
+     *
+     * @example
+     * ```typescript
+     * // Get audio channel layout
+     * const layout = Option.getChannelLayout(codecContext, 'channel_layout', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Channel layout:', layout); // stereo, 5.1, etc.
+     * ```
      */
     static getChannelLayout(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): ChannelLayout | null;
     /**
@@ -316,6 +372,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Dictionary value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get metadata dictionary
+     * const metadata = Option.getDict(formatContext, 'metadata', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Metadata:', metadata?.get('title'));
+     * ```
      */
     static getDict(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): Dictionary | null;
     /**
@@ -328,6 +391,13 @@ export declare class Option {
      * @param value - String value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec preset
+     * const ret = Option.set(codecContext, 'preset', 'fast', AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set preset');
+     * ```
      */
     static set(obj: OptionCapableObject, name: string, value: string, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -340,6 +410,13 @@ export declare class Option {
      * @param value - Integer value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec bitrate
+     * const ret = Option.setInt(codecContext, 'b', 2000000, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set bitrate');
+     * ```
      */
     static setInt(obj: OptionCapableObject, name: string, value: number | bigint, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -352,6 +429,13 @@ export declare class Option {
      * @param value - Double value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec CRF value
+     * const ret = Option.setDouble(codecContext, 'crf', 23.0, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set CRF');
+     * ```
      */
     static setDouble(obj: OptionCapableObject, name: string, value: number, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -364,6 +448,13 @@ export declare class Option {
      * @param value - Rational value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec frame rate
+     * const ret = Option.setRational(codecContext, 'framerate', { num: 30, den: 1 }, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set framerate');
+     * ```
      */
     static setRational(obj: OptionCapableObject, name: string, value: IRational, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -376,6 +467,13 @@ export declare class Option {
      * @param value - Pixel format
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set filter pixel format
+     * const ret = Option.setPixelFormat(filterContext, 'pix_fmt', AV_PIX_FMT_YUV420P, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set pixel format');
+     * ```
      */
     static setPixelFormat(obj: OptionCapableObject, name: string, value: AVPixelFormat, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -388,6 +486,13 @@ export declare class Option {
      * @param value - Sample format
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set audio codec sample format
+     * const ret = Option.setSampleFormat(codecContext, 'sample_fmt', AV_SAMPLE_FMT_FLTP, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set sample format');
+     * ```
      */
     static setSampleFormat(obj: OptionCapableObject, name: string, value: AVSampleFormat, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -401,6 +506,13 @@ export declare class Option {
      * @param height - Image height
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set filter output size
+     * const ret = Option.setImageSize(filterContext, 'size', 1920, 1080, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set image size');
+     * ```
      */
     static setImageSize(obj: OptionCapableObject, name: string, width: number, height: number, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -413,6 +525,13 @@ export declare class Option {
      * @param value - Channel layout
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set audio channel layout to stereo
+     * const ret = Option.setChannelLayout(codecContext, 'channel_layout', AV_CHANNEL_LAYOUT_STEREO, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set channel layout');
+     * ```
      */
     static setChannelLayout(obj: OptionCapableObject, name: string, value: number, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -425,6 +544,15 @@ export declare class Option {
      * @param value - Dictionary value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set metadata dictionary
+     * const dict = new Dictionary();
+     * dict.set('title', 'My Video');
+     * const ret = Option.setDict(formatContext, 'metadata', dict, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set metadata');
+     * ```
      */
     static setDict(obj: OptionCapableObject, name: string, value: Dictionary, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -437,6 +565,14 @@ export declare class Option {
      * @param value - Binary data
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set binary extradata
+     * const extradata = Buffer.from([0x00, 0x01, 0x02, 0x03]);
+     * const ret = Option.setBin(codecContext, 'extradata', extradata, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set extradata');
+     * ```
      */
     static setBin(obj: OptionCapableObject, name: string, value: Buffer, searchFlags?: AVOptionSearchFlags): number;
     /**
@@ -447,6 +583,12 @@ export declare class Option {
      * Direct mapping to av_opt_set_defaults().
      *
      * @param obj - Object to reset
+     *
+     * @example
+     * ```typescript
+     * // Reset all codec options to defaults
+     * Option.setDefaults(codecContext);
+     * ```
      */
     static setDefaults(obj: OptionCapableObject): void;
     /**
@@ -459,6 +601,13 @@ export declare class Option {
      * @param dest - Destination object
      * @param src - Source object
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Copy options from one codec context to another
+     * const ret = Option.copy(destCodecContext, srcCodecContext);
+     * FFmpegError.throwIfError(ret, 'Failed to copy options');
+     * ```
      */
     static copy(dest: OptionCapableObject, src: OptionCapableObject): number;
     /**
@@ -470,6 +619,13 @@ export declare class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns True if default, false if modified, null if not found
+     *
+     * @example
+     * ```typescript
+     * // Check if bitrate is at default value
+     * const isDefault = Option.isSetToDefault(codecContext, 'b', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Bitrate is default:', isDefault);
+     * ```
      */
     static isSetToDefault(obj: OptionCapableObject, name: string, searchFlags?: AVOptionSearchFlags): boolean | null;
     /**
@@ -483,6 +639,13 @@ export declare class Option {
      * @param keyValSep - Key-value separator
      * @param pairsSep - Pairs separator
      * @returns Serialized string, or null on error
+     *
+     * @example
+     * ```typescript
+     * // Serialize codec options to string
+     * const serialized = Option.serialize(codecContext, 0, 0, '=', ':');
+     * console.log('Options:', serialized); // 'bitrate=2000000:preset=fast'
+     * ```
      */
     static serialize(obj: OptionCapableObject, optFlags?: number, flags?: number, keyValSep?: string, pairsSep?: string): string | null;
     /**
@@ -491,6 +654,12 @@ export declare class Option {
      * Direct mapping to av_opt_free().
      *
      * @param obj - Object to free options from
+     *
+     * @example
+     * ```typescript
+     * // Free codec context options
+     * Option.free(codecContext);
+     * ```
      */
     static free(obj: OptionCapableObject): void;
     /**
@@ -502,6 +671,13 @@ export declare class Option {
      * @param reqFlags - Required flags
      * @param rejFlags - Rejected flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Show all codec options for debugging
+     * const ret = Option.show(codecContext, 0, 0);
+     * FFmpegError.throwIfError(ret, 'Failed to show options');
+     * ```
      */
     static show(obj: OptionCapableObject, reqFlags?: number, rejFlags?: number): number;
 }

package/dist/lib/option.js

@@ -255,6 +255,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as string, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec preset option
+     * const preset = Option.get(codecContext, 'preset', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Codec preset:', preset); // 'medium', 'fast', etc.
+     * ```
      */
     static get(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.get(obj, name, searchFlags);
@@ -268,6 +275,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as integer, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec GOP size
+     * const gopSize = Option.getInt(codecContext, 'g', AV_OPT_SEARCH_CHILDREN);
+     * console.log('GOP size:', gopSize); // 60, 120, etc.
+     * ```
      */
     static getInt(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getInt(obj, name, searchFlags);
@@ -281,6 +295,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as double, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec quality scale
+     * const crf = Option.getDouble(codecContext, 'crf', AV_OPT_SEARCH_CHILDREN);
+     * console.log('CRF value:', crf); // 23.0, 18.0, etc.
+     * ```
      */
     static getDouble(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getDouble(obj, name, searchFlags);
@@ -294,6 +315,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Option value as rational, or null
+     *
+     * @example
+     * ```typescript
+     * // Get codec time base
+     * const timeBase = Option.getRational(codecContext, 'time_base', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Time base:', timeBase); // { num: 1, den: 30 }
+     * ```
      */
     static getRational(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getRational(obj, name, searchFlags);
@@ -307,6 +335,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Pixel format value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get filter pixel format
+     * const pixFmt = Option.getPixelFormat(filterContext, 'pix_fmt', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Pixel format:', pixFmt); // AV_PIX_FMT_YUV420P, etc.
+     * ```
      */
     static getPixelFormat(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getPixelFormat(obj, name, searchFlags);
@@ -320,6 +355,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Sample format value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get audio codec sample format
+     * const sampleFmt = Option.getSampleFormat(codecContext, 'sample_fmt', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Sample format:', sampleFmt); // AV_SAMPLE_FMT_FLTP, etc.
+     * ```
      */
     static getSampleFormat(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getSampleFormat(obj, name, searchFlags);
@@ -333,6 +375,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Width and height, or null
+     *
+     * @example
+     * ```typescript
+     * // Get filter output size
+     * const size = Option.getImageSize(filterContext, 'size', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Output size:', size); // { width: 1920, height: 1080 }
+     * ```
      */
     static getImageSize(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getImageSize(obj, name, searchFlags);
@@ -346,6 +395,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Channel layout, or null
+     *
+     * @example
+     * ```typescript
+     * // Get audio channel layout
+     * const layout = Option.getChannelLayout(codecContext, 'channel_layout', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Channel layout:', layout); // stereo, 5.1, etc.
+     * ```
      */
     static getChannelLayout(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.getChannelLayout(obj, name, searchFlags);
@@ -359,6 +415,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns Dictionary value, or null
+     *
+     * @example
+     * ```typescript
+     * // Get metadata dictionary
+     * const metadata = Option.getDict(formatContext, 'metadata', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Metadata:', metadata?.get('title'));
+     * ```
      */
     static getDict(obj, name, searchFlags = AVFLAG_NONE) {
         const native = bindings.Option.getDict(obj, name, searchFlags);
@@ -374,6 +437,13 @@ export class Option {
      * @param value - String value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec preset
+     * const ret = Option.set(codecContext, 'preset', 'fast', AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set preset');
+     * ```
      */
     static set(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.set(obj, name, value, searchFlags);
@@ -388,6 +458,13 @@ export class Option {
      * @param value - Integer value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec bitrate
+     * const ret = Option.setInt(codecContext, 'b', 2000000, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set bitrate');
+     * ```
      */
     static setInt(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setInt(obj, name, value, searchFlags);
@@ -402,6 +479,13 @@ export class Option {
      * @param value - Double value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec CRF value
+     * const ret = Option.setDouble(codecContext, 'crf', 23.0, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set CRF');
+     * ```
      */
     static setDouble(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setDouble(obj, name, value, searchFlags);
@@ -416,6 +500,13 @@ export class Option {
      * @param value - Rational value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set codec frame rate
+     * const ret = Option.setRational(codecContext, 'framerate', { num: 30, den: 1 }, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set framerate');
+     * ```
      */
     static setRational(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setRational(obj, name, value, searchFlags);
@@ -430,6 +521,13 @@ export class Option {
      * @param value - Pixel format
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set filter pixel format
+     * const ret = Option.setPixelFormat(filterContext, 'pix_fmt', AV_PIX_FMT_YUV420P, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set pixel format');
+     * ```
      */
     static setPixelFormat(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setPixelFormat(obj, name, value, searchFlags);
@@ -444,6 +542,13 @@ export class Option {
      * @param value - Sample format
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set audio codec sample format
+     * const ret = Option.setSampleFormat(codecContext, 'sample_fmt', AV_SAMPLE_FMT_FLTP, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set sample format');
+     * ```
      */
     static setSampleFormat(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setSampleFormat(obj, name, value, searchFlags);
@@ -459,6 +564,13 @@ export class Option {
      * @param height - Image height
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set filter output size
+     * const ret = Option.setImageSize(filterContext, 'size', 1920, 1080, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set image size');
+     * ```
      */
     static setImageSize(obj, name, width, height, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setImageSize(obj, name, width, height, searchFlags);
@@ -473,6 +585,13 @@ export class Option {
      * @param value - Channel layout
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set audio channel layout to stereo
+     * const ret = Option.setChannelLayout(codecContext, 'channel_layout', AV_CHANNEL_LAYOUT_STEREO, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set channel layout');
+     * ```
      */
     static setChannelLayout(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setChannelLayout(obj, name, value, searchFlags);
@@ -487,6 +606,15 @@ export class Option {
      * @param value - Dictionary value
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set metadata dictionary
+     * const dict = new Dictionary();
+     * dict.set('title', 'My Video');
+     * const ret = Option.setDict(formatContext, 'metadata', dict, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set metadata');
+     * ```
      */
     static setDict(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setDict(obj, name, value.getNative(), searchFlags);
@@ -501,6 +629,14 @@ export class Option {
      * @param value - Binary data
      * @param searchFlags - Search flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Set binary extradata
+     * const extradata = Buffer.from([0x00, 0x01, 0x02, 0x03]);
+     * const ret = Option.setBin(codecContext, 'extradata', extradata, AV_OPT_SEARCH_CHILDREN);
+     * FFmpegError.throwIfError(ret, 'Failed to set extradata');
+     * ```
      */
     static setBin(obj, name, value, searchFlags = AVFLAG_NONE) {
         return bindings.Option.setBin(obj, name, value, searchFlags);
@@ -513,6 +649,12 @@ export class Option {
      * Direct mapping to av_opt_set_defaults().
      *
      * @param obj - Object to reset
+     *
+     * @example
+     * ```typescript
+     * // Reset all codec options to defaults
+     * Option.setDefaults(codecContext);
+     * ```
      */
     static setDefaults(obj) {
         bindings.Option.setDefaults(obj);
@@ -527,6 +669,13 @@ export class Option {
      * @param dest - Destination object
      * @param src - Source object
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Copy options from one codec context to another
+     * const ret = Option.copy(destCodecContext, srcCodecContext);
+     * FFmpegError.throwIfError(ret, 'Failed to copy options');
+     * ```
      */
     static copy(dest, src) {
         return bindings.Option.copy(dest, src);
@@ -540,6 +689,13 @@ export class Option {
      * @param name - Option name
      * @param searchFlags - Search flags
      * @returns True if default, false if modified, null if not found
+     *
+     * @example
+     * ```typescript
+     * // Check if bitrate is at default value
+     * const isDefault = Option.isSetToDefault(codecContext, 'b', AV_OPT_SEARCH_CHILDREN);
+     * console.log('Bitrate is default:', isDefault);
+     * ```
      */
     static isSetToDefault(obj, name, searchFlags = AVFLAG_NONE) {
         return bindings.Option.isSetToDefault(obj, name, searchFlags);
@@ -555,6 +711,13 @@ export class Option {
      * @param keyValSep - Key-value separator
      * @param pairsSep - Pairs separator
      * @returns Serialized string, or null on error
+     *
+     * @example
+     * ```typescript
+     * // Serialize codec options to string
+     * const serialized = Option.serialize(codecContext, 0, 0, '=', ':');
+     * console.log('Options:', serialized); // 'bitrate=2000000:preset=fast'
+     * ```
      */
     static serialize(obj, optFlags = 0, flags = 0, keyValSep = '=', pairsSep = ',') {
         return bindings.Option.serialize(obj, optFlags, flags, keyValSep, pairsSep);
@@ -565,6 +728,12 @@ export class Option {
      * Direct mapping to av_opt_free().
      *
      * @param obj - Object to free options from
+     *
+     * @example
+     * ```typescript
+     * // Free codec context options
+     * Option.free(codecContext);
+     * ```
      */
     static free(obj) {
         bindings.Option.free(obj);
@@ -578,6 +747,13 @@ export class Option {
      * @param reqFlags - Required flags
      * @param rejFlags - Rejected flags
      * @returns 0 on success, negative AVERROR on error
+     *
+     * @example
+     * ```typescript
+     * // Show all codec options for debugging
+     * const ret = Option.show(codecContext, 0, 0);
+     * FFmpegError.throwIfError(ret, 'Failed to show options');
+     * ```
      */
     static show(obj, reqFlags = 0, rejFlags = 0) {
         return bindings.Option.show(obj, reqFlags, rejFlags);