Package apple.avfaudio

Class AVSpeechUtterance

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class AVSpeechUtterance
extends NSObject
implements NSCopying, NSSecureCoding
    AVSpeechUtterance AVSpeechUtterance is the atom of speaking a string or pausing the synthesizer. To start speaking, specify the AVSpeechSynthesisVoice and the string to be spoken, then optionally change the rate, pitch or volume if desired.

    • Constructor Detail

      • AVSpeechUtterance

        protected AVSpeechUtterance​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static AVSpeechUtterance allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • attributedSpeechString

        @NotNull
public @NotNull NSAttributedString attributedSpeechString()
        API-Since: 10.0

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithString

        public AVSpeechUtterance initWithString​(@NotNull
                                        @NotNull java.lang.String string)

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • pitchMultiplier

        public float pitchMultiplier()
        [0.5 - 2] Default = 1

      • postUtteranceDelay

        public double postUtteranceDelay()
        Default is 0.0

      • preUtteranceDelay

        public double preUtteranceDelay()
        Default is 0.0

      • prefersAssistiveTechnologySettings

        public boolean prefersAssistiveTechnologySettings()
        If an assistive technology is on, like VoiceOver, the user's selected voice, rate and other settings will be used for this speech utterance instead of the default values. If no assistive technologies are on, then the values of the properties on AVSpeechUtterance will be used. Note that querying the properties will not refect the user's settings. API-Since: 14.0

      • rate

        public float rate()
        Values are pinned between AVSpeechUtteranceMinimumSpeechRate and AVSpeechUtteranceMaximumSpeechRate.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setPitchMultiplier

        public void setPitchMultiplier​(float value)
        [0.5 - 2] Default = 1

      • setPostUtteranceDelay

        public void setPostUtteranceDelay​(double value)
        Default is 0.0

      • setPreUtteranceDelay

        public void setPreUtteranceDelay​(double value)
        Default is 0.0

      • setPrefersAssistiveTechnologySettings

        public void setPrefersAssistiveTechnologySettings​(boolean value)
        If an assistive technology is on, like VoiceOver, the user's selected voice, rate and other settings will be used for this speech utterance instead of the default values. If no assistive technologies are on, then the values of the properties on AVSpeechUtterance will be used. Note that querying the properties will not refect the user's settings. API-Since: 14.0

      • setRate

        public void setRate​(float value)
        Values are pinned between AVSpeechUtteranceMinimumSpeechRate and AVSpeechUtteranceMaximumSpeechRate.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • setVoice

        public void setVoice​(@Nullable
                     @Nullable AVSpeechSynthesisVoice value)
        If no voice is specified, the system's default will be used.

      • setVolume

        public void setVolume​(float value)
        [0-1] Default = 1

      • speechString

        @NotNull
public @NotNull java.lang.String speechString()

      • speechUtteranceWithString

        public static AVSpeechUtterance speechUtteranceWithString​(@NotNull
                                                          @NotNull java.lang.String string)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding

      • version_static

        public static long version_static()

      • voice

        @Nullable
public @Nullable AVSpeechSynthesisVoice voice()
        If no voice is specified, the system's default will be used.

      • volume

        public float volume()
        [0-1] Default = 1

      • initWithSSMLRepresentation

        public AVSpeechUtterance initWithSSMLRepresentation​(@NotNull
                                                    @NotNull java.lang.String string)
        A speech utterance that expects markup written using the Speech Synthesis Markup Language (SSML) standard. Uses SSML markup to add attributes. If using SSML to request voices that fall under certain attributes, a single utterance may be split into multiple parts, each sent to the appropriate synthesizer. If no voice matches the properties, the voice in the @c voice property of the utterance will be used. If no @c voice is specified, the system's default will be used. @c AVSpeechUtterance properties that affect the prosidy of a voice such as @c rate, [@c] pitchMultiplier, @c pitchMultiplier will not apply to an utterance that uses an SSML representation. Returns nil if invalid SSML is passed in. API-Since: 16.0

      • speechUtteranceWithSSMLRepresentation

        public static AVSpeechUtterance speechUtteranceWithSSMLRepresentation​(@NotNull
                                                                      @NotNull java.lang.String string)
        A speech utterance that expects markup written using the Speech Synthesis Markup Language (SSML) standard. Returns nil if invalid SSML is passed in. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.