Struct google_api_proto::google::assistant::embedded::v1alpha2::DialogStateOut

pub struct DialogStateOut {
    pub supplemental_display_text: String,
    pub conversation_state: Bytes,
    pub microphone_mode: i32,
    pub volume_percentage: i32,
}

The dialog state resulting from the user’s query. Multiple of these messages may be received.

Fields

supplemental_display_text: String

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.

conversation_state: Bytes

Output-only State information for the subsequent Assist RPC. This value should be saved in the client and returned in the DialogStateIn.conversation_state 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.

microphone_mode: i32

Output-only Specifies the mode of the microphone after this Assist RPC is processed.

volume_percentage: i32

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.)

Implementations

impl DialogStateOut

pub fn microphone_mode(&self) -> MicrophoneMode

Returns the enum value of microphone_mode, or the default if the field is set to an invalid enum value.

pub fn set_microphone_mode(&mut self, value: MicrophoneMode)

Sets microphone_mode to the provided enum value.

Trait Implementations

impl Clone for DialogStateOut

fn clone(&self) -> DialogStateOut

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DialogStateOut

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DialogStateOut

fn default() -> Self

Returns the “default value” for a type.

impl Message for DialogStateOut

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DialogStateOut

fn eq(&self, other: &DialogStateOut) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DialogStateOut