@matter/types 0.13.0-alpha.0-20250318-c1aa38b08 → 0.13.0-alpha.0-20250323-770919c6a

package/dist/esm/clusters/channel.d.ts

@@ -327,9 +327,9 @@ export declare namespace Channel {
          */
         endTime: import("../tlv/TlvObject.js").FieldType<number>;
         /**
-         * This field shall indicate the set of channels for which program guide entries should be fetched. By
-         * providing a list of channels in this field, the response will only include entries corresponding to the
-         * specified channels.
+         * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+         * a list of channels in this field, the response will only include entries corresponding to the specified
+         * channels.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
          */
@@ -761,8 +761,8 @@ export declare namespace Channel {
          */
         posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
         /**
-         * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-         * the syntax as specified in RFC 1738 and shall use the https scheme.
+         * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+         * syntax as specified in RFC 1738 and shall use the https scheme.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
          */
@@ -822,8 +822,8 @@ export declare namespace Channel {
             episode: import("../tlv/TlvObject.js").FieldType<string>;
         }> | null>;
         /**
-         * This field shall represent the category of a particular program. This field is optional but shall be
-         * provided if known.
+         * This field shall represent the category of a particular program. This field is optional but shall be provided
+         * if known.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
          */
@@ -885,8 +885,8 @@ export declare namespace Channel {
      */
     const TlvProgramGuideResponse: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
-         * This field shall indicate the necessary pagination attributes that define information for both the
-         * succeeding and preceding data pages.
+         * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+         * and preceding data pages.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
          */
@@ -1099,8 +1099,8 @@ export declare namespace Channel {
              */
             posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
             /**
-             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-             * the syntax as specified in RFC 1738 and shall use the https scheme.
+             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+             * syntax as specified in RFC 1738 and shall use the https scheme.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
              */
@@ -1160,8 +1160,8 @@ export declare namespace Channel {
                 episode: import("../tlv/TlvObject.js").FieldType<string>;
             }> | null>;
             /**
-             * This field shall represent the category of a particular program. This field is optional but shall be
-             * provided if known.
+             * This field shall represent the category of a particular program. This field is optional but shall be provided
+             * if known.
              *
              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
              */
@@ -1231,9 +1231,9 @@ export declare namespace Channel {
          */
         programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
         /**
-         * This field shall indicate whether the whole series associated to the program should be recorded. For
-         * example, invoking record program on an episode with that flag set to true, the target should schedule record
-         * the whole series.
+         * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+         * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+         * series.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
          */
@@ -1338,8 +1338,8 @@ export declare namespace Channel {
      */
     const TlvSkipChannelRequest: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
-         * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is
-         * negative) the current channel.
+         * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
+         * the current channel.
          *
          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.4.1
          */
@@ -1529,9 +1529,9 @@ export declare namespace Channel {
                  */
                 endTime: import("../tlv/TlvObject.js").FieldType<number>;
                 /**
-                 * This field shall indicate the set of channels for which program guide entries should be fetched. By
-                 * providing a list of channels in this field, the response will only include entries corresponding to the
-                 * specified channels.
+                 * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+                 * a list of channels in this field, the response will only include entries corresponding to the specified
+                 * channels.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
                  */
@@ -1658,8 +1658,8 @@ export declare namespace Channel {
                 data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
             }>, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * This field shall indicate the necessary pagination attributes that define information for both the
-                 * succeeding and preceding data pages.
+                 * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+                 * and preceding data pages.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
                  */
@@ -1872,8 +1872,8 @@ export declare namespace Channel {
                      */
                     posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     /**
-                     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-                     * the syntax as specified in RFC 1738 and shall use the https scheme.
+                     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+                     * syntax as specified in RFC 1738 and shall use the https scheme.
                      *
                      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
                      */
@@ -1933,8 +1933,8 @@ export declare namespace Channel {
                         episode: import("../tlv/TlvObject.js").FieldType<string>;
                     }> | null>;
                     /**
-                     * This field shall represent the category of a particular program. This field is optional but shall be
-                     * provided if known.
+                     * This field shall represent the category of a particular program. This field is optional but shall be provided
+                     * if known.
                      *
                      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
                      */
@@ -2004,9 +2004,9 @@ export declare namespace Channel {
                  */
                 programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
                 /**
-                 * This field shall indicate whether the whole series associated to the program should be recorded. For
-                 * example, invoking record program on an episode with that flag set to true, the target should schedule record
-                 * the whole series.
+                 * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+                 * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+                 * series.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
                  */
@@ -2195,8 +2195,8 @@ export declare namespace Channel {
              */
             readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is
-                 * negative) the current channel.
+                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
+                 * the current channel.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.4.1
                  */
@@ -2428,9 +2428,9 @@ export declare namespace Channel {
                          */
                         endTime: import("../tlv/TlvObject.js").FieldType<number>;
                         /**
-                         * This field shall indicate the set of channels for which program guide entries should be fetched. By
-                         * providing a list of channels in this field, the response will only include entries corresponding to the
-                         * specified channels.
+                         * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+                         * a list of channels in this field, the response will only include entries corresponding to the specified
+                         * channels.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
                          */
@@ -2557,8 +2557,8 @@ export declare namespace Channel {
                         data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
                     }>, import("../tlv/TlvObject.js").TypeFromFields<{
                         /**
-                         * This field shall indicate the necessary pagination attributes that define information for both the
-                         * succeeding and preceding data pages.
+                         * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+                         * and preceding data pages.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
                          */
@@ -2771,8 +2771,8 @@ export declare namespace Channel {
                              */
                             posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                             /**
-                             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-                             * the syntax as specified in RFC 1738 and shall use the https scheme.
+                             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+                             * syntax as specified in RFC 1738 and shall use the https scheme.
                              *
                              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
                              */
@@ -2832,8 +2832,8 @@ export declare namespace Channel {
                                 episode: import("../tlv/TlvObject.js").FieldType<string>;
                             }> | null>;
                             /**
-                             * This field shall represent the category of a particular program. This field is optional but shall be
-                             * provided if known.
+                             * This field shall represent the category of a particular program. This field is optional but shall be provided
+                             * if known.
                              *
                              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
                              */
@@ -2905,9 +2905,9 @@ export declare namespace Channel {
                          */
                         programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
                         /**
-                         * This field shall indicate whether the whole series associated to the program should be recorded. For
-                         * example, invoking record program on an episode with that flag set to true, the target should schedule record
-                         * the whole series.
+                         * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+                         * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+                         * series.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
                          */
@@ -3098,8 +3098,8 @@ export declare namespace Channel {
              */
             readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is
-                 * negative) the current channel.
+                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
+                 * the current channel.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.4.1
                  */
@@ -3331,9 +3331,9 @@ export declare namespace Channel {
                          */
                         endTime: import("../tlv/TlvObject.js").FieldType<number>;
                         /**
-                         * This field shall indicate the set of channels for which program guide entries should be fetched. By
-                         * providing a list of channels in this field, the response will only include entries corresponding to the
-                         * specified channels.
+                         * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+                         * a list of channels in this field, the response will only include entries corresponding to the specified
+                         * channels.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
                          */
@@ -3460,8 +3460,8 @@ export declare namespace Channel {
                         data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
                     }>, import("../tlv/TlvObject.js").TypeFromFields<{
                         /**
-                         * This field shall indicate the necessary pagination attributes that define information for both the
-                         * succeeding and preceding data pages.
+                         * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+                         * and preceding data pages.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
                          */
@@ -3674,8 +3674,8 @@ export declare namespace Channel {
                              */
                             posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                             /**
-                             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-                             * the syntax as specified in RFC 1738 and shall use the https scheme.
+                             * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+                             * syntax as specified in RFC 1738 and shall use the https scheme.
                              *
                              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
                              */
@@ -3735,8 +3735,8 @@ export declare namespace Channel {
                                 episode: import("../tlv/TlvObject.js").FieldType<string>;
                             }> | null>;
                             /**
-                             * This field shall represent the category of a particular program. This field is optional but shall be
-                             * provided if known.
+                             * This field shall represent the category of a particular program. This field is optional but shall be provided
+                             * if known.
                              *
                              * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
                              */
@@ -3808,9 +3808,9 @@ export declare namespace Channel {
                          */
                         programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
                         /**
-                         * This field shall indicate whether the whole series associated to the program should be recorded. For
-                         * example, invoking record program on an episode with that flag set to true, the target should schedule record
-                         * the whole series.
+                         * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+                         * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+                         * series.
                          *
                          * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
                          */
@@ -3877,9 +3877,9 @@ export declare namespace Channel {
      *
      * This cluster server would be supported on Video Player devices or endpoints that allow Channel control such as a
      * Content App. This cluster provides a list of available channels and provides commands for absolute and relative
-     * channel changes. Some of these commands and/or their responses may be large (see Large Message Quality under
-     * Data Model section in [MatterCore]), but they do not have the Large quality indicator (L) because they can also
-     * be transferred over MRP (see Message Reliability Protocol in [MatterCore]) in pages that fit within the MRP MTU
+     * channel changes. Some of these commands and/or their responses may be large (see Large Message Quality under Data
+     * Model section in [MatterCore]), but they do not have the Large quality indicator (L) because they can also be
+     * transferred over MRP (see Message Reliability Protocol in [MatterCore]) in pages that fit within the MRP MTU
      * limit. However, an implementation may leverage a transport like TCP that allows large payloads, if available, to
      * minimize the number of messages required to transfer the corresponding payload.
      *
@@ -4157,9 +4157,9 @@ export declare namespace Channel {
                  */
                 endTime: import("../tlv/TlvObject.js").FieldType<number>;
                 /**
-                 * This field shall indicate the set of channels for which program guide entries should be fetched. By
-                 * providing a list of channels in this field, the response will only include entries corresponding to the
-                 * specified channels.
+                 * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+                 * a list of channels in this field, the response will only include entries corresponding to the specified
+                 * channels.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
                  */
@@ -4286,8 +4286,8 @@ export declare namespace Channel {
                 data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
             }>, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * This field shall indicate the necessary pagination attributes that define information for both the
-                 * succeeding and preceding data pages.
+                 * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+                 * and preceding data pages.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
                  */
@@ -4500,8 +4500,8 @@ export declare namespace Channel {
                      */
                     posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                     /**
-                     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-                     * the syntax as specified in RFC 1738 and shall use the https scheme.
+                     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+                     * syntax as specified in RFC 1738 and shall use the https scheme.
                      *
                      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
                      */
@@ -4561,8 +4561,8 @@ export declare namespace Channel {
                         episode: import("../tlv/TlvObject.js").FieldType<string>;
                     }> | null>;
                     /**
-                     * This field shall represent the category of a particular program. This field is optional but shall be
-                     * provided if known.
+                     * This field shall represent the category of a particular program. This field is optional but shall be provided
+                     * if known.
                      *
                      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
                      */
@@ -4627,9 +4627,9 @@ export declare namespace Channel {
                  */
                 programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
                 /**
-                 * This field shall indicate whether the whole series associated to the program should be recorded. For
-                 * example, invoking record program on an episode with that flag set to true, the target should schedule record
-                 * the whole series.
+                 * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+                 * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+                 * series.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
                  */
@@ -4730,8 +4730,8 @@ export declare namespace Channel {
              */
             readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
-                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is
-                 * negative) the current channel.
+                 * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
+                 * the current channel.
                  *
                  * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.4.1
                  */
@@ -4742,8 +4742,8 @@ export declare namespace Channel {
     /**
      * This cluster supports all Channel features. It may support illegal feature combinations.
      *
-     * If you use this cluster you must manually specify which features are active and ensure the set of active
-     * features is legal per the Matter specification.
+     * If you use this cluster you must manually specify which features are active and ensure the set of active features
+     * is legal per the Matter specification.
      */
     interface Complete extends Identity<typeof CompleteInstance> {
     }

package/dist/esm/clusters/channel.js

@@ -203,9 +203,9 @@ var Channel;
      */
     endTime: TlvField(1, TlvEpochS),
     /**
-     * This field shall indicate the set of channels for which program guide entries should be fetched. By
-     * providing a list of channels in this field, the response will only include entries corresponding to the
-     * specified channels.
+     * This field shall indicate the set of channels for which program guide entries should be fetched. By providing
+     * a list of channels in this field, the response will only include entries corresponding to the specified
+     * channels.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.5.3
      */
@@ -375,8 +375,8 @@ var Channel;
      */
     posterArtUrl: TlvOptionalField(10, TlvString.bound({ maxLength: 8192 })),
     /**
-     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow
-     * the syntax as specified in RFC 1738 and shall use the https scheme.
+     * This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
+     * syntax as specified in RFC 1738 and shall use the https scheme.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.12
      */
@@ -410,8 +410,8 @@ var Channel;
      */
     seriesInfo: TlvOptionalField(15, TlvNullable(Channel2.TlvSeriesInfo)),
     /**
-     * This field shall represent the category of a particular program. This field is optional but shall be
-     * provided if known.
+     * This field shall represent the category of a particular program. This field is optional but shall be provided
+     * if known.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.5.7.17
      */
@@ -432,8 +432,8 @@ var Channel;
   });
   Channel2.TlvProgramGuideResponse = TlvObject({
     /**
-     * This field shall indicate the necessary pagination attributes that define information for both the
-     * succeeding and preceding data pages.
+     * This field shall indicate the necessary pagination attributes that define information for both the succeeding
+     * and preceding data pages.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.6.1
      */
@@ -454,9 +454,9 @@ var Channel;
      */
     programIdentifier: TlvField(0, TlvString.bound({ maxLength: 255 })),
     /**
-     * This field shall indicate whether the whole series associated to the program should be recorded. For
-     * example, invoking record program on an episode with that flag set to true, the target should schedule record
-     * the whole series.
+     * This field shall indicate whether the whole series associated to the program should be recorded. For example,
+     * invoking record program on an episode with that flag set to true, the target should schedule record the whole
+     * series.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.7.2
      */
@@ -519,8 +519,8 @@ var Channel;
   });
   Channel2.TlvSkipChannelRequest = TlvObject({
     /**
-     * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is
-     * negative) the current channel.
+     * This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
+     * the current channel.
      *
      * @see {@link MatterSpecification.v13.Cluster} § 6.6.7.4.1
      */