# VoiceDescriptor

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.voicedescriptor/
> Summary: VoiceDescriptor: The definition of an available voice.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

The definition of an available voice.

```csharp
public sealed record VoiceDescriptor : IEquatable<VoiceDescriptor>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.voicedescriptor/">VoiceDescriptor</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;VoiceDescriptor&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

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.

## Constructors

### <a id="Tracon_VoiceDescriptor__ctor"></a> VoiceDescriptor\(\)

```csharp
public VoiceDescriptor()
```

## Properties

### <a id="Tracon_VoiceDescriptor_Attributes"></a> Attributes

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

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

#### Property Value

 [IReadOnlyDictionary](https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [string](https://learn.microsoft.com/dotnet/api/system.string)\>

#### Remarks

Empty, never [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/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.

### <a id="Tracon_VoiceDescriptor_Category"></a> Category

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

```csharp
public string? Category { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)?

### <a id="Tracon_VoiceDescriptor_Name"></a> Name

The human-readable name.

```csharp
public required string Name { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_VoiceDescriptor_VoiceId"></a> VoiceId

The voice identifier. Used in agent definitions and requests.

```csharp
public required string VoiceId { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Methods

### <a id="Tracon_VoiceDescriptor_Equals_System_Object_"></a> Equals\(object?\)

```csharp
public override bool Equals(object? obj)
```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_VoiceDescriptor_Equals_Tracon_VoiceDescriptor_"></a> Equals\(VoiceDescriptor?\)

```csharp
public bool Equals(VoiceDescriptor? other)
```

#### Parameters

`other` [VoiceDescriptor](/api/tracon.voicedescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_VoiceDescriptor_GetHashCode"></a> GetHashCode\(\)

```csharp
public override int GetHashCode()
```

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_VoiceDescriptor_ToString"></a> ToString\(\)

```csharp
public override string ToString()
```

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_VoiceDescriptor_op_Equality_Tracon_VoiceDescriptor_Tracon_VoiceDescriptor_"></a> operator ==\(VoiceDescriptor?, VoiceDescriptor?\)

```csharp
public static bool operator ==(VoiceDescriptor? left, VoiceDescriptor? right)
```

#### Parameters

`left` [VoiceDescriptor](/api/tracon.voicedescriptor/)?

`right` [VoiceDescriptor](/api/tracon.voicedescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_VoiceDescriptor_op_Inequality_Tracon_VoiceDescriptor_Tracon_VoiceDescriptor_"></a> operator \!=\(VoiceDescriptor?, VoiceDescriptor?\)

```csharp
public static bool operator !=(VoiceDescriptor? left, VoiceDescriptor? right)
```

#### Parameters

`left` [VoiceDescriptor](/api/tracon.voicedescriptor/)?

`right` [VoiceDescriptor](/api/tracon.voicedescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)