KeyDetectionResult<T>

Models & Types · AiDotNet.Audio.MusicAnalysis

Result of key detection.

For Beginners

KeyDetectionResult provides AI safety functionality. Default values follow the original paper settings.

Constructors

Constructor Summary
KeyDetectionResult()

Properties

Property Summary
KeyMode Mode { get; set; } Gets or sets the key mode (major or minor).
T Confidence { get; set; } Gets or sets the confidence score (0-1).
T Correlation { get; set; } Gets or sets the Pearson correlation with the key profile (-1 to 1).
int KeyIndex { get; set; } Gets or sets the key index (0 = C, 1 = C#, etc.).
string Name { get; set; } Gets or sets the full key name (e.g., “C major”, “A minor”).
string RelativeKey { get; set; } Gets or sets the relative major/minor key.
string RootNote { get; set; } Gets or sets the root note name (e.g., “C”, “A”).