Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

SrgsItem.Weight Property

Gets or sets a multiplying factor that adjusts the likelihood that an SrgsItem in an SrgsOneOf object will be spoken.

Namespace:  Microsoft.Speech.Recognition.SrgsGrammar
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

'Declaration
Public Property Weight As Single
    Get
    Set
'Usage
Dim instance As SrgsItem
Dim value As Single

value = instance.Weight

instance.Weight = value
public float Weight { get; set; }

Property Value

Type: System.Single
A floating point value that adjusts the likelihood of this item being spoken.

Exceptions

Exception Condition
ArgumentOutOfRangeException

An attempt is made to set Weight to a negative value.

Remarks

The default value of this property is 1.0, which is equivalent to no weighting of the item. A weight greater than 1.0 positively biases the likelihood that the item will be spoken, and a weight less than 1.0 negatively biases the likelihood that the item will be spoken.

This property is relevant only to SrgsItem objects within an SrgsOneOf instance; it is ignored in all other cases.

See Also

Reference

SrgsItem Class

SrgsItem Members

Microsoft.Speech.Recognition.SrgsGrammar Namespace

Other Resources

Create Grammars Using SrgsGrammar (Microsoft.Speech)