Interface TextEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TextEvent.Builder,TextEvent>, SdkBuilder<TextEvent.Builder,TextEvent>, SdkPojo
All Known Subinterfaces:
DefaultTextEvent.Builder
Enclosing class:
TextEvent
@Mutable @NotThreadSafe public static interface TextEvent.Builder extends SdkPojo, CopyableBuilder<TextEvent.Builder,TextEvent>

  • Method Details

    • text

      TextEvent.Builder text(String text)

      The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

      Parameters:
      text - The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • textType

      TextEvent.Builder textType(String textType)

      Specifies whether the input text is plain text or SSML. Default: plain text.

      Parameters:
      textType - Specifies whether the input text is plain text or SSML. Default: plain text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • textType

      TextEvent.Builder textType(TextType textType)

      Specifies whether the input text is plain text or SSML. Default: plain text.

      Parameters:
      textType - Specifies whether the input text is plain text or SSML. Default: plain text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • flushStreamConfiguration

      TextEvent.Builder flushStreamConfiguration(FlushStreamConfiguration flushStreamConfiguration)

      Configuration for controlling when synthesized audio flushes to the output stream.

      Parameters:
      flushStreamConfiguration - Configuration for controlling when synthesized audio flushes to the output stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flushStreamConfiguration

      default TextEvent.Builder flushStreamConfiguration(Consumer<FlushStreamConfiguration.Builder> flushStreamConfiguration)

      Configuration for controlling when synthesized audio flushes to the output stream.

      This is a convenience method that creates an instance of the FlushStreamConfiguration.Builder avoiding the need to create one manually via FlushStreamConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to flushStreamConfiguration(FlushStreamConfiguration).

      Parameters:
      flushStreamConfiguration - a consumer that will call methods on FlushStreamConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: