Class BargeInConfig (0.64.0) 

public final class BargeInConfig extends 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 from the the start of the input audio.

    No-speech event is a response with END_OF_UTTERANCE without any transcript following up.

Protobuf type google.cloud.dialogflow.cx.v3.BargeInConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BargeInConfig

Static Fields

NO_BARGE_IN_DURATION_FIELD_NUMBER

public static final int NO_BARGE_IN_DURATION_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_DURATION_FIELD_NUMBER

public static final int TOTAL_DURATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BargeInConfig getDefaultInstance()
Returns
Type Description
BargeInConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BargeInConfig.Builder newBuilder()
Returns
Type Description
BargeInConfig.Builder

newBuilder(BargeInConfig prototype)

public static BargeInConfig.Builder newBuilder(BargeInConfig prototype)
Parameter
Name Description
prototype BargeInConfig
Returns
Type Description
BargeInConfig.Builder

parseDelimitedFrom(InputStream input)

public static BargeInConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BargeInConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BargeInConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BargeInConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BargeInConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BargeInConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BargeInConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BargeInConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BargeInConfig> parser()
Returns
Type Description
Parser<BargeInConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BargeInConfig getDefaultInstanceForType()
Returns
Type Description
BargeInConfig

getNoBargeInDuration()

public 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;

Returns
Type Description
Duration

The noBargeInDuration.

getNoBargeInDurationOrBuilder()

public 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;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<BargeInConfig> getParserForType()
Returns
Type Description
Parser<BargeInConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalDuration()

public Duration getTotalDuration()

Total duration for the playback at the beginning of the input audio.

.google.protobuf.Duration total_duration = 2;

Returns
Type Description
Duration

The totalDuration.

getTotalDurationOrBuilder()

public DurationOrBuilder getTotalDurationOrBuilder()

Total duration for the playback at the beginning of the input audio.

.google.protobuf.Duration total_duration = 2;

Returns
Type Description
DurationOrBuilder

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;

Returns
Type Description
boolean

Whether the noBargeInDuration field is set.

hasTotalDuration()

public boolean hasTotalDuration()

Total duration for the playback at the beginning of the input audio.

.google.protobuf.Duration total_duration = 2;

Returns
Type Description
boolean

Whether the totalDuration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BargeInConfig.Builder newBuilderForType()
Returns
Type Description
BargeInConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BargeInConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BargeInConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BargeInConfig.Builder toBuilder()
Returns
Type Description
BargeInConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException