'SendStreamCaption, GetRecordDirectory, ScreenshotSaved'

Author: faithoflifedev

.github/workflows/dart.yml

@@ -7,11 +7,14 @@ name: Dart
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
+  pana:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/pana.yml@v1
+
   build:
     runs-on: ubuntu-latest
 

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 5.1.0
+
+* stream
+  * SendStreamCaption
+* config
+  * GetRecordDirectory
+* ui event
+  * ScreenshotSaved
+* commands
+  * stream
+    * SendStreamCaption
+  * config
+    * GetRecordDirectory
+
 ## 5.0.0+15
 
 * fix publish_tools dependency

README.md

@@ -45,7 +45,7 @@ In your project add the dependency:
 ```yml
 dependencies:
   ...
-  obs_websocket: ^5.0.0+15
+  obs_websocket: ^5.1.0
 ```
 
 For help getting started with dart, check out these [guides](https://dart.dev/guides).
@@ -231,7 +231,7 @@ For any of the items that have an [x] from the list below, a high level helper c
   - [x] [ToggleStream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglestream) - Toggles the status of the stream output.
   - [x] [StartStream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startstream) - Starts the stream output.
   - [x] [StopStream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopstream) - Stops the stream output.
-  - [ ] [SendStreamCaption](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sendstreamcaption)
+  - [x] [SendStreamCaption](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sendstreamcaption) - Sends CEA-608 caption text over the stream output.
 - [Record Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#record-requests) - `obsWebSocket.record`
   - [x] [GetRecordStatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getrecordstatus) - Gets the status of the record output.
   - [x] [ToggleRecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglerecord) - Toggles the status of the record output.
@@ -450,7 +450,8 @@ if (!sceneItemEnabled) {
   - [ ] [MediaInputActionTriggered](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#mediainputactiontriggered)
 - [Ui Events](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#ui-events)
   - [x] [StudioModeStateChanged](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#studiomodestatechanged) - Studio mode has been enabled or disabled.
-
+  - [x] [ScreenshotSaved](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#screenshotsaved) - A screenshot has been saved. 
+  
 ### Handling events not yet supported
 
 You can supply a `fallbackEvent` to the `ObsWebSocket` constructor to handle events that are not yet supported directly in the code.  The following code snippet provides an example of this.

bin/README.md

@@ -2,38 +2,44 @@
 # Easy OBS WebSocket CLI
 
 A command line interface for controlling OBS with cli commands
+
 - [Installation](#installation)
 - [Quick start](#quick-start)
 - [Available Commands](#available-commands)
-- [authorize](#authorize)
-- [config](#config)
-  - [config get-stream-service-settings](#config-get-stream-service-settings)
-  - [config get-video-settings](#config-get-video-settings)
-  - [config set-stream-service-settings](#config-set-stream-service-settings)
-  - [config set-video-settings](#config-set-video-settings)
-- [general](#general)
-  - [general get-stats](#general-get-stats)
-  - [general get-version](#general-get-version)
-- [listen](#listen)
-- [send](#send)
-- [sources](#sources)
-  - [sources get-source-active](#sources-get-source-active)
-  - [sources get-source-screenshot](#sources-get-source-screenshot)
-  - [sources save-source-screenshot](#sources-save-source-screenshot)
-- [stream](#stream)
-  - [stream get-stream-status](#stream-get-stream-status)
-  - [stream start-streaming](#stream-start-streaming)
-  - [stream stop-streaming](#stream-stop-streaming)
-  - [stream toggle-stream](#stream-toggle-stream)
-- [ui](#ui)
-  - [ui get-monitor-list](#ui-get-monitor-list)
-  - [ui get-studio-mode-enabled](#ui-get-studio-mode-enabled)
-  - [ui set-studio-mode-enabled](#ui-set-studio-mode-enabled)
-- [version](#version)
+  - [authorize](#authorize)
+  - [config](#config)
+    - [config get-record-directory](#config-get-record-directory)
+    - [config get-stream-service-settings](#config-get-stream-service-settings)
+    - [config get-video-settings](#config-get-video-settings)
+    - [config set-stream-service-settings](#config-set-stream-service-settings)
+    - [config set-video-settings](#config-set-video-settings)
+  - [general](#general)
+    - [general get-stats](#general-get-stats)
+    - [general get-version](#general-get-version)
+  - [listen](#listen)
+  - [scene-items](#scene-items)
+- [scene-items get-scene-item-list](#scene-items-get-scene-item-list)
+- [scene-items get-scene-item-locked](#scene-items-get-scene-item-locked)
+- [scene-items set-scene-item-locked](#scene-items-set-scene-item-locked)
+  - [send](#send)
+  - [sources](#sources)
+    - [sources get-source-active](#sources-get-source-active)
+    - [sources get-source-screenshot](#sources-get-source-screenshot)
+    - [sources save-source-screenshot](#sources-save-source-screenshot)
+  - [stream](#stream)
+    - [stream get-stream-status](#stream-get-stream-status)
+    - [stream send-stream-caption](#stream-send-stream-caption)
+    - [stream start-streaming](#stream-start-streaming)
+    - [stream stop-streaming](#stream-stop-streaming)
+    - [stream toggle-stream](#stream-toggle-stream)
+  - [ui](#ui)
+    - [ui get-monitor-list](#ui-get-monitor-list)
+    - [ui get-studio-mode-enabled](#ui-get-studio-mode-enabled)
+    - [ui set-studio-mode-enabled](#ui-set-studio-mode-enabled)
+  - [version](#version)
 - [Advanced Usage](#advanced-usage)
-- [Subscribing to an OBS event](#subscribing-to-an-obs-event)
-- [Trigger a shell command for an OBS event](#trigger-a-shell-command-for-an-obs-event)
-
+  - [Subscribing to an OBS event](#subscribing-to-an-obs-event)
+  - [Trigger a shell command for an OBS event](#trigger-a-shell-command-for-an-obs-event)
 
 ## Installation
 
@@ -170,12 +176,27 @@ Usage: obs config <subcommand> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
+  get-record-directory          Gets the current directory that the record output is set to.
   get-stream-service-settings   Gets the current stream service settings (stream destination).
   get-video-settings            Gets the current video settings.
   set-stream-service-settings   Sets the current stream service settings (stream destination).
   set-video-settings            Sets the current video settings.
 ```
 
+#### config get-record-directory
+
+```sh
+obs config get-record-directory --help
+```
+
+```text
+Gets the current directory that the record output is set to.
+
+Usage: obs config get-record-directory [arguments]
+-h, --help    Print this usage information.
+```
+
+
 #### config get-stream-service-settings
 
 ```sh
@@ -186,6 +207,7 @@ obs config get-stream-service-settings --help
 Gets the current stream service settings (stream destination).
 
 Usage: obs config get-stream-service-settings [arguments]
+-h, --help    Print this usage information.
 ```
 
 #### config get-video-settings
@@ -198,6 +220,7 @@ obs config get-video-settings --help
 Gets the current video settings.
 
 Usage: obs config get-video-settings [arguments]
+-h, --help    Print this usage information.
 ```
 
 #### config set-stream-service-settings
@@ -465,10 +488,11 @@ Usage: obs stream <subcommand> [arguments]
 -h, --help    Print this usage information.
 
 Available subcommands:
-  get-stream-status   Gets the status of the stream output.
-  start-streaming     Starts the stream output.
-  stop-streaming      Stops the stream output.
-  toggle-stream       Toggles the status of the stream output.
+  get-stream-status     Gets the status of the stream output.
+  send-stream-caption   Sends CEA-608 caption text over the stream output.
+  start-streaming       Starts the stream output.
+  stop-streaming        Stops the stream output.
+  toggle-stream         Toggles the status of the stream output.
 ```
 
 #### stream get-stream-status
@@ -484,6 +508,20 @@ Usage: obs stream get-stream-status [arguments]
 -h, --help    Print this usage information.
 ```
 
+#### stream send-stream-caption
+
+```sh
+obs stream send-stream-caption --help
+```
+
+```text
+Sends CEA-608 caption text over the stream output.
+
+Usage: obs stream send-stream-caption [arguments]
+-h, --help                                 Print this usage information.
+    --caption-Text=<string> (mandatory)    Caption text
+```
+
 #### stream start-streaming
 
 ```sh

lib/meta.dart

@@ -3,4 +3,4 @@
 import 'dart:convert' show json;
 
 final pubSpec = json.decode(
-    '{"name":"obs_websocket","version":"5.0.0+15","homepage":"https://github.com/faithoflifedev/easy_obs_websocket","environment":{"sdk":">=2.17.3 <3.0.0"},"description":"obs_websocket allows dart-based connections to the OBS (Open Broadcaster Software) plugin obs-websocket","dependencies":{"args":"^2.3.1","crypto":"^3.0.2","json_annotation":"^4.7.0","loggy":"^2.0.3","uuid":"^3.0.7","universal_io":"^2.0.4","validators":"^3.0.0","web_socket_channel":"^2.2.0","yaml":"^3.1.1"},"dev_dependencies":{"build_runner":"^2.3.2","grinder":"^0.9.3","http":"^0.13.5","json_serializable":"^6.5.4","lints":"^2.0.1","mustache_template":"^2.0.0","path":"^1.8.2","process_run":"^0.12.3+2","pub_semver":"^2.1.3","pubspec":"^2.3.0","test":"^1.22.0","publish_tools":"^0.1.0+10"},"executables":{"obs":""},"repository":"https://github.com/faithoflifedev/easy_obs_websocket"}');
+    '{"name":"obs_websocket","version":"5.1.0","homepage":"https://github.com/faithoflifedev/easy_obs_websocket","environment":{"sdk":">=2.17.3 <3.0.0"},"description":"obs_websocket allows dart-based connections to the OBS (Open Broadcaster Software) plugin obs-websocket","dependencies":{"args":"^2.4.0","crypto":"^3.0.2","json_annotation":"^4.8.0","loggy":"^2.0.3","uuid":"^3.0.7","universal_io":"^2.2.0","validators":"^3.0.0","web_socket_channel":"^2.3.0","yaml":"^3.1.1"},"dev_dependencies":{"build_runner":"^2.3.3","grinder":"^0.9.3","http":"^0.13.5","json_serializable":"^6.6.1","lints":"^2.0.1","mustache_template":"^2.0.0","path":"^1.8.3","process_run":"^0.12.5+2","pub_semver":"^2.1.3","pubspec":"^2.3.0","test":"^1.23.1","publish_tools":"^0.1.0+10"},"executables":{"obs":""},"repository":"https://github.com/faithoflifedev/easy_obs_websocket"}');

lib/obs_websocket.dart

@@ -31,6 +31,7 @@ export 'src/model/response/monitor_list_response.dart';
 export 'src/model/response/profile_list_response.dart';
 export 'src/model/response/profile_parameter_response.dart';
 export 'src/model/response/record_status_response.dart';
+export 'src/model/response/record_directory_response.dart';
 export 'src/model/response/scene_collection_list_response.dart';
 export 'src/model/response/scene_item_list_response.dart';
 export 'src/model/response/scene_list_response.dart';

lib/src/cmd/obs_config_command.dart

@@ -19,6 +19,7 @@ class ObsConfigCommand extends Command {
     addSubcommand(ObsSetVideoSettingsCommand());
     addSubcommand(ObsGetStreamServiceSettingsCommand());
     addSubcommand(ObsSetStreamServiceSettingsCommand());
+    addSubcommand(ObsGetRecordDirectoryCommand());
     // addSubcommand(ObsGetHotkeyListCommand());
     // addSubcommand(ObsTriggerHotkeyByNameCommand());
     // addSubcommand(ObsTriggerHotkeyByKeySequenceCommand());
@@ -164,3 +165,22 @@ class ObsSetStreamServiceSettingsCommand extends ObsHelperCommand {
     obs.close();
   }
 }
+
+/// Gets the current directory that the record output is set to.
+class ObsGetRecordDirectoryCommand extends ObsHelperCommand {
+  @override
+  String get description =>
+      'Gets the current directory that the record output is set to.';
+
+  @override
+  String get name => 'get-record-directory';
+
+  @override
+  void run() async {
+    await initializeObs();
+
+    final result = await obs.config.getRecordDirectory();
+
+    print(result.recordDirectory);
+  }
+}

lib/src/cmd/obs_stream_command.dart

@@ -14,6 +14,7 @@ class ObsStreamCommand extends Command {
     addSubcommand(ObsToggleStreamCommand());
     addSubcommand(ObsStartStreamCommand());
     addSubcommand(ObsStopStreamCommand());
+    addSubcommand(ObsSendStreamCaptionCommand());
   }
 }
 
@@ -90,3 +91,27 @@ class ObsStopStreamCommand extends ObsHelperCommand {
     obs.close();
   }
 }
+
+/// Sends CEA-608 caption text over the stream output.
+class ObsSendStreamCaptionCommand extends ObsHelperCommand {
+  @override
+  String get description =>
+      'Sends CEA-608 caption text over the stream output.';
+
+  @override
+  String get name => 'send-stream-caption';
+
+  ObsSendStreamCaptionCommand() {
+    argParser.addOption('caption-Text',
+        mandatory: true, valueHelp: 'string', help: 'Caption text');
+  }
+
+  @override
+  void run() async {
+    await initializeObs();
+
+    await obs.stream.sendStreamCaption(argResults!['caption-Text']);
+
+    obs.close();
+  }
+}

lib/src/model/event/outputs/record_state_changed.dart

@@ -4,10 +4,16 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'record_state_changed.g.dart';
 
+/// The state of the record output has changed.
 @JsonSerializable()
 class RecordStateChanged {
+  /// Whether the output is active
   final bool outputActive;
+
+  /// The specific state of the output
   final String outputState;
+
+  /// File name for the saved recording, if record stopped. null otherwise
   final String outputPath;
 
   RecordStateChanged({

lib/src/model/event/outputs/stream_state_changed.dart

@@ -4,9 +4,13 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'stream_state_changed.g.dart';
 
+/// The state of the stream output has changed.
 @JsonSerializable()
 class StreamStateChanged {
+  /// Whether the output is active
   final bool outputActive;
+
+  /// The specific state of the output
   final String outputState;
 
   StreamStateChanged({