homebridge-plugin-utils 1.19.0 → 1.21.0

package/dist/ffmpeg/options.d.ts

@@ -17,7 +17,7 @@
  *
  * @module
  */
-import { H264Level, H264Profile, type Logging } from "homebridge";
+import { AudioRecordingCodecType, H264Level, H264Profile, type Logging } from "homebridge";
 import type { FfmpegCodecs } from "./codecs.js";
 import type { HomebridgePluginLogging } from "../util.js";
 /**
@@ -71,13 +71,14 @@ export interface FfmpegOptionsConfig {
  *
  * @property bitrate             - Target video bitrate, in kilobits per second.
  * @property fps                 - Target output frames per second.
+ * @property hardwareDecoding    - Optional. If `true`, encoder options will account for hardware decoding (primarily for Intel QSV scenarios). Defaults to `true`.
  * @property height              - Output video height, in pixels.
  * @property idrInterval         - Interval (in seconds) between keyframes (IDR frames).
  * @property inputFps            - Input (source) frames per second.
  * @property level               - H.264 profile level for output.
  * @property profile             - H.264 profile for output.
- * @property useHardwareDecoder  - Optional. If `true`, encoder options will account for hardware decoding (primarily for Intel QSV scenarios). Defaults to `true`.
- * @property useSmartQuality     - Optional. If `true`, enables smart quality and variable bitrate optimizations. Defaults to `true`.
+ * @property smartQuality        - Optional and applicable only when not using hardware acceleration. If `true`, enables smart quality and variable bitrate optimizations.
+ *                                 Defaults to `true`.
  * @property width               - Output video width, in pixels.
  *
  * @example
@@ -87,13 +88,14 @@ export interface FfmpegOptionsConfig {
  *
  *   bitrate: 3000,
  *   fps: 30,
+ *   hardwareDecoding: true,
+ *   hardwareTranscoding: true,
  *   height: 1080,
  *   idrInterval: 2,
  *   inputFps: 30,
  *   level: H264Level.LEVEL4_0,
  *   profile: H264Profile.HIGH,
- *   useHardwareDecoder: true,
- *   useSmartQuality: true,
+ *   smartQuality: true,
  *   width: 1920
  * };
  *
@@ -110,13 +112,14 @@ export interface FfmpegOptionsConfig {
 export interface EncoderOptions {
     bitrate: number;
     fps: number;
+    hardwareDecoding?: boolean;
+    hardwareTranscoding?: boolean;
     height: number;
     idrInterval: number;
     inputFps: number;
     level: H264Level;
     profile: H264Profile;
-    useSmartQuality?: boolean;
-    useHardwareDecoder?: boolean;
+    smartQuality?: boolean;
     width: number;
 }
 /**
@@ -134,12 +137,14 @@ export interface EncoderOptions {
  *
  *   bitrate: 3000,
  *   fps: 30,
+ *   hardwareDecoding: true,
+ *   hardwareTranscoding: true,
  *   height: 1080,
  *   idrInterval: 2,
  *   inputFps: 30,
  *   level: H264Level.LEVEL4_0,
  *   profile: H264Profile.HIGH,
- *   useSmartQuality: true,
+ *   smartQuality: true,
  *   width: 1920
  * };
  * const args = ffmpegOpts.streamEncoder(encoderOptions);
@@ -160,6 +165,10 @@ export declare class FfmpegOptions {
      *
      */
     codecSupport: FfmpegCodecs;
+    /**
+     * The configuration options used to initialize this instance.
+     */
+    readonly config: FfmpegOptionsConfig;
     /**
      * Indicates if debug logging is enabled.
      */
@@ -172,10 +181,6 @@ export declare class FfmpegOptions {
      * Function returning the name for this options instance to be used for logging.
      */
     readonly name: () => string;
-    /**
-     * The original options used to initialize this instance.
-     */
-    readonly options: FfmpegOptionsConfig;
     private readonly hwPixelFormat;
     /**
      * Creates an instance of Homebridge FFmpeg encoding and decoding options.
@@ -217,9 +222,16 @@ export declare class FfmpegOptions {
     /**
      * Returns the audio encoder arguments to use when transcoding.
      *
+     * @param codec            - Optional. Codec to encode (`AudioRecordingCodecType.AAC_ELD` (default) or `AudioRecordingCodecType.AAC_LC`).
      * @returns Array of FFmpeg command-line arguments for audio encoding.
+     *
+     * @example
+     *
+     * ```ts
+     * const args = ffmpegOpts.audioEncoder();
+     * ```
      */
-    get audioEncoder(): string[];
+    audioEncoder(codec?: AudioRecordingCodecType): string[];
     /**
      * Returns the audio decoder to use when decoding.
      *
@@ -229,8 +241,8 @@ export declare class FfmpegOptions {
     /**
      * Returns the video decoder arguments to use for decoding video.
      *
-     * @param codec            - Optional. Codec to decode ("h264" or "hevc").
-     * @returns Array of FFmpeg command-line arguments for video decoding.
+     * @param codec            - Optional. Codec to decode (`"h264"` (default) or `"hevc"`).
+     * @returns Array of FFmpeg command-line arguments for video decoding or an empty array if the codec isn't supported.
      *
      * @example
      *
@@ -267,7 +279,7 @@ export declare class FfmpegOptions {
      *   inputFps: 30,
      *   level: H264Level.LEVEL3_1,
      *   profile: H264Profile.MAIN,
-     *   useSmartQuality: true,
+     *   smartQuality: true,
      *   width: 1280
      * };
      *