Package software.amazon.awssdk.services.transcribestreaming.model

Class Result

    • Method Detail

      • resultId

        public final String resultId()

        Provides a unique identifier for the Result.

        Returns:
        Provides a unique identifier for the Result.

      • startTime

        public final Double startTime()

        The start time of the Result in seconds, with millisecond precision (e.g., 1.056).

        Returns:
        The start time of the Result in seconds, with millisecond precision (e.g., 1.056).

      • endTime

        public final Double endTime()

        The end time of the Result in seconds, with millisecond precision (e.g., 1.056).

        Returns:
        The end time of the Result in seconds, with millisecond precision (e.g., 1.056).

      • isPartial

        public final Boolean isPartial()

        Indicates if the segment is complete.

        If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

        Returns:
        Indicates if the segment is complete.

        If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

      • hasAlternatives

        public final boolean hasAlternatives()
        For responses, this returns true if the service returned a value for the Alternatives property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • alternatives

        public final List<Alternative> alternatives()

        A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlternatives() method.

        Returns:
        A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

      • channelId

        public final String channelId()

        Indicates which audio channel is associated with the Result.

        Returns:
        Indicates which audio channel is associated with the Result.

      • languageCode

        public final LanguageCode languageCode()

        The language code that represents the language spoken in your audio stream.

        If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

        Returns:
        The language code that represents the language spoken in your audio stream.
        See Also:
        LanguageCode

      • languageCodeAsString

        public final String languageCodeAsString()

        The language code that represents the language spoken in your audio stream.

        If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

        Returns:
        The language code that represents the language spoken in your audio stream.
        See Also:
        LanguageCode

      • hasLanguageIdentification

        public final boolean hasLanguageIdentification()
        For responses, this returns true if the service returned a value for the LanguageIdentification property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • languageIdentification

        public final List<LanguageWithScore> languageIdentification()

        The language code of the dominant language identified in your stream.

        If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageIdentification() method.

        Returns:
        The language code of the dominant language identified in your stream.

        If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.

      • serializableBuilderClass

        public static Class<? extends Result.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)