mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class SpeechEventData

    Describes an input event that involves keyword recognition.

    Inheritance
    Object
    BaseInputEventData
    SpeechEventData
    Implements
    BaseEventData
    Inherited Members
    BaseInputEventData.EventTime
    BaseInputEventData.InputSource
    BaseInputEventData.SourceId
    BaseInputEventData.MixedRealityInputAction
    BaseInputEventData.BaseInitialize(IMixedRealityInputSource, MixedRealityInputAction)
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class SpeechEventData : BaseInputEventData, BaseEventData

    Constructors

    SpeechEventData(EventSystem)

    Declaration
    public SpeechEventData(EventSystem eventSystem)
    Parameters
    Type Name Description
    EventSystem eventSystem

    SpeechEventData(EventSystem)

    Declaration
    public SpeechEventData(EventSystem eventSystem)
    Parameters
    Type Name Description
    EventSystem eventSystem

    Properties

    Command

    The text that was recognized.

    Declaration
    public SpeechCommands Command { get; }
    Property Value
    Type Description
    SpeechCommands

    Command

    The text that was recognized.

    Declaration
    public SpeechCommands Command { get; }
    Property Value
    Type Description
    SpeechCommands

    Confidence

    A measure of correct recognition certainty.

    Declaration
    public RecognitionConfidenceLevel Confidence { get; }
    Property Value
    Type Description
    RecognitionConfidenceLevel

    Confidence

    A measure of correct recognition certainty.

    Declaration
    public RecognitionConfidenceLevel Confidence { get; }
    Property Value
    Type Description
    RecognitionConfidenceLevel

    PhraseDuration

    The time it took for the phrase to be uttered.

    Declaration
    public TimeSpan PhraseDuration { get; }
    Property Value
    Type Description
    TimeSpan

    PhraseDuration

    The time it took for the phrase to be uttered.

    Declaration
    public TimeSpan PhraseDuration { get; }
    Property Value
    Type Description
    TimeSpan

    PhraseStartTime

    The moment in UTC time when uttering of the phrase began.

    Declaration
    public DateTime PhraseStartTime { get; }
    Property Value
    Type Description
    DateTime

    PhraseStartTime

    The moment in UTC time when uttering of the phrase began.

    Declaration
    public DateTime PhraseStartTime { get; }
    Property Value
    Type Description
    DateTime

    Methods

    Initialize(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)

    Populates the event with data.

    Declaration
    public void Initialize(IMixedRealityInputSource inputSource, RecognitionConfidenceLevel confidence, TimeSpan phraseDuration, DateTime phraseStartTime, SpeechCommands command)
    Parameters
    Type Name Description
    IMixedRealityInputSource inputSource
    RecognitionConfidenceLevel confidence
    TimeSpan phraseDuration
    DateTime phraseStartTime
    SpeechCommands command

    Initialize(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)

    Populates the event with data.

    Declaration
    public void Initialize(IMixedRealityInputSource inputSource, RecognitionConfidenceLevel confidence, TimeSpan phraseDuration, DateTime phraseStartTime, SpeechCommands command)
    Parameters
    Type Name Description
    IMixedRealityInputSource inputSource
    RecognitionConfidenceLevel confidence
    TimeSpan phraseDuration
    DateTime phraseStartTime
    SpeechCommands command

    Implements

    BaseEventData
    In This Article
    • Constructors
      • SpeechEventData(EventSystem)
      • SpeechEventData(EventSystem)
    • Properties
      • Command
      • Command
      • Confidence
      • Confidence
      • PhraseDuration
      • PhraseDuration
      • PhraseStartTime
      • PhraseStartTime
    • Methods
      • Initialize(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)
      • Initialize(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)
    • Implements
    Back to top Generated by DocFX