PHASE

Essentials 3

The engine and registry that drive playback and manage the spatial audio scene.

• Cl
  PHASEEngineiOS 15.0+

  !
• Cl
  PHASEAssetRegistryiOS 15.0+

  !
• Cl
  PHASEDefinitioniOS 15.0+

  !

Assets 4

Content registered with the engine for use in spatial sound events.

• Cl
  PHASEAssetiOS 15.0+

  !
• Cl
  PHASESoundAssetiOS 15.0+

  !
• Cl
  PHASESoundEventNodeAssetiOS 15.0+

  !
• Cl
  PHASEGlobalMetaParameterAssetiOS 15.0+

  !

Sound Events and Node Definitions 8

Sound events and the hierarchical node definitions that compose their playback graph.

• Cl
  PHASESoundEventiOS 15.0+

  !
• Cl
  PHASESoundEventNodeDefinitioniOS 15.0+

  !
• Cl
  PHASEGeneratorNodeDefinitioniOS 15.0+

  !
• Cl
  PHASESamplerNodeDefinitioniOS 15.0+

  !
• Cl
  PHASEContainerNodeDefinitioniOS 15.0+

  !
• Cl
  PHASEBlendNodeDefinitioniOS 15.0+

  !
• Cl
  PHASESwitchNodeDefinitioniOS 15.0+

  !
• Cl
  PHASERandomNodeDefinitioniOS 15.0+

  !

Streaming Audio 7

Nodes and definitions that feed audio into a sound event from push or pull sources.

• Cl
  PHASEStreamNodeiOS 18.0+

  !
• Cl
  PHASEPushStreamNodeDefinitioniOS 15.0+

  !
• Cl
  PHASEPushStreamNodeiOS 15.0+

  !
• Cl
  PHASEPullStreamNodeDefinitioniOS 18.0+

  !
• Cl
  PHASEPullStreamNodeiOS 18.0+

  !
• St
  PHASEPushStreamBufferOptions

  !
• En
  PHASEPushStreamCompletionCallbackCondition

  @enum PHASEPushStreamCompletionCallbackCondition

Scene Objects and Geometry 5

Objects, sources, and shapes that place sound and geometry within the listening environment.

• Cl
  PHASEObjectiOS 15.0+

  !
• Cl
  PHASESourceiOS 15.0+

  !
• Cl
  PHASEListeneriOS 15.0+

  !
• Cl
  PHASEOccluderiOS 15.0+

  !
• Cl
  PHASEShapeiOS 15.0+

  !

Directivity Models 5

Parameters that describe how a source radiates sound in different directions.

• Cl
  PHASEDirectivityModelParametersiOS 15.0+

  !
• Cl
  PHASECardioidDirectivityModelParametersiOS 15.0+

  !
• Cl
  PHASEConeDirectivityModelParametersiOS 15.0+

  !
• Cl
  PHASECardioidDirectivityModelSubbandParametersiOS 15.0+

  !
• Cl
  PHASEConeDirectivityModelSubbandParametersiOS 15.0+

  !

Distance Models 4

Parameters that govern how sound attenuates and fades with distance from the listener.

• Cl
  PHASEDistanceModelParametersiOS 15.0+

  !
• Cl
  PHASEGeometricSpreadingDistanceModelParametersiOS 15.0+

  !
• Cl
  PHASEEnvelopeDistanceModelParametersiOS 15.0+

  !
• Cl
  PHASEDistanceModelFadeOutParametersiOS 15.0+

  !

Mixers and Spatial Pipeline 8

Mixer definitions and the spatial pipeline that combine and route sound into the output.

• Cl
  PHASEMixeriOS 15.0+

  !
• Cl
  PHASEMixerDefinitioniOS 15.0+

  !
• Cl
  PHASESpatialMixerDefinitioniOS 15.0+

  !
• Cl
  PHASEAmbientMixerDefinitioniOS 15.0+

  !
• Cl
  PHASEChannelMixerDefinitioniOS 15.0+

  !
• Cl
  PHASEMixerParametersiOS 15.0+

  !
• Cl
  PHASESpatialPipelineiOS 15.0+

  !
• Cl
  PHASESpatialPipelineEntryiOS 15.0+

  !

Acoustics and Environment 3

Materials and media that model how sound interacts with surfaces and the transmission environment.

• Cl
  PHASEMaterialiOS 15.0+

  !
• Cl
  PHASEMediumiOS 15.0+

  !
• Cl
  PHASEDuckeriOS 15.0+

  !

Groups and Presets 3

Groups and presets for organizing and recalling collections of mixing settings.

• Cl
  PHASEGroupiOS 15.0+

  !
• Cl
  PHASEGroupPresetiOS 15.0+

  !
• Cl
  PHASEGroupPresetSettingiOS 15.0+

  !

Meta Parameters 7

Definitions and runtime values that parameterize sound behavior dynamically.

• Cl
  PHASEMetaParameteriOS 15.0+

  !
• Cl
  PHASENumberMetaParameteriOS 15.0+

  !
• Cl
  PHASEStringMetaParameteriOS 15.0+

  !
• Cl
  PHASEMetaParameterDefinitioniOS 15.0+

  !
• Cl
  PHASENumberMetaParameterDefinitioniOS 15.0+

  !
• Cl
  PHASEStringMetaParameterDefinitioniOS 15.0+

  !
• Cl
  PHASEMappedMetaParameterDefinitioniOS 15.0+

  !

Envelopes and Curves 4

Envelopes, segments, and numeric pairs that shape parameter values over a domain.

• Cl
  PHASEEnvelopeiOS 15.0+

  !
• Cl
  PHASEEnvelopeSegmentiOS 15.0+

  !
• Cl
  PHASENumericPairiOS 15.0+

  !
• En
  PHASECurveType

  @enum PHASECurveType

Configuration and Modes 9

Enumerations and option sets that configure spatialization, playback, and calibration behavior.

• En
  PHASEMaterialPreset

  @enum PHASEMaterialPreset
• En
  PHASEReverbPreset

  @enum PHASEReverbPreset
• En
  PHASESpatializationMode

  @enum PHASESpatializationMode
• En
  PHASEPlaybackMode

  @enum PHASEPlaybackMode
• En
  PHASENormalizationMode

  @enum PHASENormalizationMode
• En
  PHASECalibrationMode

  @enum PHASECalibrationMode
• En
  PHASECullOption

  @enum PHASECullOption
• St
  PHASESpatialCategory

  Constants that identify categories of spatial pipeline processing stages.
• St
  PHASEAutomaticHeadTrackingFlagsiOS 18.0+

  @enum PHASEAutomaticHeadTrackingFlags

Errors 3

Error types reported by the engine, sound events, and asset operations.

• St
  PHASEError

  Error codes reported by the PHASE engine.
• St
  PHASESoundEventError

  Error codes reported while preparing or playing a sound event.
• St
  PHASEAssetError

  Error codes reported while registering or accessing assets.

Type Aliases 1

• Ty
  PHASEPullStreamRenderHandler

  @typedef PHASEPullStreamRenderBlock