Class AmbientSoundConfig (0.1.0)

public final class AmbientSoundConfig extends GeneratedMessage implements AmbientSoundConfigOrBuilder

Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.

Protobuf type google.cloud.ces.v1.AmbientSoundConfig

Static Fields

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
Type Description
int

PREBUILT_AMBIENT_NOISE_FIELD_NUMBER

public static final int PREBUILT_AMBIENT_NOISE_FIELD_NUMBER
Field Value
Type Description
int

PREBUILT_AMBIENT_SOUND_FIELD_NUMBER

public static final int PREBUILT_AMBIENT_SOUND_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_GAIN_DB_FIELD_NUMBER

public static final int VOLUME_GAIN_DB_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AmbientSoundConfig getDefaultInstance()
Returns
Type Description
AmbientSoundConfig

getDescriptor()

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

newBuilder()

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

newBuilder(AmbientSoundConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AmbientSoundConfig getDefaultInstanceForType()
Returns
Type Description
AmbientSoundConfig

getGcsUri()

public String getGcsUri()

Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

string gcs_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

string gcs_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gcsUri.

getParserForType()

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

getPrebuiltAmbientNoise() (deprecated)

public AmbientSoundConfig.PrebuiltAmbientNoise getPrebuiltAmbientNoise()

Deprecated. google.cloud.ces.v1.AmbientSoundConfig.prebuilt_ambient_noise is deprecated. See google/cloud/ces/v1/app.proto;l=285

Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

.google.cloud.ces.v1.AmbientSoundConfig.PrebuiltAmbientNoise prebuilt_ambient_noise = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AmbientSoundConfig.PrebuiltAmbientNoise

The prebuiltAmbientNoise.

getPrebuiltAmbientNoiseValue() (deprecated)

public int getPrebuiltAmbientNoiseValue()

Deprecated. google.cloud.ces.v1.AmbientSoundConfig.prebuilt_ambient_noise is deprecated. See google/cloud/ces/v1/app.proto;l=285

Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

.google.cloud.ces.v1.AmbientSoundConfig.PrebuiltAmbientNoise prebuilt_ambient_noise = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for prebuiltAmbientNoise.

getPrebuiltAmbientSound()

public String getPrebuiltAmbientSound()

Optional. Name of the prebuilt ambient sound. Valid values are:

  • "coffee_shop"
  • "keyboard"
  • "keypad"
  • "hum"
  • "office_1"
  • "office_2"
  • "office_3"
  • "room_1"
  • "room_2"
  • "room_3"
  • "room_4"
  • "room_5"
  • "air_conditioner"

string prebuilt_ambient_sound = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The prebuiltAmbientSound.

getPrebuiltAmbientSoundBytes()

public ByteString getPrebuiltAmbientSoundBytes()

Optional. Name of the prebuilt ambient sound. Valid values are:

  • "coffee_shop"
  • "keyboard"
  • "keypad"
  • "hum"
  • "office_1"
  • "office_2"
  • "office_3"
  • "room_1"
  • "room_2"
  • "room_3"
  • "room_4"
  • "room_5"
  • "air_conditioner"

string prebuilt_ambient_sound = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for prebuiltAmbientSound.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public AmbientSoundConfig.SourceCase getSourceCase()
Returns
Type Description
AmbientSoundConfig.SourceCase

getVolumeGainDb()

public double getVolumeGainDb()

Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.

double volume_gain_db = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The volumeGainDb.

hasGcsUri()

public boolean hasGcsUri()

Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud Storage.

Note: Please make sure the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has storage.objects.get permission to the Cloud Storage object.

string gcs_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gcsUri field is set.

hasPrebuiltAmbientNoise() (deprecated)

public boolean hasPrebuiltAmbientNoise()

Deprecated. google.cloud.ces.v1.AmbientSoundConfig.prebuilt_ambient_noise is deprecated. See google/cloud/ces/v1/app.proto;l=285

Optional. Deprecated: prebuilt_ambient_noise is deprecated in favor of prebuilt_ambient_sound.

.google.cloud.ces.v1.AmbientSoundConfig.PrebuiltAmbientNoise prebuilt_ambient_noise = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the prebuiltAmbientNoise field is set.

hasPrebuiltAmbientSound()

public boolean hasPrebuiltAmbientSound()

Optional. Name of the prebuilt ambient sound. Valid values are:

  • "coffee_shop"
  • "keyboard"
  • "keypad"
  • "hum"
  • "office_1"
  • "office_2"
  • "office_3"
  • "room_1"
  • "room_2"
  • "room_3"
  • "room_4"
  • "room_5"
  • "air_conditioner"

string prebuilt_ambient_sound = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the prebuiltAmbientSound field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AmbientSoundConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AmbientSoundConfig.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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