Align naming in Media Playback cluster XML with the spec. (#24509)

* Align naming in Media Playback cluster XML with the spec. * Auto-update ZAP files. * Regenerate generated code.
project-chip · Nov 15, 2023 · 1761076 · 1761076
1 parent 9a09ecf
commit 1761076
Show file tree

Hide file tree

Showing 55 changed files with 397 additions and 349 deletions.
diff --git a/examples/all-clusters-app/all-clusters-common/all-clusters-app.zap b/examples/all-clusters-app/all-clusters-common/all-clusters-app.zap
@@ -18311,7 +18311,7 @@
               "outgoing": 1
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",
@@ -18455,7 +18455,7 @@
               "code": 3,
               "mfgCode": null,
               "side": "server",
-              "type": "PlaybackPosition",
+              "type": "PlaybackPositionStruct",
               "included": 0,
               "storageOption": "External",
               "singleton": 0,

diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
@@ -2639,7 +2639,7 @@ server cluster MediaPlayback = 1286 {
 
   command Play(): PlaybackResponse = 0;
   command Pause(): PlaybackResponse = 1;
-  command StopPlayback(): PlaybackResponse = 2;
+  command Stop(): PlaybackResponse = 2;
 }
 
 server cluster MediaInput = 1287 {

diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.zap b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.zap
@@ -17811,7 +17811,7 @@
               "outgoing": 1
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",
@@ -17965,7 +17965,7 @@
               "code": 3,
               "mfgCode": null,
               "side": "server",
-              "type": "PlaybackPosition",
+              "type": "PlaybackPositionStruct",
               "included": 0,
               "storageOption": "External",
               "singleton": 0,

diff --git a/examples/thermostat/thermostat-common/thermostat.zap b/examples/thermostat/thermostat-common/thermostat.zap
@@ -13401,7 +13401,7 @@
               "outgoing": 1
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",

diff --git a/examples/tv-app/android/include/media-playback/AppMediaPlaybackManager.cpp b/examples/tv-app/android/include/media-playback/AppMediaPlaybackManager.cpp
@@ -170,7 +170,7 @@ Commands::PlaybackResponse::Type AppMediaPlaybackManager::HandleMediaRequest(Med
 
 CHIP_ERROR AppMediaPlaybackManager::HandleGetSampledPosition(AttributeValueEncoder & aEncoder)
 {
-    Structs::PlaybackPosition::Type response;
+    Structs::PlaybackPositionStruct::Type response;
     response.updatedAt = 0;
     response.position  = Nullable<uint64_t>(0);
 

diff --git a/examples/tv-app/android/java/AppImpl.cpp b/examples/tv-app/android/java/AppImpl.cpp
@@ -196,12 +196,12 @@ constexpr CommandId contentLauncherOutgoingCommands[] = {
 };
 // TODO: Sort out when the optional commands here should be listed.
 constexpr CommandId mediaPlaybackIncomingCommands[] = {
-    app::Clusters::MediaPlayback::Commands::Play::Id,         app::Clusters::MediaPlayback::Commands::Pause::Id,
-    app::Clusters::MediaPlayback::Commands::StopPlayback::Id, app::Clusters::MediaPlayback::Commands::StartOver::Id,
-    app::Clusters::MediaPlayback::Commands::Previous::Id,     app::Clusters::MediaPlayback::Commands::Next::Id,
-    app::Clusters::MediaPlayback::Commands::Rewind::Id,       app::Clusters::MediaPlayback::Commands::FastForward::Id,
-    app::Clusters::MediaPlayback::Commands::SkipForward::Id,  app::Clusters::MediaPlayback::Commands::SkipBackward::Id,
-    app::Clusters::MediaPlayback::Commands::Seek::Id,         kInvalidCommandId,
+    app::Clusters::MediaPlayback::Commands::Play::Id,        app::Clusters::MediaPlayback::Commands::Pause::Id,
+    app::Clusters::MediaPlayback::Commands::Stop::Id,        app::Clusters::MediaPlayback::Commands::StartOver::Id,
+    app::Clusters::MediaPlayback::Commands::Previous::Id,    app::Clusters::MediaPlayback::Commands::Next::Id,
+    app::Clusters::MediaPlayback::Commands::Rewind::Id,      app::Clusters::MediaPlayback::Commands::FastForward::Id,
+    app::Clusters::MediaPlayback::Commands::SkipForward::Id, app::Clusters::MediaPlayback::Commands::SkipBackward::Id,
+    app::Clusters::MediaPlayback::Commands::Seek::Id,        kInvalidCommandId,
 };
 constexpr CommandId mediaPlaybackOutgoingCommands[] = {
     app::Clusters::MediaPlayback::Commands::PlaybackResponse::Id,

diff --git a/examples/tv-app/android/java/MediaPlaybackManager.cpp b/examples/tv-app/android/java/MediaPlaybackManager.cpp
@@ -292,7 +292,7 @@ Commands::PlaybackResponse::Type MediaPlaybackManager::HandleMediaRequest(MediaP
 
 CHIP_ERROR MediaPlaybackManager::HandleGetSampledPosition(AttributeValueEncoder & aEncoder)
 {
-    Structs::PlaybackPosition::Type response;
+    Structs::PlaybackPositionStruct::Type response;
     response.updatedAt = 0;
     response.position  = Nullable<uint64_t>(0);
 

diff --git a/examples/tv-app/linux/AppImpl.cpp b/examples/tv-app/linux/AppImpl.cpp
@@ -354,12 +354,12 @@ constexpr CommandId contentLauncherOutgoingCommands[] = {
 };
 // TODO: Sort out when the optional commands here should be listed.
 constexpr CommandId mediaPlaybackIncomingCommands[] = {
-    app::Clusters::MediaPlayback::Commands::Play::Id,         app::Clusters::MediaPlayback::Commands::Pause::Id,
-    app::Clusters::MediaPlayback::Commands::StopPlayback::Id, app::Clusters::MediaPlayback::Commands::StartOver::Id,
-    app::Clusters::MediaPlayback::Commands::Previous::Id,     app::Clusters::MediaPlayback::Commands::Next::Id,
-    app::Clusters::MediaPlayback::Commands::Rewind::Id,       app::Clusters::MediaPlayback::Commands::FastForward::Id,
-    app::Clusters::MediaPlayback::Commands::SkipForward::Id,  app::Clusters::MediaPlayback::Commands::SkipBackward::Id,
-    app::Clusters::MediaPlayback::Commands::Seek::Id,         kInvalidCommandId,
+    app::Clusters::MediaPlayback::Commands::Play::Id,        app::Clusters::MediaPlayback::Commands::Pause::Id,
+    app::Clusters::MediaPlayback::Commands::Stop::Id,        app::Clusters::MediaPlayback::Commands::StartOver::Id,
+    app::Clusters::MediaPlayback::Commands::Previous::Id,    app::Clusters::MediaPlayback::Commands::Next::Id,
+    app::Clusters::MediaPlayback::Commands::Rewind::Id,      app::Clusters::MediaPlayback::Commands::FastForward::Id,
+    app::Clusters::MediaPlayback::Commands::SkipForward::Id, app::Clusters::MediaPlayback::Commands::SkipBackward::Id,
+    app::Clusters::MediaPlayback::Commands::Seek::Id,        kInvalidCommandId,
 };
 constexpr CommandId mediaPlaybackOutgoingCommands[] = {
     app::Clusters::MediaPlayback::Commands::PlaybackResponse::Id,

diff --git a/examples/tv-app/linux/include/media-playback/MediaPlaybackManager.h b/examples/tv-app/linux/include/media-playback/MediaPlaybackManager.h
@@ -24,7 +24,7 @@ using chip::app::AttributeValueEncoder;
 using chip::app::CommandResponseHelper;
 using MediaPlaybackDelegate = chip::app::Clusters::MediaPlayback::Delegate;
 using PlaybackResponseType  = chip::app::Clusters::MediaPlayback::Commands::PlaybackResponse::Type;
-using PlaybackPositionType  = chip::app::Clusters::MediaPlayback::Structs::PlaybackPosition::Type;
+using PlaybackPositionType  = chip::app::Clusters::MediaPlayback::Structs::PlaybackPositionStruct::Type;
 
 class MediaPlaybackManager : public MediaPlaybackDelegate
 {

diff --git a/examples/tv-app/tv-common/tv-app.matter b/examples/tv-app/tv-common/tv-app.matter
@@ -1676,15 +1676,15 @@ server cluster MediaPlayback = 1286 {
     kVariableSpeed = 0x2;
   }
 
-  struct PlaybackPosition {
-    int64u updatedAt = 0;
+  struct PlaybackPositionStruct {
+    epoch_us updatedAt = 0;
     nullable int64u position = 1;
   }
 
   readonly attribute PlaybackStateEnum currentState = 0;
   readonly attribute nullable epoch_us startTime = 1;
   readonly attribute nullable int64u duration = 2;
-  readonly attribute nullable PlaybackPosition sampledPosition = 3;
+  readonly attribute nullable PlaybackPositionStruct sampledPosition = 3;
   readonly attribute single playbackSpeed = 4;
   readonly attribute nullable int64u seekRangeEnd = 5;
   readonly attribute nullable int64u seekRangeStart = 6;
@@ -1713,7 +1713,7 @@ server cluster MediaPlayback = 1286 {
 
   command Play(): PlaybackResponse = 0;
   command Pause(): PlaybackResponse = 1;
-  command StopPlayback(): PlaybackResponse = 2;
+  command Stop(): PlaybackResponse = 2;
   command StartOver(): PlaybackResponse = 3;
   command Previous(): PlaybackResponse = 4;
   command Next(): PlaybackResponse = 5;

diff --git a/examples/tv-app/tv-common/tv-app.zap b/examples/tv-app/tv-common/tv-app.zap
@@ -8039,7 +8039,7 @@
               "outgoing": 0
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",
@@ -8183,7 +8183,7 @@
               "code": 3,
               "mfgCode": null,
               "side": "server",
-              "type": "PlaybackPosition",
+              "type": "PlaybackPositionStruct",
               "included": 1,
               "storageOption": "External",
               "singleton": 0,
@@ -11129,7 +11129,7 @@
               "outgoing": 1
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",
@@ -11291,7 +11291,7 @@
               "code": 3,
               "mfgCode": null,
               "side": "server",
-              "type": "PlaybackPosition",
+              "type": "PlaybackPositionStruct",
               "included": 1,
               "storageOption": "External",
               "singleton": 0,

diff --git a/examples/tv-casting-app/tv-casting-common/include/MediaPlayback.h b/examples/tv-casting-app/tv-casting-common/include/MediaPlayback.h
@@ -41,7 +41,7 @@ class PauseCommand : public MediaCommandBase<chip::app::Clusters::MediaPlayback:
     CHIP_ERROR Invoke(std::function<void(CHIP_ERROR)> responseCallback);
 };
 
-class StopPlaybackCommand : public MediaCommandBase<chip::app::Clusters::MediaPlayback::Commands::StopPlayback::Type,
+class StopPlaybackCommand : public MediaCommandBase<chip::app::Clusters::MediaPlayback::Commands::Stop::Type,
                                                     chip::app::Clusters::MediaPlayback::Commands::PlaybackResponse::DecodableType>
 {
 public:

diff --git a/examples/tv-casting-app/tv-casting-common/src/MediaPlayback.cpp b/examples/tv-casting-app/tv-casting-common/src/MediaPlayback.cpp
@@ -35,7 +35,7 @@ CHIP_ERROR PauseCommand::Invoke(std::function<void(CHIP_ERROR)> responseCallback
 
 CHIP_ERROR StopPlaybackCommand::Invoke(std::function<void(CHIP_ERROR)> responseCallback)
 {
-    MediaPlayback::Commands::StopPlayback::Type request;
+    MediaPlayback::Commands::Stop::Type request;
     return MediaCommandBase::Invoke(request, responseCallback);
 }
 

diff --git a/examples/tv-casting-app/tv-casting-common/tv-casting-app.matter b/examples/tv-casting-app/tv-casting-common/tv-casting-app.matter
@@ -1785,7 +1785,7 @@ client cluster MediaPlayback = 1286 {
 
   command Play(): PlaybackResponse = 0;
   command Pause(): PlaybackResponse = 1;
-  command StopPlayback(): PlaybackResponse = 2;
+  command Stop(): PlaybackResponse = 2;
   command StartOver(): PlaybackResponse = 3;
   command Previous(): PlaybackResponse = 4;
   command Next(): PlaybackResponse = 5;

diff --git a/examples/tv-casting-app/tv-casting-common/tv-casting-app.zap b/examples/tv-casting-app/tv-casting-common/tv-casting-app.zap
@@ -12573,7 +12573,7 @@
               "outgoing": 1
             },
             {
-              "name": "StopPlayback",
+              "name": "Stop",
               "code": 2,
               "mfgCode": null,
               "source": "client",

diff --git a/src/app/clusters/media-playback-server/media-playback-server.cpp b/src/app/clusters/media-playback-server/media-playback-server.cpp
@@ -275,8 +275,8 @@ bool emberAfMediaPlaybackClusterPauseCallback(app::CommandHandler * command, con
     return true;
 }
 
-bool emberAfMediaPlaybackClusterStopPlaybackCallback(app::CommandHandler * command, const app::ConcreteCommandPath & commandPath,
-                                                     const Commands::StopPlayback::DecodableType & commandData)
+bool emberAfMediaPlaybackClusterStopCallback(app::CommandHandler * command, const app::ConcreteCommandPath & commandPath,
+                                             const Commands::Stop::DecodableType & commandData)
 {
     CHIP_ERROR err      = CHIP_NO_ERROR;
     EndpointId endpoint = commandPath.mEndpointId;

diff --git a/src/app/tests/suites/TV_MediaPlaybackCluster.yaml b/src/app/tests/suites/TV_MediaPlaybackCluster.yaml
@@ -50,7 +50,7 @@ tests:
       command: "readAttribute"
       attribute: "SampledPosition"
       response:
-          value: { updatedAt: 0, position: 0 }
+          value: { UpdatedAt: 0, Position: 0 }
 
     - label: "Read attribute playback speed"
       command: "readAttribute"
@@ -74,111 +74,111 @@ tests:
       command: "play"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Pause Command"
       command: "pause"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Stop Command"
-      command: "stopPlayback"
+      command: "Stop"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Start Over Command"
       command: "startOver"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Previous Command"
       command: "previous"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Next Command"
       command: "next"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Rewind Command"
       command: "rewind"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Fast Forward Command"
       command: "fastForward"
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Media Playback Skip Forward Command"
       command: "skipForward"
       arguments:
           values:
-              - name: "deltaPositionMilliseconds"
+              - name: "DeltaPositionMilliseconds"
                 value: 500
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Read attribute position after skip forward"
       command: "readAttribute"
       attribute: "SampledPosition"
       response:
-          value: { updatedAt: 0, position: 500 }
+          value: { UpdatedAt: 0, Position: 500 }
 
     - label: "Media Playback Skip Backward Command"
       command: "skipBackward"
       arguments:
           values:
-              - name: "deltaPositionMilliseconds"
+              - name: "DeltaPositionMilliseconds"
                 value: 100
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Read attribute position after skip backward"
       command: "readAttribute"
       attribute: "SampledPosition"
       response:
-          value: { updatedAt: 0, position: 400 }
+          value: { UpdatedAt: 0, Position: 400 }
 
     - label: "Media Playback Seek Command"
       command: "seek"
@@ -188,13 +188,13 @@ tests:
                 value: 1000
       response:
           values:
-              - name: "data"
+              - name: "Data"
                 value: "data response"
-              - name: "status"
+              - name: "Status"
                 value: 0
 
     - label: "Read attribute position after seek"
       command: "readAttribute"
       attribute: "SampledPosition"
       response:
-          value: { updatedAt: 0, position: 1000 }
+          value: { UpdatedAt: 0, Position: 1000 }