Package apple.audiotoolbox.protocol

Interface AUMessageChannel

public interface AUMessageChannel

[@protocol] AUMessageChannel The protocol which objects returned from `[AUAudioUnit messageChannelFor:]` have to conform to. Audio Units and hosts that have special needs of communication, e.g. to exchange musical context required for better audio processing, can implement a communication object to exchange messages in form of NSDictionaries. An Audio Unit would need to implement a class conforming to the AUMessageChannel protocol and return an instance via `[AUAudioUnit messageChannelFor:]`. A host can query the instance via the channel name. The protocol offers a method to send messages to the AU and a block to send messages to the host. API-Since: 16.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AUMessageChannel.Block_callHostBlock_ret
static interface	AUMessageChannel.Block_setCallHostBlock

Method Summary

Modifier and Type	Method	Description
default @NotNull NSDictionary<?,?>	callAudioUnit(@NotNull NSDictionary<?,?> message)	callAudioUnit: Calls the Audio Unit with custom data message.
default @Nullable AUMessageChannel.Block_callHostBlock_ret	callHostBlock()	[@property] sendMessageToHostBlock A callback for the AU to send a message to the host.
default void	setCallHostBlock(@Nullable AUMessageChannel.Block_setCallHostBlock value)	[@property] sendMessageToHostBlock A callback for the AU to send a message to the host.

Method Detail

callAudioUnit

@NotNull
default @NotNull NSDictionary<?,?> callAudioUnit(@NotNull
                                                       @NotNull NSDictionary<?,?> message)

callAudioUnit: Calls the Audio Unit with custom data message.

Parameters:

message - An NSDictionary with custom data. The allowed classes for key and value types are NSArray, NSDictionary, NSOrderedSet, NSSet, NSString, NSData, NSNull, NSNumber, NSDate

Returns:

An NSDictionary with custom data. The allowed classes for key and value types are NSArray, NSDictionary, NSOrderedSet, NSSet, NSString, NSData, NSNull, NSNumber, NSDate

callHostBlock

@Nullable
default @Nullable AUMessageChannel.Block_callHostBlock_ret callHostBlock()

[@property] sendMessageToHostBlock A callback for the AU to send a message to the host. The host has to set a block on this property.

setCallHostBlock

default void setCallHostBlock(@Nullable
                              @Nullable AUMessageChannel.Block_setCallHostBlock value)

[@property] sendMessageToHostBlock A callback for the AU to send a message to the host. The host has to set a block on this property.