AVAudioUnitSampler Class

Reference

Definition

Namespace:: AVFoundation

Assembly:: Xamarin.iOS.dll

Assembly:: Xamarin.Mac.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Encapsulate Apple's Sampler Audio Unit. Supports several input formats, output is a single stereo bus.

[Foundation.Register("AVAudioUnitSampler", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVAudioUnitSampler : AVFoundation.AVAudioUnitMidiInstrument

type AVAudioUnitSampler = class
    inherit AVAudioUnitMidiInstrument

Inheritance: Object

NSObject

AVAudioNode

AVAudioUnit

AVAudioUnitMidiInstrument
AVAudioUnitSampler

Attributes: RegisterAttribute IntroducedAttribute UnavailableAttribute

Constructors

AVAudioUnitSampler()	Default constructor, initializes a new instance of this class.
AVAudioUnitSampler(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
AVAudioUnitSampler(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AUAudioUnit	Gets the audio unit as an Audio Toolbox audio unit. (Inherited from AVAudioUnit)
AudioUnit	Gets the audio unit as a Core Audio unit. (Inherited from AVAudioUnit)
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
Engine	Gets the AVAudioEngine for the node, or `null`. (Inherited from AVAudioNode)
GlobalTuning	Gets or sets the global tuning adjustment.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
LastRenderTime	If not `null`, the AVAudioTime for which the node last rendered. (Inherited from AVAudioNode)
Latency	(Inherited from AVAudioNode)
ManufacturerName	Gets the name of the manufacturer of the underlying hardware unit. (Inherited from AVAudioUnit)
MasterGain	Gets or sets the gain, in decibels, applied to all played notes.
Name	Gets a descriptive name for the audio unit. (Inherited from AVAudioUnit)
NumberOfInputs	Gets the number of input busses of this node. (Inherited from AVAudioNode)
NumberOfOutputs	Gets the number of output busses of this node. (Inherited from AVAudioNode)
Obstruction	Gets or sets a value in [-100,0] that controls by how many decibels to attentuate sound that comes directly from a source due to an obstruction between the listener and source. (Inherited from AVAudioUnitMidiInstrument)
Occlusion	Gets or sets a value in [-100,0] that controls by how many decibels to attentuate, due to an obstruction between the listener and source, both sound that comes directly from a source and reverberations. (Inherited from AVAudioUnitMidiInstrument)
OutputPresentationLatency	(Inherited from AVAudioNode)
Pan	Gets or sets the stereo pan. (Inherited from AVAudioUnitMidiInstrument)
Position	Gets or sets the 3D location of the source. (Inherited from AVAudioUnitMidiInstrument)
Rate	Gets or sets the instrument playback rate. (Inherited from AVAudioUnitMidiInstrument)
RenderingAlgorithm	Gets or sets the rendering algorithm to use. (Inherited from AVAudioUnitMidiInstrument)
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
ReverbBlend	Gets or sets a value in [0.0,1.0] that controls the blend of unprocessed and processed audio. (Inherited from AVAudioUnitMidiInstrument)
Self	(Inherited from NSObject)
StereoPan	Gets or sets the amount of stereo panning applied to all played notes.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Version	Gets the audio unit version number. (Inherited from AVAudioUnit)
Volume	Gets or sets the input volume of the instrument. (Inherited from AVAudioUnitMidiInstrument)
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DestinationForMixer(AVAudioNode, nuint)	(Inherited from AVAudioUnitMidiInstrument)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetBusInputFormat(nuint)	(Inherited from AVAudioNode)
GetBusOutputFormat(nuint)	(Inherited from AVAudioNode)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNameForInputBus(nuint)	(Inherited from AVAudioNode)
GetNameForOutputBus(nuint)	(Inherited from AVAudioNode)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
InstallTapOnBus(nuint, UInt32, AVAudioFormat, AVAudioNodeTapBlock)	(Inherited from AVAudioNode)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
LoadAudioFiles(NSUrl[], NSError)	Configures the AVAudioUnitSampler by loading the specified `audioFiles`.
LoadAudioUnitPreset(NSUrl, NSError)	Loads the audio presets that are stored at `url`. If an error occurs, stores it in `error`. (Inherited from AVAudioUnit)
LoadInstrument(NSUrl, NSError)	Configures the AVAudioUnitSampler by loading the specified instrument.
LoadSoundBank(NSUrl, Byte, Byte, Byte, NSError)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveTapOnBus(nuint)	(Inherited from AVAudioNode)
Reset()	Clears the processing state of this node. (Inherited from AVAudioNode)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SendController(Byte, Byte, Byte)	Sends a MIDI controller event.. (Inherited from AVAudioUnitMidiInstrument)
SendMidiEvent(Byte, Byte, Byte)	Sends a two-byte MIDI event. (Inherited from AVAudioUnitMidiInstrument)
SendMidiEvent(Byte, Byte)	Sends a one-byte MIDI event. (Inherited from AVAudioUnitMidiInstrument)
SendMidiSysExEvent(NSData)	Sends a MIDI system-exclusive event. (Inherited from AVAudioUnitMidiInstrument)
SendPitchBend(UInt16, Byte)	Sends a MIDI pitch-bend event. (Inherited from AVAudioUnitMidiInstrument)
SendPressure(Byte, Byte)	Sends a MIDI pressure event. (Inherited from AVAudioUnitMidiInstrument)
SendPressureForKey(Byte, Byte, Byte)	Sends a MIDI polyphonic key pressure event for the specified `key`. (Inherited from AVAudioUnitMidiInstrument)
SendProgramChange(Byte, Byte, Byte, Byte)	Sends MIDI program change and bank select events. (Inherited from AVAudioUnitMidiInstrument)
SendProgramChange(Byte, Byte)	Sends MIDI program change and bank select events. (Inherited from AVAudioUnitMidiInstrument)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
StartNote(Byte, Byte, Byte)	Sends a start note event. (Inherited from AVAudioUnitMidiInstrument)
StopNote(Byte, Byte)	Sends a stop note event. (Inherited from AVAudioUnitMidiInstrument)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
DestinationForMixer(IAVAudioMixing, AVAudioNode, nuint)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via