Skip to content

VoiceDescriptor

Namespace AgentPrism · Assembly AgentPrism.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()

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