node-av 1.3.0 → 2.1.0

package/dist/lib/option.d.ts

@@ -33,6 +33,7 @@ export declare class OptionInfo {
     private native;
     /**
      * @param native - The native option instance
+     *
      * @internal
      */
     constructor(native: NativeOption);
@@ -159,7 +160,9 @@ export declare class Option {
      * Direct mapping to av_opt_next().
      *
      * @param obj - Object with options
+     *
      * @param prev - Previous option (null to get first)
+     *
      * @returns Next option, or null if no more
      *
      * @example
@@ -179,8 +182,11 @@ export declare class Option {
      * Direct mapping to av_opt_find().
      *
      * @param obj - Object to search
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option info if found, null otherwise
      *
      * @example
@@ -200,8 +206,11 @@ export declare class Option {
      * Direct mapping to av_opt_find2().
      *
      * @param obj - Object to search
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Object with option and target info
      *
      * @example
@@ -222,8 +231,11 @@ export declare class Option {
      * Direct mapping to av_opt_get().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as string, or null
      *
      * @example
@@ -240,8 +252,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_int().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as integer, or null
      *
      * @example
@@ -258,8 +273,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_double().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as double, or null
      *
      * @example
@@ -276,8 +294,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_q().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as rational, or null
      *
      * @example
@@ -294,8 +315,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_pixel_fmt().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Pixel format value, or null
      *
      * @example
@@ -312,8 +336,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_sample_fmt().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Sample format value, or null
      *
      * @example
@@ -330,8 +357,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_image_size().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Width and height, or null
      *
      * @example
@@ -351,8 +381,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_chlayout().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Channel layout, or null
      *
      * @example
@@ -369,8 +402,11 @@ export declare class Option {
      * Direct mapping to av_opt_get_dict_val().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Dictionary value, or null
      *
      * @example
@@ -387,9 +423,13 @@ export declare class Option {
      * Direct mapping to av_opt_set().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - String value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -406,9 +446,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_int().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Integer value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -425,9 +469,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_double().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Double value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -444,9 +492,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_q().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Rational value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -463,9 +515,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_pixel_fmt().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Pixel format
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -482,9 +538,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_sample_fmt().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Sample format
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -501,10 +561,15 @@ export declare class Option {
      * Direct mapping to av_opt_set_image_size().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param width - Image width
+     *
      * @param height - Image height
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -521,9 +586,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_chlayout().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Channel layout
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -540,9 +609,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_dict_val().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Dictionary value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -561,9 +634,13 @@ export declare class Option {
      * Direct mapping to av_opt_set_bin().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Binary data
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -599,7 +676,9 @@ export declare class Option {
      * Direct mapping to av_opt_copy().
      *
      * @param dest - Destination object
+     *
      * @param src - Source object
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -616,8 +695,11 @@ export declare class Option {
      * Direct mapping to av_opt_is_set_to_default().
      *
      * @param obj - Object to check
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns True if default, false if modified, null if not found
      *
      * @example
@@ -634,10 +716,15 @@ export declare class Option {
      * Direct mapping to av_opt_serialize().
      *
      * @param obj - Object to serialize
+     *
      * @param optFlags - Option flags filter
+     *
      * @param flags - Serialization flags
+     *
      * @param keyValSep - Key-value separator
+     *
      * @param pairsSep - Pairs separator
+     *
      * @returns Serialized string, or null on error
      *
      * @example
@@ -668,8 +755,11 @@ export declare class Option {
      * Direct mapping to av_opt_show2().
      *
      * @param obj - Object to show options for
+     *
      * @param reqFlags - Required flags
+     *
      * @param rejFlags - Rejected flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example

package/dist/lib/option.js

@@ -32,6 +32,7 @@ export class OptionInfo {
     native;
     /**
      * @param native - The native option instance
+     *
      * @internal
      */
     constructor(native) {
@@ -178,7 +179,9 @@ export class Option {
      * Direct mapping to av_opt_next().
      *
      * @param obj - Object with options
+     *
      * @param prev - Previous option (null to get first)
+     *
      * @returns Next option, or null if no more
      *
      * @example
@@ -201,8 +204,11 @@ export class Option {
      * Direct mapping to av_opt_find().
      *
      * @param obj - Object to search
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option info if found, null otherwise
      *
      * @example
@@ -225,8 +231,11 @@ export class Option {
      * Direct mapping to av_opt_find2().
      *
      * @param obj - Object to search
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Object with option and target info
      *
      * @example
@@ -252,8 +261,11 @@ export class Option {
      * Direct mapping to av_opt_get().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as string, or null
      *
      * @example
@@ -272,8 +284,11 @@ export class Option {
      * Direct mapping to av_opt_get_int().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as integer, or null
      *
      * @example
@@ -292,8 +307,11 @@ export class Option {
      * Direct mapping to av_opt_get_double().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as double, or null
      *
      * @example
@@ -312,8 +330,11 @@ export class Option {
      * Direct mapping to av_opt_get_q().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Option value as rational, or null
      *
      * @example
@@ -332,8 +353,11 @@ export class Option {
      * Direct mapping to av_opt_get_pixel_fmt().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Pixel format value, or null
      *
      * @example
@@ -352,8 +376,11 @@ export class Option {
      * Direct mapping to av_opt_get_sample_fmt().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Sample format value, or null
      *
      * @example
@@ -372,8 +399,11 @@ export class Option {
      * Direct mapping to av_opt_get_image_size().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Width and height, or null
      *
      * @example
@@ -392,8 +422,11 @@ export class Option {
      * Direct mapping to av_opt_get_chlayout().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Channel layout, or null
      *
      * @example
@@ -412,8 +445,11 @@ export class Option {
      * Direct mapping to av_opt_get_dict_val().
      *
      * @param obj - Object to query
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns Dictionary value, or null
      *
      * @example
@@ -433,9 +469,13 @@ export class Option {
      * Direct mapping to av_opt_set().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - String value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -454,9 +494,13 @@ export class Option {
      * Direct mapping to av_opt_set_int().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Integer value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -475,9 +519,13 @@ export class Option {
      * Direct mapping to av_opt_set_double().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Double value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -496,9 +544,13 @@ export class Option {
      * Direct mapping to av_opt_set_q().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Rational value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -517,9 +569,13 @@ export class Option {
      * Direct mapping to av_opt_set_pixel_fmt().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Pixel format
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -538,9 +594,13 @@ export class Option {
      * Direct mapping to av_opt_set_sample_fmt().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Sample format
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -559,10 +619,15 @@ export class Option {
      * Direct mapping to av_opt_set_image_size().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param width - Image width
+     *
      * @param height - Image height
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -581,9 +646,13 @@ export class Option {
      * Direct mapping to av_opt_set_chlayout().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Channel layout
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -602,9 +671,13 @@ export class Option {
      * Direct mapping to av_opt_set_dict_val().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Dictionary value
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -625,9 +698,13 @@ export class Option {
      * Direct mapping to av_opt_set_bin().
      *
      * @param obj - Object to modify
+     *
      * @param name - Option name
+     *
      * @param value - Binary data
+     *
      * @param searchFlags - Search flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -667,7 +744,9 @@ export class Option {
      * Direct mapping to av_opt_copy().
      *
      * @param dest - Destination object
+     *
      * @param src - Source object
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -686,8 +765,11 @@ export class Option {
      * Direct mapping to av_opt_is_set_to_default().
      *
      * @param obj - Object to check
+     *
      * @param name - Option name
+     *
      * @param searchFlags - Search flags
+     *
      * @returns True if default, false if modified, null if not found
      *
      * @example
@@ -706,10 +788,15 @@ export class Option {
      * Direct mapping to av_opt_serialize().
      *
      * @param obj - Object to serialize
+     *
      * @param optFlags - Option flags filter
+     *
      * @param flags - Serialization flags
+     *
      * @param keyValSep - Key-value separator
+     *
      * @param pairsSep - Pairs separator
+     *
      * @returns Serialized string, or null on error
      *
      * @example
@@ -744,8 +831,11 @@ export class Option {
      * Direct mapping to av_opt_show2().
      *
      * @param obj - Object to show options for
+     *
      * @param reqFlags - Required flags
+     *
      * @param rejFlags - Rejected flags
+     *
      * @returns 0 on success, negative AVERROR on error
      *
      * @example
@@ -824,9 +914,13 @@ export class OptionMember {
      * Direct mapping to av_opt_set* functions.
      *
      * @param name - Option name
+     *
      * @param value - Option value
+     *
      * @param type - Option type (defaults to AV_OPT_TYPE_STRING)
+     *
      * @param searchFlags - Search flags (default: AV_OPT_SEARCH_CHILDREN)
+     *
      * @returns 0 on success, negative AVERROR on error:
      *   - AVERROR_ENOENT: Option not found
      *   - AVERROR_ERANGE: Value out of range
@@ -988,8 +1082,11 @@ export class OptionMember {
      * Direct mapping to av_opt_get* functions.
      *
      * @param name - Option name
+     *
      * @param type - Option type (defaults to AV_OPT_TYPE_STRING)
+     *
      * @param searchFlags - Search flags (default: AV_OPT_SEARCH_CHILDREN)
+     *
      * @returns Option value (type depends on type parameter), or null if not found
      *
      * @example