Skip to content
Tracon

VoiceDescriptor

Namespace Tracon · Assembly Tracon.Abstractions.dll

The definition of an available voice.

public sealed record VoiceDescriptor : IEquatable<VoiceDescriptor>

objectVoiceDescriptor

IEquatable<VoiceDescriptor>

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

The provider’s preview_url field is deliberately not carried: playing it in the UI would connect the browser to the provider’s address. Adding it later is not a breaking change; removing it would be.

public VoiceDescriptor()

Provider-reported, bounded, safe scalar attributes (for example, gender or language — see VoiceAttributeNames).

public IReadOnlyDictionary<string, string> Attributes { get; init; }

IReadOnlyDictionary<string, string>

Empty, never null, when the provider reports nothing. The set is provider-defined and not limited to VoiceAttributeNames’s constants: any safe scalar label the provider sends survives under its own key.

The category given by the provider (for example, premade).

public string? Category { get; init; }

string?

The human-readable name.

public required string Name { get; init; }

string

The voice identifier. Used in agent definitions and requests.

public required string VoiceId { get; init; }

string

public override bool Equals(object? obj)

obj object?

bool

public bool Equals(VoiceDescriptor? other)

other VoiceDescriptor?

bool

public override int GetHashCode()

int

public override string ToString()

string

operator ==(VoiceDescriptor?, VoiceDescriptor?)

Section titled “ operator ==(VoiceDescriptor?, VoiceDescriptor?)”
public static bool operator ==(VoiceDescriptor? left, VoiceDescriptor? right)

left VoiceDescriptor?

right VoiceDescriptor?

bool

operator !=(VoiceDescriptor?, VoiceDescriptor?)

Section titled “ operator !=(VoiceDescriptor?, VoiceDescriptor?)”
public static bool operator !=(VoiceDescriptor? left, VoiceDescriptor? right)

left VoiceDescriptor?

right VoiceDescriptor?

bool