com.google.assistant.embedded.v1alpha2.DialogStateOutOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: embedded_assistant.proto

package com.google.assistant.embedded.v1alpha2;

public interface DialogStateOutOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.assistant.embedded.v1alpha2.DialogStateOut)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * *Output-only* Supplemental display text from the Assistant. This could be
   * the same as the speech spoken in `AssistResponse.audio_out` or it could
   * be some additional information which aids the user's understanding.
   * 
   *
   * string supplemental_display_text = 1;
   * @return The supplementalDisplayText.
   */
  java.lang.String getSupplementalDisplayText();
  /**
   *    * *Output-only* Supplemental display text from the Assistant. This could be
   * the same as the speech spoken in `AssistResponse.audio_out` or it could
   * be some additional information which aids the user's understanding.
   * 
   *
   * string supplemental_display_text = 1;
   * @return The bytes for supplementalDisplayText.
   */
  com.google.protobuf.ByteString
      getSupplementalDisplayTextBytes();

  /**
   *    * *Output-only* State information for the subsequent `Assist` RPC. This
   * value should be saved in the client and returned in the
   * [`DialogStateIn.conversation_state`](#dialogstatein) field with the next
   * `Assist` RPC. (The client does not need to interpret or otherwise use this
   * value.) This information should be saved across device reboots. However,
   * this value should be cleared (not saved in the client) during a
   * factory-default reset.
   * 
   *
   * bytes conversation_state = 2;
   * @return The conversationState.
   */
  com.google.protobuf.ByteString getConversationState();

  /**
   *    * *Output-only* Specifies the mode of the microphone after this `Assist`
   * RPC is processed.
   * 
   *
   * .google.assistant.embedded.v1alpha2.DialogStateOut.MicrophoneMode microphone_mode = 3;
   * @return The enum numeric value on the wire for microphoneMode.
   */
  int getMicrophoneModeValue();
  /**
   *    * *Output-only* Specifies the mode of the microphone after this `Assist`
   * RPC is processed.
   * 
   *
   * .google.assistant.embedded.v1alpha2.DialogStateOut.MicrophoneMode microphone_mode = 3;
   * @return The microphoneMode.
   */
  com.google.assistant.embedded.v1alpha2.DialogStateOut.MicrophoneMode getMicrophoneMode();

  /**
   *    * *Output-only* Updated volume level. The value will be 0 or omitted
   * (indicating no change) unless a voice command such as *Increase the volume*
   * or *Set volume level 4* was recognized, in which case the value will be
   * between 1 and 100 (corresponding to the new volume level of 1% to 100%).
   * Typically, a client should use this volume level when playing the
   * `audio_out` data, and retain this value as the current volume level and
   * supply it in the `AudioOutConfig` of the next `AssistRequest`. (Some
   * clients may also implement other ways to allow the current volume level to
   * be changed, for example, by providing a knob that the user can turn.)
   * 
   *
   * int32 volume_percentage = 4;
   * @return The volumePercentage.
   */
  int getVolumePercentage();
}