Lyo.Typecast.Client 1.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package Lyo.Typecast.Client --version 1.0.3
                    
NuGet\Install-Package Lyo.Typecast.Client -Version 1.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Lyo.Typecast.Client" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Lyo.Typecast.Client" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="Lyo.Typecast.Client" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Lyo.Typecast.Client --version 1.0.3
                    
#r "nuget: Lyo.Typecast.Client, 1.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Lyo.Typecast.Client@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Lyo.Typecast.Client&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=Lyo.Typecast.Client&version=1.0.3
                    
Install as a Cake Tool

Lyo.Typecast.Client

Typecast API client for text-to-speech and voice management. TypecastClient extends Lyo.Api.Client.ApiClient, configures the X-API-KEY header from TypecastClientOptions, and exposes two managers (TextToSpeech, Voices) for the underlying REST endpoints.

Multi-targets netstandard2.0 and net10.0.

Examples

Register services

// 1. Configuration-bound (defaults to the "TypecastClient" section)
services.AddTypecastClientFromConfiguration(builder.Configuration);

// 2. Inline configuration
services.AddTypecastClient(o => {
    o.ApiKey = "your-api-key";
    o.BaseUrl = "https://api.typecast.ai";
});

// 3. Pre-built options object
services.AddTypecastClient(new TypecastClientOptions { ApiKey = "your-api-key" });

Register services (2)

{
  "TypecastClient": {
    "ApiKey": "your-api-key",
    "BaseUrl": "https://api.typecast.ai"
  }
}

TypecastClient

public readonly TextToSpeechManager TextToSpeech;
public readonly VoiceManager Voices;

Registration

Three DI extensions are available on IServiceCollection: All variants register TypecastClient as a singleton. ILoggerFactory and HttpClient are pulled from the container if available; otherwise sensible defaults are used. Example appsettings.json:

TypecastClientOptions

Extends ApiClientOptions, so it inherits the standard HTTP transport knobs (BaseUrl, timeouts, retry, etc.).

Property Notes
ApiKey Required. Sent as X-API-KEY.
BaseUrl Defaults to https://api.typecast.ai.
SectionName "TypecastClient". Used by AddTypecastClientFromConfiguration as the default section.

JSON is serialized with snake_case naming, case-insensitive read, and WhenWritingNull ignore — matching Typecast's API.

TypecastClientTextToSpeechManager

Method Endpoint Returns
SynthesizeAsync(TypecastTtsRequest request, ct = default) POST /v1/text-to-speech byte[] (WAV or MP3 audio).

TypecastClientVoiceManager

Method Endpoint Returns
ListVoicesAsync(VoiceListReq? request = null, ct = default) GET /v2/voices List<Voice> (empty when absent).
GetVoiceAsync(string voiceId, ct = default) GET /v2/voices/{voiceId} Voice?

Request models

  • TypecastTtsRequest (extends Lyo.Tts.Models.TtsRequest) — VoiceId, Text, Model (defaults to TypecastModel.SsfmV30), Language (LanguageCodeInfo, serialised as ISO 639-3), Prompt, Output, Seed, computed AudioFormat.
  • Prompt — emotion / style settings (including the "smart" mode with optional previous_text / next_text context).
  • OutputSettings — volume / pitch / tempo / audio format.
  • VoiceListReq — optional Model, Gender, Age, UseCases filters.
  • Enums under Enums/Gender, AgeGroup, TypecastModel.
  • Response models under Models/Voices/Response/Voice, VoiceModel.

TypecastTtsRequestBuilder

Fluent builder for assembling a valid TTS request. Validates VoiceId and Text on Build().

var request = TypecastTtsRequestBuilder
    .Create("tc_60e5426de8b95f1d3000d7b5", "Hello, world!")
    .WithModel("ssfm-v30")
    .WithLanguage("eng") // accepts ISO 639-3 or ISO 639-1
    .WithSmartPrompt(previousText: "Welcome.", nextText: "How are you?")
    .WithOutput(o => {
        o.AudioFormat = "mp3";
    })
    .WithSeed(42)
    .Build();

var audio = await client.TextToSpeech.SynthesizeAsync(request, ct);
Method Sets
New() / Create(voiceId, text) Static factory methods.
WithVoiceId(string) / WithText(string) Required fields.
WithModel(string) e.g. "ssfm-v30", "ssfm-v21".
WithLanguage(string) Parses ISO 639-3 first then ISO 639-1; falls back to no language when unknown.
WithPrompt(Prompt) / WithPrompt(Action<Prompt>) Set or configure inline.
WithSmartPrompt(previousText?, nextText?) Convenience for "smart" emotion mode.
WithOutput(OutputSettings) / WithOutput(Action<OutputSettings>) Set or configure inline.
WithSeed(int) Deterministic generation.
Build() Validates required fields and returns the TypecastTtsRequest.

Dependencies

Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).

  • Lyo.Api.Client — (direct, lyo)
  • Lyo.Tts.Models — (direct, lyo)
  • Microsoft.Extensions.Configuration.Binder 10.0.5 — (direct, microsoft)
  • Microsoft.Extensions.DependencyInjection.Abstractions 10.0.5 — (direct, microsoft)
  • Microsoft.Extensions.Logging.Abstractions 10.0.5 — (direct, microsoft)
  • Lyo.Api.Models — (transitive, lyo)
  • Lyo.Common — (transitive, lyo)
  • Lyo.DateAndTime — (transitive, lyo)
  • Lyo.Diagnostic — (transitive, lyo)
  • Lyo.Exceptions — (transitive, lyo)
  • Lyo.Hashing — (transitive, lyo)
  • Lyo.PackageMetadata — (transitive, lyo)
  • Lyo.Query.Models — (transitive, lyo)
  • Lyo.Result — (transitive, lyo)
  • Microsoft.Extensions.Http 10.0.5 — (transitive, microsoft)
  • System.IO.Hashing 10.0.5 — (transitive, microsoft, net10.0)
  • System.Memory 4.6.3 — (transitive, microsoft, netstandard2.0)
  • System.Text.Json 10.0.5 — (transitive, microsoft, netstandard2.0)
  • System.Threading.Tasks.Extensions 4.6.3 — (transitive, microsoft)
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Lyo.Typecast.Client:

Package Downloads
Lyo.Tts.Typecast

Typecast Text-to-Speech service implementation for converting text to speech using Typecast API.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.9 34 8/22/2026
1.0.6 51 8/20/2026
1.0.4 87 8/20/2026
1.0.3 77 8/19/2026
1.0.2 89 8/19/2026
1.0.1 92 8/18/2026
1.0.0 112 8/16/2026