Package com.google.cloud.dialogflow.v2beta1

Class BargeInConfig

  • All Implemented Interfaces:
    BargeInConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BargeInConfig
extends com.google.protobuf.GeneratedMessageV3
implements BargeInConfigOrBuilder
     Configuration of the barge-in behavior. Barge-in instructs the API to return
 a detected utterance at a proper time while the client is playing back the
 response audio from a previous request. When the client sees the
 utterance, it should stop the playback and immediately get ready for
 receiving the responses for the current request.

 The barge-in handling requires the client to start streaming audio input
 as soon as it starts playing back the audio from the previous response. The
 playback is modeled into two phases:

 * No barge-in phase: which goes first and during which speech detection
   should not be carried out.

 * Barge-in phase: which follows the no barge-in phase and during which
   the API starts speech detection and may inform the client that an utterance
   has been detected. Note that no-speech event is not expected in this
   phase.

 The client provides this configuration in terms of the durations of those
 two phases. The durations are measured in terms of the audio length fromt the
 the start of the input audio.

 The flow goes like below:

 ```
 --> Time

 without speech detection  | utterance only | utterance or no-speech event
                           |                |
           +-------------+ | +------------+ | +---------------+
 ----------+ no barge-in +-|-+  barge-in  +-|-+ normal period +-----------
           +-------------+ | +------------+ | +---------------+
 ```

 No-speech event is a response with END_OF_UTTERANCE without any transcript
 following up.
    Protobuf type google.cloud.dialogflow.v2beta1.BargeInConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BargeInConfig.Builder
      Configuration of the barge-in behavior.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int NO_BARGE_IN_DURATION_FIELD_NUMBER  
      static int TOTAL_DURATION_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • NO_BARGE_IN_DURATION_FIELD_NUMBER

        public static final int NO_BARGE_IN_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_DURATION_FIELD_NUMBER

        public static final int TOTAL_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasNoBargeInDuration

        public boolean hasNoBargeInDuration()
         Duration that is not eligible for barge-in at the beginning of the input
 audio.
        .google.protobuf.Duration no_barge_in_duration = 1;
        Specified by:
        hasNoBargeInDuration in interface BargeInConfigOrBuilder
        Returns:
        Whether the noBargeInDuration field is set.

      • getNoBargeInDuration

        public com.google.protobuf.Duration getNoBargeInDuration()
         Duration that is not eligible for barge-in at the beginning of the input
 audio.
        .google.protobuf.Duration no_barge_in_duration = 1;
        Specified by:
        getNoBargeInDuration in interface BargeInConfigOrBuilder
        Returns:
        The noBargeInDuration.

      • getNoBargeInDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getNoBargeInDurationOrBuilder()
         Duration that is not eligible for barge-in at the beginning of the input
 audio.
        .google.protobuf.Duration no_barge_in_duration = 1;
        Specified by:
        getNoBargeInDurationOrBuilder in interface BargeInConfigOrBuilder

      • hasTotalDuration

        public boolean hasTotalDuration()
         Total duration for the playback at the beginning of the input audio.
        .google.protobuf.Duration total_duration = 2;
        Specified by:
        hasTotalDuration in interface BargeInConfigOrBuilder
        Returns:
        Whether the totalDuration field is set.

      • getTotalDuration

        public com.google.protobuf.Duration getTotalDuration()
         Total duration for the playback at the beginning of the input audio.
        .google.protobuf.Duration total_duration = 2;
        Specified by:
        getTotalDuration in interface BargeInConfigOrBuilder
        Returns:
        The totalDuration.

      • getTotalDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getTotalDurationOrBuilder()
         Total duration for the playback at the beginning of the input audio.
        .google.protobuf.Duration total_duration = 2;
        Specified by:
        getTotalDurationOrBuilder in interface BargeInConfigOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BargeInConfig parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BargeInConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public BargeInConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public BargeInConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected BargeInConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static BargeInConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<BargeInConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<BargeInConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public BargeInConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder