Package apple.phase

Class PHASESoundEvent

  • All Implemented Interfaces:
    NSObject
    public class PHASESoundEvent
extends NSObject
    [@interface] PHASESoundEvent A PHASESoundEvent is an object that represents a playable sound event in the PHASE system. API-Since: 15.0

    • Constructor Detail

      • PHASESoundEvent

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • 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()

      • 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()

      • initWithEngineAssetIdentifierError

        public PHASESoundEvent initWithEngineAssetIdentifierError​(@NotNull
                                                          @NotNull PHASEEngine engine,
                                                          @NotNull
                                                          @NotNull java.lang.String assetIdentifier,
                                                          @Nullable
                                                          @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        initWithEngine:assetIdentifier:error Creates a new sound event instance This will look up the asset in the asset registry and create the necessary objects to play the sound event
        Parameters:
        engine - The PHASEEngine object that the sound event will be played by.
        assetIdentifier - The identifier registered with the Asset Registry for the particular PHASESoundEventNodeAsset that this sound event will play. If the asset identifier is not registered, this function will fail.

      • initWithEngineAssetIdentifierMixerParametersError

        public PHASESoundEvent initWithEngineAssetIdentifierMixerParametersError​(@NotNull
                                                                         @NotNull PHASEEngine engine,
                                                                         @NotNull
                                                                         @NotNull java.lang.String assetIdentifier,
                                                                         @NotNull
                                                                         @NotNull PHASEMixerParameters mixerParameters,
                                                                         @Nullable
                                                                         @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        initWithEngine:assetIdentifier:mixerParameters:error Creates a new sound event instance This will look up the asset in the asset registry and create the necessary objects to play the sound event
        Parameters:
        engine - The PHASEEngine object that the sound event will be played by.
        assetIdentifier - The identifier registered with the Asset Registry for the particular PHASESoundEventNodeAsset that this sound instance will play. If the asset identifier is not registered, this function will fail.
        mixerParameters - A dictionary of PHASEMixerParameters objects with keys that match the identifiers of the spatial mixers in the sound event

      • instanceMethodSignatureForSelector

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

      • instancesRespondToSelector

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

      • isIndefinite

        public boolean isIndefinite()
        [@property] indefinite A boolean that tell if this sound event will run indefinitely, or finish executing on its own

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

      • metaParameters

        @NotNull
public @NotNull NSDictionary<java.lang.String,​? extends PHASEMetaParameter> metaParameters()
        [@property] metaParameters A Dictionary containing the MetaParameters associated with this sound event

      • mixers

        @NotNull
public @NotNull NSDictionary<java.lang.String,​? extends PHASEMixer> mixers()
        [@property] mixNodes A Dictionary containing the mix nodes associated with this sound event

      • pause

        public void pause()
        pause Pause the sound event.

      • prepareState

        public long prepareState()
        [@property] prepareState Sound Event's current preparation state

      • prepareWithCompletion

        public void prepareWithCompletion​(@Nullable
                                  @Nullable PHASESoundEvent.Block_prepareWithCompletion handler)
        prepareWithCompletion Prepare the sound event This function notifies the engine to begin preparing a sound event, then returns immediately. Once the sound event is prepared (or has failed to prepare), you will receive a callback via the completion. If you call startWithCompletion() before receiving the callback, the sound event will start as soon as it's prepared.
        Parameters:
        handler - The block that will be called when the PHASESoundEvent has finished preparing and is ready to start. Pass in nil for no handler.

      • pushStreamNodes

        @NotNull
public @NotNull NSDictionary<java.lang.String,​? extends PHASEPushStreamNode> pushStreamNodes()
        [@property] pushStreamNodes A Dictionary containing the push stream nodes associated with this sound event, for pushing buffers to.

      • renderingState

        public long renderingState()
        [@property] renderingState Sound Event's current rendering state

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • resume

        public void resume()
        resume Resume the sound event.

      • seekToTimeCompletion

        public void seekToTimeCompletion​(double time,
                                 @Nullable
                                 @Nullable PHASESoundEvent.Block_seekToTimeCompletion handler)
        seekToTime:completion Seeks all leaf nodes in a PHASESoundEvent to a specified time relative to the start of the sound event. This function notifies the engine to seek the sound event, then returns immediately. Once the sound event has seeked to the new offset (or has failed to seek), you will receive a callback via the completion. If any leaf nodes do not support seeking, those nodes will ignore this command. Nodes that have finished playing or have stopped will not seek. Nodes that are sleeping will seek, and will resume at the correct time when they wake up. [@note] The time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • startWithCompletion

        public void startWithCompletion​(@Nullable
                                @Nullable PHASESoundEvent.Block_startWithCompletion handler)
        startWithCompletion Start the sound event This function notifies the engine to start the sound event, then returns immediately. Once the sound event is playing (or has failed to start), you will receive a callback via the completion. Playback will begin immediately if the sound event has been prepared; otherwise, it will start as soon as it is finished preparing.
        Parameters:
        handler - The block that will be called when the sound event has stopped.

      • stopAndInvalidate

        public void stopAndInvalidate()
        stopAndInvalidate stop and invalidate the sound event

      • superclass_static

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

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.