YOLOStreamingConfig.throttled constructor

YOLOStreamingConfig.throttled({
  1. required int maxFPS,
  2. bool includeDetections = true,
  3. bool includeClassifications = true,
  4. bool includeProcessingTimeMs = true,
  5. bool includeFps = true,
  6. bool includeMasks = false,
  7. bool includePoses = false,
  8. bool includeOBB = false,
  9. bool includeOriginalImage = false,
  10. int? inferenceFrequency,
  11. int? skipFrames,
})

Creates a throttled configuration with specified FPS limit.

This is useful when you want to limit the processing rate to save battery or reduce system load.

Example:

// Limit to 10 FPS for battery saving
final config = YOLOStreamingConfig.throttled(maxFPS: 10);

Implementation

factory YOLOStreamingConfig.throttled({
  required int maxFPS,
  bool includeDetections = true,
  bool includeClassifications = true,
  bool includeProcessingTimeMs = true,
  bool includeFps = true,
  bool includeMasks = false,
  bool includePoses = false,
  bool includeOBB = false,
  bool includeOriginalImage = false,
  int? inferenceFrequency,
  int? skipFrames,
}) {
  return YOLOStreamingConfig(
    includeDetections: includeDetections,
    includeClassifications: includeClassifications,
    includeProcessingTimeMs: includeProcessingTimeMs,
    includeFps: includeFps,
    includeMasks: includeMasks,
    includePoses: includePoses,
    includeOBB: includeOBB,
    includeOriginalImage: includeOriginalImage,
    maxFPS: maxFPS,
    inferenceFrequency: inferenceFrequency,
    skipFrames: skipFrames,
  );
}