@camstack/addon-provider-rtsp 1.2.107 → 1.2.108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/addon.js CHANGED
@@ -12348,7 +12348,23 @@ var PickStreamRequirementsSchema = object({
12348
12348
  * This is what lets one picker serve both the bypass and the full source
12349
12349
  * choice, instead of a consumer scoring privately when the bypass misses.
12350
12350
  */
12351
- allowTranscode: boolean().optional()
12351
+ allowTranscode: boolean().optional(),
12352
+ /**
12353
+ * Consider ONLY streams the broker has bound to a profile slot.
12354
+ *
12355
+ * A consumer that dials the broker — which is every exporter, since none
12356
+ * of them may open the camera's own URL — can do nothing with a source
12357
+ * that has no slot: there is no restream to dial. Without this the picker
12358
+ * can name such a stream, and each consumer discovers the dead end for
12359
+ * itself: Alexa's `profileForCamStream` returns `null` and it quietly
12360
+ * falls back, and HomeKit would have had to grow the same function again.
12361
+ *
12362
+ * Default `false`, and deliberately so: the BROKER itself picks through
12363
+ * here when it decides which source to BIND to a slot
12364
+ * (`computeInitialAssignment`), and it must see the unbound ones or it
12365
+ * could never bind them.
12366
+ */
12367
+ requireProfileBound: boolean().optional()
12352
12368
  }).readonly();
12353
12369
  var PickStreamPreferencesSchema = object({
12354
12370
  /**
@@ -12389,7 +12405,43 @@ var PickedCamStreamSchema = object({
12389
12405
  */
12390
12406
  transcodes: boolean(),
12391
12407
  /** One-line explanation of why this stream won — for logs / debug UI. */
12392
- reason: string()
12408
+ reason: string(),
12409
+ /**
12410
+ * The broker profile slot this source is bound to, when it is bound.
12411
+ *
12412
+ * Answered HERE because every consumer needs it and none of them can get it
12413
+ * from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
12414
+ * a second cap read plus a `null` branch — and HomeKit was about to write
12415
+ * the same function a second time.
12416
+ *
12417
+ * Absent when the source has no slot, which a caller passing
12418
+ * `requireProfileBound` can never see.
12419
+ */
12420
+ profile: CamProfileSchema.optional(),
12421
+ /** The broker id of that slot, for logs that must name what was dialled. */
12422
+ brokerId: string().optional(),
12423
+ /**
12424
+ * The broker restream URL to dial for this stream.
12425
+ *
12426
+ * An exporter must never open the camera's own URL — the broker is the one
12427
+ * that dials the camera, and every consumer goes through its restream. So
12428
+ * the picker answers with the thing a consumer may actually use, instead of
12429
+ * naming a source and leaving each caller to look the URL up.
12430
+ */
12431
+ url: string().optional(),
12432
+ /**
12433
+ * Frames per second this stream really delivers, and where the number came
12434
+ * from.
12435
+ *
12436
+ * It is here because getting it wrong is expensive and silent: a HomeKit
12437
+ * accessory advertised 720p at 24 fps while the slot serving it ran at 9,
12438
+ * and the controller rendered nothing at all. The source is carried with the
12439
+ * value for the same reason the bitrate evidence is: `published` is what the
12440
+ * publisher declares and `measured` is what the broker observed, and they
12441
+ * are not interchangeable.
12442
+ */
12443
+ fps: number().positive().optional(),
12444
+ fpsSource: _enum(["published", "measured"]).optional()
12393
12445
  });
12394
12446
  /**
12395
12447
  * Camera streams — device-scoped facade over the system `stream-broker`.
package/dist/addon.mjs CHANGED
@@ -12324,7 +12324,23 @@ var PickStreamRequirementsSchema = object({
12324
12324
  * This is what lets one picker serve both the bypass and the full source
12325
12325
  * choice, instead of a consumer scoring privately when the bypass misses.
12326
12326
  */
12327
- allowTranscode: boolean().optional()
12327
+ allowTranscode: boolean().optional(),
12328
+ /**
12329
+ * Consider ONLY streams the broker has bound to a profile slot.
12330
+ *
12331
+ * A consumer that dials the broker — which is every exporter, since none
12332
+ * of them may open the camera's own URL — can do nothing with a source
12333
+ * that has no slot: there is no restream to dial. Without this the picker
12334
+ * can name such a stream, and each consumer discovers the dead end for
12335
+ * itself: Alexa's `profileForCamStream` returns `null` and it quietly
12336
+ * falls back, and HomeKit would have had to grow the same function again.
12337
+ *
12338
+ * Default `false`, and deliberately so: the BROKER itself picks through
12339
+ * here when it decides which source to BIND to a slot
12340
+ * (`computeInitialAssignment`), and it must see the unbound ones or it
12341
+ * could never bind them.
12342
+ */
12343
+ requireProfileBound: boolean().optional()
12328
12344
  }).readonly();
12329
12345
  var PickStreamPreferencesSchema = object({
12330
12346
  /**
@@ -12365,7 +12381,43 @@ var PickedCamStreamSchema = object({
12365
12381
  */
12366
12382
  transcodes: boolean(),
12367
12383
  /** One-line explanation of why this stream won — for logs / debug UI. */
12368
- reason: string()
12384
+ reason: string(),
12385
+ /**
12386
+ * The broker profile slot this source is bound to, when it is bound.
12387
+ *
12388
+ * Answered HERE because every consumer needs it and none of them can get it
12389
+ * from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
12390
+ * a second cap read plus a `null` branch — and HomeKit was about to write
12391
+ * the same function a second time.
12392
+ *
12393
+ * Absent when the source has no slot, which a caller passing
12394
+ * `requireProfileBound` can never see.
12395
+ */
12396
+ profile: CamProfileSchema.optional(),
12397
+ /** The broker id of that slot, for logs that must name what was dialled. */
12398
+ brokerId: string().optional(),
12399
+ /**
12400
+ * The broker restream URL to dial for this stream.
12401
+ *
12402
+ * An exporter must never open the camera's own URL — the broker is the one
12403
+ * that dials the camera, and every consumer goes through its restream. So
12404
+ * the picker answers with the thing a consumer may actually use, instead of
12405
+ * naming a source and leaving each caller to look the URL up.
12406
+ */
12407
+ url: string().optional(),
12408
+ /**
12409
+ * Frames per second this stream really delivers, and where the number came
12410
+ * from.
12411
+ *
12412
+ * It is here because getting it wrong is expensive and silent: a HomeKit
12413
+ * accessory advertised 720p at 24 fps while the slot serving it ran at 9,
12414
+ * and the controller rendered nothing at all. The source is carried with the
12415
+ * value for the same reason the bitrate evidence is: `published` is what the
12416
+ * publisher declares and `measured` is what the broker observed, and they
12417
+ * are not interchangeable.
12418
+ */
12419
+ fps: number().positive().optional(),
12420
+ fpsSource: _enum(["published", "measured"]).optional()
12369
12421
  });
12370
12422
  /**
12371
12423
  * Camera streams — device-scoped facade over the system `stream-broker`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-provider-rtsp",
3
- "version": "1.2.107",
3
+ "version": "1.2.108",
4
4
  "description": "Generic RTSP camera device provider addon for CamStack",
5
5
  "keywords": [
6
6
  "camstack",