'additional scene item methods'

Author: faithoflifedev

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 5.0.0+13
+
+* scene items
+  * GetSceneItemLocked
+  * SetSceneItemLocked
+* cli
+  * scene items
+    * GetSceneItemList
+    * GetSceneItemLocked
+    * SetSceneItemLocked
+* tests
+  * scene items
+    * GetSceneItemList
+    * GetSceneItemLocked
+    * SetSceneItemLocked
+
 ## 5.0.0+12
 
 * dependency bumps

README.md

@@ -45,7 +45,7 @@ In your project add the dependency:
 ```yml
 dependencies:
   ...
-  obs_websocket: ^5.0.0+12
+  obs_websocket: ^5.0.0+13
 ```
 
 For help getting started with dart, check out these [guides](https://dart.dev/guides).
@@ -202,8 +202,8 @@ For any of the items that have an [x] from the list below, a high level helper c
   - [ ] [SetSceneItemTransform](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemtransform)
   - [x] [GetSceneItemEnabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemenabled) - Gets the enable state of a scene item.
   - [x] [SetSceneItemEnabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemenabled) - Sets the enable state of a scene item.
-  - [ ] [GetSceneItemLocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlocked)
-  - [ ] [SetSceneItemLocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemlocked)
+  - [x] [GetSceneItemLocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlocked) - Gets the lock state of a scene item.
+  - [x] [SetSceneItemLocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemlocked) - Sets the lock state of a scene item.
   - [x] [GetSceneItemIndex](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemindex) - Gets the index position of a scene item in a scene.
   - [x] [SetSceneItemIndex](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemindex) - Sets the index position of a scene item in a scene.
   - [ ] [GetSceneItemBlendMode](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemblendmode)
@@ -515,13 +515,14 @@ Global options:
 -p, --passwd=<string>             The OBS websocket password, only required if enabled in OBS
 
 Available commands:
-  authorize   Generate an authentication file for an OBS connection
-  config      Config Requests
-  general     General commands
-  listen      Generate OBS events to stdout
-  send        Send a low-level websocket request to OBS
-  sources     Commands that manipulate OBS sources
-  stream      Commands that manipulate OBS streams
-  ui          Commands that manipulate the OBS user interface.
-  version     Display the package name and version
+  authorize     Generate an authentication file for an OBS connection
+  config        Config Requests
+  general       General commands
+  listen        Generate OBS events to stdout
+  scene-items   Scene Items Requests
+  send          Send a low-level websocket request to OBS
+  sources       Commands that manipulate OBS sources
+  stream        Commands that manipulate OBS streams
+  ui            Commands that manipulate the OBS user interface.
+  version       Display the package name and version
 ```

bin/README.md

@@ -75,14 +75,16 @@ Global options:
 -p, --passwd=<string>             The OBS websocket password, only required if enabled in OBS
 
 Available commands:
-  authorize   Generate an authentication file for an OBS connection
-  config      Config Requests
-  general     General commands
-  listen      Generate OBS events to stdout
-  send        Send a low-level websocket request to OBS
-  sources     Commands that manipulate OBS sources
-  stream      Commands that manipulate OBS streaming
-  version     Display the package name version
+  authorize     Generate an authentication file for an OBS connection
+  config        Config Requests
+  general       General commands
+  listen        Generate OBS events to stdout
+  scene-items   Scene Items Requests
+  send          Send a low-level websocket request to OBS
+  sources       Commands that manipulate OBS sources
+  stream        Commands that manipulate OBS streams
+  ui            Commands that manipulate the OBS user interface.
+  version       Display the package name and version
 ```
 
 | command | description |
@@ -309,6 +311,69 @@ Usage: obs listen [arguments]
           [vendors]                     Subscription value to receive the VendorEvent event.
 ```
 
+### scene-items
+
+```sh
+obs scene-items --help
+```
+
+```text
+Scene Items Requests
+
+Usage: obs scene-items <subcommand> [arguments]
+-h, --help    Print this usage information.
+
+Available subcommands:
+  get-scene-item-list     Gets the lock state of a scene item.
+  get-scene-item-locked   Gets the lock state of a scene item.
+  set-scene-item-locked   Sets the lock state of a scene item.
+```
+
+## scene-items get-scene-item-list
+
+```sh
+obs scene-items get-scene-item-list --help
+```
+
+```text
+Gets a list of all scene items in a scene.
+
+Usage: obs scene-items get-scene-item-list [arguments]
+-h, --help                               Print this usage information.
+-n, --scene-name=<string> (mandatory)    Name of the scene to get the items of
+```
+
+## scene-items get-scene-item-locked
+
+```sh
+obs scene-items get-scene-item-locked --help
+```
+
+```text
+Gets the lock state of a scene item.
+
+Usage: obs scene-items get-scene-item-locked [arguments]
+-h, --help                               Print this usage information.
+-n, --scene-name=<string> (mandatory)    Name of the scene the item is in
+-i, --scene-item-id=<int> (mandatory)    Numeric ID of the scene item
+```
+
+## scene-items set-scene-item-locked
+
+```sh
+obs scene-items set-scene-item-locked --help
+```
+
+```text
+Sets the lock state of a scene item.
+
+Usage: obs scene-items set-scene-item-locked [arguments]
+-h, --help                               Print this usage information.
+-n, --scene-name=<string> (mandatory)    Name of the scene the item is in
+-i, --scene-item-id=<int> (mandatory)    Numeric ID of the scene item
+-l, --[no-]scene-item-locked             New lock state of the scene item
+```
+
 ### send
 
 ```sh

bin/obs.dart

@@ -31,7 +31,7 @@ void main(List<String> arguments) async {
     ..addCommand(ObsSourcesCommand())
     // ..addCommand(ObsProfilesCommand())
     // ..addCommand(ObsRecordingCommand())
-    // ..addCommand(ObsSceneItemsCommand())
+    ..addCommand(ObsSceneItemsCommand())
     // ..addCommand(ObsScenesCommand())
     ..addCommand(ObsStreamCommand())
     ..addCommand(ObsUiCommand())

lib/command.dart

@@ -8,6 +8,7 @@ export 'src/cmd/obs_config_command.dart';
 export 'src/cmd/obs_general_command.dart';
 export 'src/cmd/obs_helper_command.dart';
 export 'src/cmd/obs_listen_command.dart';
+export 'src/cmd/obs_scene_items_command.dart';
 export 'src/cmd/obs_send_command.dart';
 export 'src/cmd/obs_sources_command.dart';
 export 'src/cmd/obs_stream_command.dart';

lib/src/cmd/obs_scene_items_command.dart

@@ -0,0 +1,126 @@
+import 'package:args/command_runner.dart';
+import 'package:obs_websocket/command.dart';
+
+/// Config Requests
+class ObsSceneItemsCommand extends Command {
+  @override
+  String get description => 'Scene Items Requests';
+
+  @override
+  String get name => 'scene-items';
+
+  ObsSceneItemsCommand() {
+    addSubcommand(ObsGetSceneItemListCommand());
+    addSubcommand(ObsGetSceneItemLockedCommand());
+    addSubcommand(ObsSetSceneItemLockedCommand());
+  }
+}
+
+/// Gets a list of all scene items in a scene.
+class ObsGetSceneItemListCommand extends ObsHelperCommand {
+  @override
+  String get description => 'Gets the lock state of a scene item.';
+
+  @override
+  String get name => 'get-scene-item-list';
+
+  ObsGetSceneItemListCommand() {
+    argParser.addOption('scene-name',
+        abbr: 'n',
+        mandatory: true,
+        valueHelp: 'string',
+        help: 'Name of the scene to get the items of');
+  }
+
+  @override
+  void run() async {
+    await initializeObs();
+
+    final sceneItemDetailList =
+        await obs.sceneItems.getSceneItemList(argResults!['scene-name']);
+
+    print(sceneItemDetailList);
+
+    obs.close();
+  }
+}
+
+/// Gets the lock state of a scene item.
+class ObsGetSceneItemLockedCommand extends ObsHelperCommand {
+  @override
+  String get description => 'Gets the lock state of a scene item.';
+
+  @override
+  String get name => 'get-scene-item-locked';
+
+  ObsGetSceneItemLockedCommand() {
+    argParser
+      ..addOption('scene-name',
+          abbr: 'n',
+          mandatory: true,
+          valueHelp: 'string',
+          help: 'Name of the scene the item is in')
+      ..addOption(
+        'scene-item-id',
+        abbr: 'i',
+        mandatory: true,
+        valueHelp: 'int',
+        help: 'Numeric ID of the scene item',
+      );
+  }
+
+  @override
+  void run() async {
+    await initializeObs();
+
+    final isLocked = await obs.sceneItems.getLocked(
+        sceneName: argResults!['scene-name'],
+        sceneItemId: int.parse(argResults!['scene-item-id']));
+
+    print(isLocked);
+
+    obs.close();
+  }
+}
+
+/// Sets the lock state of a scene item.
+class ObsSetSceneItemLockedCommand extends ObsHelperCommand {
+  @override
+  String get description => 'Sets the lock state of a scene item.';
+
+  @override
+  String get name => 'set-scene-item-locked';
+
+  ObsSetSceneItemLockedCommand() {
+    argParser
+      ..addOption('scene-name',
+          abbr: 'n',
+          mandatory: true,
+          valueHelp: 'string',
+          help: 'Name of the scene the item is in')
+      ..addOption(
+        'scene-item-id',
+        abbr: 'i',
+        mandatory: true,
+        valueHelp: 'int',
+        help: 'Numeric ID of the scene item',
+      )
+      ..addFlag(
+        'scene-item-locked',
+        abbr: 'l',
+        help: 'New lock state of the scene item',
+      );
+  }
+
+  @override
+  void run() async {
+    await initializeObs();
+
+    await obs.sceneItems.setLocked(
+        sceneName: argResults!['scene-name'],
+        sceneItemId: int.parse(argResults!['scene-item-id']),
+        sceneItemLocked: argResults!['scene-item-locked']);
+
+    obs.close();
+  }
+}

lib/src/model/response/boolean_response.dart

@@ -11,22 +11,26 @@ class BooleanResponse {
   final bool? sceneItemEnabled;
   final bool? studioModeEnabled;
   final bool? inputMuted;
+  final bool? sceneItemLocked;
 
   bool get enabled {
-    final bool? check =
-        outputActive ?? sceneItemEnabled ?? studioModeEnabled ?? inputMuted;
+    final bool? check = outputActive ??
+        sceneItemEnabled ??
+        studioModeEnabled ??
+        inputMuted ??
+        sceneItemLocked;
 
     if (check == null) throw Exception();
 
     return check;
   }
 
-  BooleanResponse({
-    this.outputActive,
-    this.sceneItemEnabled,
-    this.studioModeEnabled,
-    this.inputMuted,
-  });
+  BooleanResponse(
+      {this.outputActive,
+      this.sceneItemEnabled,
+      this.studioModeEnabled,
+      this.inputMuted,
+      this.sceneItemLocked});
 
   factory BooleanResponse.fromJson(Map<String, dynamic> json) =>
       _$BooleanResponseFromJson(json);