ElevenLabs-DotNet 3.4.2 (#78)

- Added flash models - Added stream input support to dubbing endpoint - Fixed http/https protocol in client settings --------- Co-authored-by: Austin Hale <32556981+austinbhale@users.noreply.github.com>
RageAgainstThePixel · Jan 13, 2025 · b26193a · b26193a
1 parent 9884433
commit b26193a
Show file tree

Hide file tree

Showing 9 changed files with 190 additions and 25 deletions.
diff --git a/.github/workflows/Publish-Nuget.yml b/.github/workflows/Publish-Nuget.yml
@@ -1,4 +1,4 @@
-name: Nuget Publish
+name: Build and Publish
 
 on:
   push:
@@ -22,23 +22,36 @@ on:
       dotnet-version:
         description: ".NET version to use"
         required: false
-        default: "6.0.x"
+        default: "8.x"
+
+permissions:
+  contents: read
+  pages: write
+  checks: write
+  id-token: write
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
 
 env:
-  DOTNET_VERSION: ${{ github.event.inputs.dotnet-version || '6.0.x' }}
-  PACKAGE_VERSION: ''
+  DOTNET_VERSION: ${{ github.event.inputs.dotnet-version || '8.x' }}
 
 jobs:
   build:
     if: ${{ !github.event_name == 'pull_request' || !github.event.pull_request.draft }}
+    env:
+      PACKAGE_VERSION: ''
+      COVERAGE_FILE_PATH: ''
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
-    - uses: actions/setup-dotnet@v3
+    - uses: actions/setup-dotnet@v4
       with:
         dotnet-version: ${{ env.DOTNET_VERSION }}
 
@@ -61,11 +74,18 @@ jobs:
         report_individual_runs: true
         compare_to_earlier_commit: false
 
+    - name: Determine Coverage File Path
+      if: ${{ github.ref != 'refs/heads/main' && github.event_name != 'push' && always() }}
+      shell: bash
+      run: |
+        COVERAGE_FILE_PATH=$(find ./test-results -name 'coverage.cobertura.xml' | head -n 1)
+        echo "COVERAGE_FILE_PATH=$COVERAGE_FILE_PATH" >> $GITHUB_ENV
+
     - name: Code Coverage Summary Report
       if: ${{ github.ref != 'refs/heads/main' && github.event_name != 'push' && always() }}
       uses: irongut/CodeCoverageSummary@v1.3.0
       with:
-        filename: test-results/**/coverage.cobertura.xml
+        filename: ${{ env.COVERAGE_FILE_PATH }}
         badge: true
         format: 'markdown'
         output: 'both'
@@ -114,7 +134,7 @@ jobs:
         echo "PACKAGE_VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
       shell: pwsh
 
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       if: always()
       with:
         name: ElevenLabs-DotNet.${{ env.PACKAGE_VERSION }}
@@ -124,3 +144,33 @@ jobs:
           ${{ github.workspace }}/ElevenLabs-DotNet/bin/Release/ElevenLabs-DotNet-Proxy.${{ env.PACKAGE_VERSION }}.nupkg
           ${{ github.workspace }}/ElevenLabs-DotNet/bin/Release/ElevenLabs-DotNet-Proxy.${{ env.PACKAGE_VERSION }}.symbols.nupkg
         if-no-files-found: ignore
+
+  docs:
+    if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' }}
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: ${{ env.DOTNET_VERSION }}
+
+    - name: build docfx
+      run: |
+        dotnet tool update -g docfx
+        docfx .docs/docfx.json
+
+    - uses: actions/upload-pages-artifact@v3
+      with:
+        path: '_site'
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4.0.3
diff --git a/ElevenLabs-DotNet/Authentication/ElevenLabsClientSettings.cs b/ElevenLabs-DotNet/Authentication/ElevenLabsClientSettings.cs
@@ -6,6 +6,7 @@ namespace ElevenLabs
 {
     public sealed class ElevenLabsClientSettings
     {
+        internal const string Http = "http://";
         internal const string Https = "https://";
         internal const string DefaultApiVersion = "v1";
         internal const string ElevenLabsDomain = "api.elevenlabs.io";
@@ -44,7 +45,20 @@ public ElevenLabsClientSettings(string domain, string apiVersion = DefaultApiVer
                 apiVersion = DefaultApiVersion;
             }
 
-            Domain = domain.Contains("http") ? domain : $"{Https}{domain}";
+            var protocol = Https;
+
+            if (domain.StartsWith(Http))
+            {
+                protocol = Http;
+                domain = domain.Replace(Http, string.Empty);
+            }
+            else if (domain.StartsWith(Https))
+            {
+                protocol = Https;
+                domain = domain.Replace(Https, string.Empty);
+            }
+
+            Domain = $"{protocol}{domain}";
             ApiVersion = apiVersion;
             BaseRequest = $"/{ApiVersion}/";
             BaseRequestUrlFormat = $"{Domain}{BaseRequest}{{0}}";

diff --git a/ElevenLabs-DotNet/Dubbing/DubbingEndpoint.cs b/ElevenLabs-DotNet/Dubbing/DubbingEndpoint.cs
@@ -38,9 +38,9 @@ public async Task<DubbingProjectMetadata> DubAsync(DubbingRequest request, int?
             {
                 if (request.Files != null)
                 {
-                    foreach (var (fileName, mediaType, stream) in request.Files)
+                    foreach (var dub in request.Files)
                     {
-                        await payload.AppendFileToFormAsync("file", stream, fileName, new(mediaType), cancellationToken);
+                        await payload.AppendFileToFormAsync("file", dub.Stream, dub.Name, new(dub.MediaType), cancellationToken);
                     }
                 }
 

diff --git a/ElevenLabs-DotNet/Dubbing/DubbingRequest.cs b/ElevenLabs-DotNet/Dubbing/DubbingRequest.cs
@@ -36,7 +36,7 @@ public DubbingRequest(
             bool? dropBackgroundAudio = null,
             bool? useProfanityFilter = null,
             string projectName = null)
-            : this(targetLanguage, null, filePaths, sourceLanguage, numberOfSpeakers, watermark, startTime, endTime, highestResolution, dropBackgroundAudio, useProfanityFilter, projectName)
+            : this(targetLanguage, null, null, filePaths, sourceLanguage, numberOfSpeakers, watermark, startTime, endTime, highestResolution, dropBackgroundAudio, useProfanityFilter, projectName)
         {
         }
 
@@ -52,13 +52,30 @@ public DubbingRequest(
             bool? dropBackgroundAudio = null,
             bool? useProfanityFilter = null,
             string projectName = null)
-            : this(targetLanguage, sourceUrl, null, sourceLanguage, numberOfSpeakers, watermark, startTime, endTime, highestResolution, dropBackgroundAudio, useProfanityFilter, projectName)
+            : this(targetLanguage, sourceUrl, null, null, sourceLanguage, numberOfSpeakers, watermark, startTime, endTime, highestResolution, dropBackgroundAudio, useProfanityFilter, projectName)
+        {
+        }
+
+        public DubbingRequest(
+            List<DubbingStream> files,
+            string targetLanguage,
+            string sourceLanguage = null,
+            int? numberOfSpeakers = null,
+            bool? watermark = null,
+            int? startTime = null,
+            int? endTime = null,
+            bool? highestResolution = null,
+            bool? dropBackgroundAudio = null,
+            bool? useProfanityFilter = null,
+            string projectName = null)
+            : this(targetLanguage, null, files, null, sourceLanguage, numberOfSpeakers, watermark, startTime, endTime, highestResolution, dropBackgroundAudio, useProfanityFilter, projectName)
         {
         }
 
         private DubbingRequest(
             string targetLanguage,
             Uri sourceUrl = null,
+            List<DubbingStream> files = null,
             IEnumerable<string> filePaths = null,
             string sourceLanguage = null,
             int? numberOfSpeakers = null,
@@ -78,7 +95,7 @@ private DubbingRequest(
                 throw new ArgumentException("Either sourceUrl or filePaths must be provided.");
             }
 
-            var files = new List<(string, string, Stream)>();
+            files ??= [];
 
             if (filePaths != null)
             {
@@ -113,7 +130,7 @@ private DubbingRequest(
                         ".webm" => "video/webm",
                         _ => "application/octet-stream"
                     };
-                    files.Add((fileInfo.Name, mediaType, stream));
+                    files.Add(new(stream, fileInfo.Name, mediaType));
                 }
             }
 
@@ -135,7 +152,7 @@ private DubbingRequest(
         /// <summary>
         /// Files to dub.
         /// </summary>
-        public IReadOnlyList<(string, string, Stream)> Files { get; }
+        public IReadOnlyList<DubbingStream> Files { get; }
 
         /// <summary>
         /// URL of the source video/audio file.
@@ -204,12 +221,12 @@ private void Dispose(bool disposing)
             if (disposing)
             {
                 if (Files == null) { return; }
-                foreach (var (_, _, stream) in Files)
+
+                foreach (var dub in Files)
                 {
                     try
                     {
-                        stream?.Close();
-                        stream?.Dispose();
+                        dub.Dispose();
                     }
                     catch (Exception e)
                     {

diff --git a/ElevenLabs-DotNet/Dubbing/DubbingStream.cs b/ElevenLabs-DotNet/Dubbing/DubbingStream.cs
@@ -0,0 +1,64 @@
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using System;
+using System.IO;
+
+namespace ElevenLabs.Dubbing
+{
+    public sealed class DubbingStream : IDisposable
+    {
+        public DubbingStream(Stream stream, string name, string mediaType)
+        {
+            Stream = stream ?? throw new ArgumentNullException(nameof(stream));
+
+            if (Stream.Length == 0)
+            {
+                throw new ArgumentException("Stream cannot be empty.");
+            }
+
+            if (!Stream.CanRead)
+            {
+                throw new ArgumentException("Stream must be readable.");
+            }
+
+            Name = name ?? throw new ArgumentNullException(nameof(name));
+
+            if (string.IsNullOrWhiteSpace(Name))
+            {
+                throw new ArgumentException("Name cannot be empty.");
+            }
+
+            MediaType = mediaType ?? throw new ArgumentNullException(nameof(mediaType));
+
+            if (string.IsNullOrWhiteSpace(MediaType))
+            {
+                throw new ArgumentException("Media type cannot be empty.");
+            }
+
+            if (MediaType.Contains("/"))
+            {
+                var parts = MediaType.Split('/');
+
+                if (parts.Length != 2 || string.IsNullOrWhiteSpace(parts[0]) || string.IsNullOrWhiteSpace(parts[1]))
+                {
+                    throw new ArgumentException("Invalid media type.");
+                }
+            }
+            else
+            {
+                throw new ArgumentException("Invalid media type.");
+            }
+        }
+
+        public Stream Stream { get; }
+
+        public string Name { get; }
+
+        public string MediaType { get; }
+
+        public void Dispose()
+        {
+            Stream?.Dispose();
+        }
+    }
+}
diff --git a/ElevenLabs-DotNet/ElevenLabs-DotNet.csproj b/ElevenLabs-DotNet/ElevenLabs-DotNet.csproj
@@ -25,8 +25,12 @@ All copyrights, trademarks, logos, and assets are the property of their respecti
     <SignAssembly>false</SignAssembly>
     <IncludeSymbols>true</IncludeSymbols>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>3.4.1</Version>
+    <Version>3.4.2</Version>
     <PackageReleaseNotes>
+Version 3.4.2
+- Added flash models
+- Added stream input support to dubbing endpoint
+- Fixed http/https protocol in client settings
 Version 3.4.1
 - Removed text length check in TextToSpeechRequest
 Version 3.4.0

diff --git a/ElevenLabs-DotNet/Models/Model.cs b/ElevenLabs-DotNet/Models/Model.cs
@@ -51,6 +51,18 @@ public Model(string id)
 
         #region Predefined Models
 
+        /// <summary>
+        /// Our latest, ultra-low-latency model, generating speech in under 75ms.  Best for developer use cases requiring speed and multiple languages.
+        /// </summary>
+        [JsonIgnore]
+        public static Model FlashV2 { get; } = new("eleven_flash_v2");
+
+        /// <summary>
+        /// Our latest, ultra-low-latency English only model, generating speech in under 75ms.  Best for developer use cases requiring speed.
+        /// </summary>
+        [JsonIgnore]
+        public static Model FlashV2_5 { get; } = new("eleven_flash_v2_5");
+
         [JsonIgnore]
         [Obsolete("Use EnglishV1")]
         public static Model MonoLingualV1 => EnglishV1;

diff --git a/ElevenLabs-DotNet/TextToSpeech/TextToSpeechRequest.cs b/ElevenLabs-DotNet/TextToSpeech/TextToSpeechRequest.cs
@@ -30,7 +30,7 @@ public TextToSpeechRequest(string text, Model model, VoiceSettings voiceSettings
         /// Optional, <see cref="VoiceSettings"/> that will override the default settings in <see cref="Voice.Settings"/>.
         /// </param>
         /// <param name="model">
-        /// Optional, <see cref="Model"/> to use. Defaults to <see cref="Model.TurboV2_5"/>.
+        /// Optional, <see cref="Model"/> to use. Defaults to <see cref="Model.FlashV2"/>.
         /// </param>
         /// <param name="outputFormat">
         /// Output format of the generated audio.<br/>
@@ -52,7 +52,7 @@ public TextToSpeechRequest(string text, Model model, VoiceSettings voiceSettings
         /// <param name="previousRequestIds"></param>
         /// <param name="nextRequestIds"></param>
         /// <param name="languageCode">
-        /// Optional, Language code (ISO 639-1) used to enforce a language for the model. Currently only <see cref="Model.TurboV2_5"/> supports language enforcement. 
+        /// Optional, Language code (ISO 639-1) used to enforce a language for the model. Currently only <see cref="Model.TurboV2_5"/> supports language enforcement.
         /// For other models, an error will be returned if language code is provided.
         /// </param>
         /// <param name="withTimestamps"></param>
@@ -88,7 +88,7 @@ public TextToSpeechRequest(
             }
 
             Text = text;
-            Model = model ?? Models.Model.TurboV2_5;
+            Model = model ?? Models.Model.FlashV2;
             Voice = voice;
             VoiceSettings = voiceSettings ?? voice.Settings;
             OutputFormat = outputFormat;

diff --git a/README.md b/README.md
@@ -38,7 +38,11 @@ dotnet add package ElevenLabs-DotNet
 
 ---
 
-## Documentation
+## [Documentation](https://rageagainstthepixel.github.io/ElevenLabs-DotNet)
+
+> Check out our new api docs!
+
+<https://rageagainstthepixel.github.io/ElevenLabs-DotNet>
 
 ### Table of Contents
 
@@ -239,7 +243,7 @@ Gets a list of shared voices in the public voice library.
 
 ```csharp
 var api = new ElevenLabsClient();
-var results = await ElevenLabsClient.SharedVoicesEndpoint.GetSharedVoicesAsync();
+var results = await api.SharedVoicesEndpoint.GetSharedVoicesAsync();
 foreach (var voice in results.Voices)
 {
     Console.WriteLine($"{voice.OwnerId} | {voice.VoiceId} | {voice.Date} | {voice.Name}");
@@ -391,7 +395,7 @@ var assetsDir = Path.GetFullPath("../../../Assets");
 var dubbedPath = new FileInfo(Path.Combine(assetsDir, $"online.dubbed.{request.TargetLanguage}.mp4"));
 {
     await using var fs = File.Open(dubbedPath.FullName, FileMode.Create);
-    await foreach (var chunk in ElevenLabsClient.DubbingEndpoint.GetDubbedFileAsync(metadata.DubbingId, request.TargetLanguage))
+    await foreach (var chunk in api.DubbingEndpoint.GetDubbedFileAsync(metadata.DubbingId, request.TargetLanguage))
     {
         await fs.WriteAsync(chunk);
     }