Console
    Start free

    Google Cloud Ces V1 Client - Class AmbientSoundConfig (0.2.0)

    Reference documentation and code samples for the Google Cloud Ces V1 Client class AmbientSoundConfig.

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

    Generated from protobuf message google.cloud.ces.v1.AmbientSoundConfig

    Namespace

    Google \ Cloud \ Ces \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ prebuilt_ambient_noise
    int

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

    ↳ gcs_uri
    string

    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.

    ↳ prebuilt_ambient_sound
    string

    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"

    ↳ volume_gain_db
    float

    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.

    getPrebuiltAmbientNoise

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

    Returns
    Type
    Description
    int
    Enum of type PrebuiltAmbientNoise .

    hasPrebuiltAmbientNoise

    setPrebuiltAmbientNoise

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

    Parameter
    Name
    Description
    var
    int

    Enum of type PrebuiltAmbientNoise .

    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    hasGcsUri

    setGcsUri

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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"
    Returns
    Type
    Description
    string

    hasPrebuiltAmbientSound

    setPrebuiltAmbientSound

    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"
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    float

    setVolumeGainDb

    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.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getSource

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: