@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250331-ae2df3e19

package/dist/esm/clusters/media-playback.js

@@ -35,7 +35,7 @@ var MediaPlayback;
     /**
      * This field shall indicate the time when the position was last updated.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.4.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.4.1
      */
     updatedAt: TlvField(0, TlvEpochUs),
     /**
@@ -47,7 +47,7 @@ var MediaPlayback;
      * A value of null shall indicate that playback position is not applicable for the current state of the media
      * playback (For example : Live media with no known duration and where seek is not supported).
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.4.2
      */
     position: TlvField(1, TlvNullable(TlvUInt64))
   });
@@ -60,7 +60,7 @@ var MediaPlayback;
      * the status of SEEK_OUT_OF_RANGE shall be returned and no change shall be made to the position of the
      * playback.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.11.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.11.1
      */
     position: TlvField(0, TlvUInt64)
   });
@@ -77,13 +77,13 @@ var MediaPlayback;
     /**
      * This field shall indicate the status of the command which resulted in this response.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.12.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.12.1
      */
     status: TlvField(0, TlvEnum()),
     /**
      * This field shall indicate Optional app-specific data.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.12.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.12.2
      */
     data: TlvOptionalField(1, TlvString)
   });
@@ -113,21 +113,21 @@ var MediaPlayback;
      * The value is a String containing one of the standard Tags for Identifying Languages RFC 5646, which
      * identifies the primary language used in the Track.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.6.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.6.1
      */
     languageCode: TlvField(0, TlvString.bound({ maxLength: 32 })),
     /**
      * This is a list of enumerated CharacteristicEnum values that indicate a purpose, trait or feature associated
      * with the Track. A value of null shall indicate that there are no Characteristics corresponding to the Track.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.6.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.6.2
      */
     characteristics: TlvOptionalField(1, TlvNullable(TlvArray(TlvEnum()))),
     /**
      * The value is a String containing a user displayable name for the Track. A value of null shall indicate that
      * there is no DisplayName corresponding to the Track.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.6.3
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.6.3
      */
     displayName: TlvOptionalField(2, TlvNullable(TlvString.bound({ maxLength: 256 })))
   });
@@ -136,13 +136,13 @@ var MediaPlayback;
      * This field shall indicate the Identifier for the Track which is unique within the Track catalog. The Track
      * catalog contains all the Text/Audio tracks corresponding to the main media content.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.5.1
      */
     id: TlvField(0, TlvString.bound({ maxLength: 32 })),
     /**
      * This field shall indicate the Attributes associated to the Track, like languageCode.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.5.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.5.5.2
      */
     trackAttributes: TlvField(1, MediaPlayback2.TlvTrackAttributes)
   });
@@ -150,7 +150,7 @@ var MediaPlayback;
     /**
      * This field shall indicate the Audio Track to activate.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.13.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.13.1
      */
     trackId: TlvField(0, TlvString.bound({ maxLength: 32 })),
     /**
@@ -159,7 +159,7 @@ var MediaPlayback;
      * Tracks and only present for Audio Tracks. A value of null shall indicate that the server can choose the audio
      * output(s) to play the Audio Track on.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.13.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.13.2
      */
     audioOutputIndex: TlvOptionalField(1, TlvNullable(TlvUInt8))
   });
@@ -167,7 +167,7 @@ var MediaPlayback;
     /**
      * This field shall indicate the Text Track to activate.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.14.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.14.1
      */
     trackId: TlvField(0, TlvString.bound({ maxLength: 32 }))
   });
@@ -178,7 +178,7 @@ var MediaPlayback;
      * A value of true does not guarantee that audio can be heard by the user since the speaker may be muted, turned
      * down to a low level and/or unplugged.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.7.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.7.1
      */
     audioAdvanceUnmuted: TlvOptionalField(0, TlvBoolean)
   });
@@ -189,7 +189,7 @@ var MediaPlayback;
      * A value of true does not guarantee that audio can be heard by the user since the speaker may be muted, turned
      * down to a low level and/or unplugged.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.8.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.8.1
      */
     audioAdvanceUnmuted: TlvOptionalField(0, TlvBoolean)
   });
@@ -209,7 +209,7 @@ var MediaPlayback;
      * should be set to that furthest valid position. If the SampledPosition attribute is supported it shall be
      * updated on the cluster accordingly.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.9.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.9.1
      */
     deltaPositionMilliseconds: TlvField(0, TlvUInt64)
   });
@@ -222,7 +222,7 @@ var MediaPlayback;
      * set to that earliest valid position. If the SampledPosition attribute is supported it shall be updated on the
      * cluster accordingly.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.10.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.10.1
      */
     deltaPositionMilliseconds: TlvField(0, TlvUInt64)
   });
@@ -231,55 +231,55 @@ var MediaPlayback;
      * This field shall indicate the updated playback state as defined by the CurrentState attribute, and has the
      * same constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.1
      */
     currentState: TlvField(0, TlvEnum()),
     /**
      * This field shall indicate the updated start time as defined by the StartTime attribute, and has the same
      * constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.2
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.2
      */
     startTime: TlvOptionalField(1, TlvEpochUs),
     /**
      * This field shall indicate the updated duration as defined by the Duration attribute, and has the same
      * constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.3
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.3
      */
     duration: TlvOptionalField(2, TlvUInt64),
     /**
      * This field shall indicate the updated position of playback as defined by the SampledPosition attribute, and
      * has the same constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.4
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.4
      */
     sampledPosition: TlvOptionalField(3, MediaPlayback2.TlvPlaybackPosition),
     /**
      * This field shall indicate the updated speed at which the current media is being played as defined by the
      * PlaybackSpeed attribute, and has the same constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.5
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.5
      */
     playbackSpeed: TlvOptionalField(4, TlvFloat),
     /**
      * This field shall indicate the updated start of the seek range end as defined by the SeekRangeEnd attribute,
      * and has the same constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.7
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.7
      */
     seekRangeEnd: TlvOptionalField(5, TlvUInt64),
     /**
      * This field shall indicate the updated start of the seek range start as defined by the SeekRangeStart
      * attribute, and has the same constraint as that attribute.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.6
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.6
      */
     seekRangeStart: TlvOptionalField(6, TlvUInt64),
     /**
      * This field shall indicate Optional app-specific data.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.8
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.8
      */
     data: TlvOptionalField(7, TlvByteString.bound({ maxLength: 900 })),
     /**
@@ -291,7 +291,7 @@ var MediaPlayback;
      * A value of true does not guarantee that audio can be heard by the user since the speaker may be muted, turned
      * down to a low level and/or unplugged.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1.9
+     * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1.9
      */
     audioAdvanceUnmuted: TlvOptionalField(8, TlvBoolean)
   });
@@ -303,7 +303,7 @@ var MediaPlayback;
        * video-on-demand). This time is a UTC time. The client needs to handle conversion to local time, as
        * required, taking in account time zone and possible local DST offset.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.2
        */
       startTime: Attribute(1, TlvNullable(TlvEpochUs), { default: null }),
       /**
@@ -312,7 +312,7 @@ var MediaPlayback;
        * or null when duration is not applicable (for example, in live streaming content with no known duration).
        * This attribute shall never be 0.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.3
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.3
        */
       duration: Attribute(2, TlvNullable(TlvUInt64), { default: null }),
       /**
@@ -333,7 +333,7 @@ var MediaPlayback;
        *
        *   • Updating of playback speed as a result of explicit request, or as a result of buffering events
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.4
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.4
        */
       sampledPosition: Attribute(3, TlvNullable(MediaPlayback2.TlvPlaybackPosition), { default: null }),
       /**
@@ -367,7 +367,7 @@ var MediaPlayback;
        *
        * Following examples illustrate the PlaybackSpeed attribute values in various conditions.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.5
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.5
        */
       playbackSpeed: Attribute(4, TlvFloat, { default: 0 }),
       /**
@@ -378,14 +378,14 @@ var MediaPlayback;
        * truncating fractional milliseconds towards 0. A value of Nas when StartTime is not specified shall
        * indicate that seeking forward is not allowed.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.7
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.7
        */
       seekRangeEnd: Attribute(5, TlvNullable(TlvUInt64), { default: null }),
       /**
        * Indicates the earliest valid position to which a client may seek back, in milliseconds from start of the
        * media. A value of Nas shall indicate that seeking backwards is not allowed.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.6
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.6
        */
       seekRangeStart: Attribute(6, TlvNullable(TlvUInt64), { default: null })
     },
@@ -393,7 +393,7 @@ var MediaPlayback;
       /**
        * Upon receipt, this shall change the playback position in the media to the given position.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.11
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.11
        */
       seek: Command(11, MediaPlayback2.TlvSeekRequest, 10, MediaPlayback2.TlvPlaybackResponse)
     }
@@ -404,7 +404,7 @@ var MediaPlayback;
        * ActiveTrack refers to the Audio track currently set and being used for the streaming media. A value of
        * null shall indicate that no Audio Track corresponding to the current media is currently being played.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.8
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.8
        */
       activeAudioTrack: Attribute(7, TlvNullable(MediaPlayback2.TlvTrack), { default: null }),
       /**
@@ -412,7 +412,7 @@ var MediaPlayback;
        * value of null shall indicate that no Audio Tracks corresponding to the current media are selectable by
        * the client.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.9
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.9
        */
       availableAudioTracks: Attribute(8, TlvNullable(TlvArray(MediaPlayback2.TlvTrack)), { default: null })
     },
@@ -423,7 +423,7 @@ var MediaPlayback;
        * correspond to the streaming media OR no media is being streamed at the time of receipt of this command,
        * the server will return an error status of INVALID_ARGUMENT.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.13
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.13
        */
       activateAudioTrack: Command(12, MediaPlayback2.TlvActivateAudioTrackRequest, 12, TlvNoResponse)
     }
@@ -435,7 +435,7 @@ var MediaPlayback;
        * nil. A value of null shall indicate that no Text Track corresponding to the current media is currently
        * being displayed.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.10
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.10
        */
       activeTextTrack: Attribute(9, TlvNullable(MediaPlayback2.TlvTrack), { default: null }),
       /**
@@ -443,7 +443,7 @@ var MediaPlayback;
        * can be an empty list. A value of null shall indicate that no Text Tracks corresponding to the current
        * media are selectable by the client.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.11
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.11
        */
       availableTextTracks: Attribute(10, TlvNullable(TlvArray(MediaPlayback2.TlvTrack)), { default: null })
     },
@@ -454,14 +454,14 @@ var MediaPlayback;
        * correspond to the streaming media OR no media is being streamed at the time of receipt of this command,
        * the server shall return an error status of INVALID_ARGUMENT.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.14
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.14
        */
       activateTextTrack: Command(13, MediaPlayback2.TlvActivateTextTrackRequest, 13, TlvNoResponse),
       /**
        * If a Text Track is active (i.e. being displayed), upon receipt of this command, the server shall stop
        * displaying it.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.15
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.15
        */
       deactivateTextTrack: Command(14, TlvNoArguments, 14, TlvNoResponse)
     }
@@ -481,7 +481,7 @@ var MediaPlayback;
        * returned. If the playback speed has reached the maximum supported speed for media playing backwards, the
        * status of SPEED_OUT_OF_RANGE shall be returned.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.7
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.7
        */
       rewind: Command(6, MediaPlayback2.TlvRewindRequest, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
@@ -498,7 +498,7 @@ var MediaPlayback;
        * returned. If the playback speed has reached the maximum supported speed for media playing forward, the
        * status of SPEED_OUT_OF_RANGE shall be returned.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.8
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.8
        */
       fastForward: Command(7, MediaPlayback2.TlvFastForwardRequest, 10, MediaPlayback2.TlvPlaybackResponse)
     }
@@ -515,7 +515,7 @@ var MediaPlayback;
        * jumping to a specific location using time offsets. This enables clients to implement more advanced media
        * seeking behavior in their user interface, for instance a "seek bar".
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.4.1
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.4.1
        */
       advancedSeek: BitFlag(0),
       /**
@@ -523,7 +523,7 @@ var MediaPlayback;
        *
        * This feature is for a device which supports variable speed playback on media that supports it.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.4.2
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.4.2
        */
       variableSpeed: BitFlag(1),
       /**
@@ -531,7 +531,7 @@ var MediaPlayback;
        *
        * This feature is for a device or app that supports Text Tracks.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.4.3
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.4.3
        */
       textTracks: BitFlag(2),
       /**
@@ -539,7 +539,7 @@ var MediaPlayback;
        *
        * This feature is for a device or app that supports Audio Tracks.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.4.4
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.4.4
        */
       audioTracks: BitFlag(3),
       /**
@@ -552,7 +552,7 @@ var MediaPlayback;
        *
        * A cluster implementing AA shall implement AS.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.4.5
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.4.5
        */
       audioAdvance: BitFlag(4)
     },
@@ -562,7 +562,7 @@ var MediaPlayback;
        *
        * During fast-forward, rewind, and other seek operations; this attribute shall be set to PLAYING.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.6.1
        */
       currentState: Attribute(0, TlvEnum())
     },
@@ -571,52 +571,52 @@ var MediaPlayback;
        * Upon receipt, this shall play media. If content is currently in a FastForward or Rewind state. Play shall
        * return media to normal playback speed.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.1
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.1
        */
       play: Command(0, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall pause playback of the media.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.2
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.2
        */
       pause: Command(1, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall stop playback of the media. User-visible outcome is context-specific. This may
        * navigate the user back to the location from where the media was originally launched.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.3
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.3
        */
       stop: Command(2, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall Start Over with the current media playback item.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.4
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.4
        */
       startOver: OptionalCommand(3, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall cause the handler to be invoked for "Previous". User experience is
        * context-specific. This will often Go back to the previous media playback item.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.5
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.5
        */
       previous: OptionalCommand(4, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall cause the handler to be invoked for "Next". User experience is context-
        * specific. This will often Go forward to the next media playback item.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.6
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.6
        */
       next: OptionalCommand(5, TlvNoArguments, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall Skip forward in the media by the given number of milliseconds.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.9
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.9
        */
       skipForward: OptionalCommand(8, MediaPlayback2.TlvSkipForwardRequest, 10, MediaPlayback2.TlvPlaybackResponse),
       /**
        * Upon receipt, this shall Skip backward in the media by the given number of milliseconds.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.7.10
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.7.10
        */
       skipBackward: OptionalCommand(9, MediaPlayback2.TlvSkipBackwardRequest, 10, MediaPlayback2.TlvPlaybackResponse)
     },
@@ -625,7 +625,7 @@ var MediaPlayback;
        * If supported, this event shall be generated when there is a change in any of the supported attributes of
        * the Media Playback cluster.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 6.10.8.1
+       * @see {@link MatterSpecification.v14.Cluster} § 6.10.8.1
        */
       stateChanged: OptionalEvent(0, EventPriority.Info, MediaPlayback2.TlvStateChangedEvent)
     },