phase

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 25, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package phase provides purego-based Go bindings for the macOS PHASE framework.

Apple documentation: https://developer.apple.com/documentation/phase

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PHASEAssetErrorDomain

func PHASEAssetErrorDomain() *foundation.NSString

@const PHASEAssetErrorDomain @abstract The NSErrorDomain for PHASE Asset errors

func PHASEErrorDomain

func PHASEErrorDomain() *foundation.NSString

@const PHASEErrorDomain @abstract The NSErrorDomain for general PHASE errors

func PHASEObjectForward

func PHASEObjectForward() unsafe.Pointer

@property forward @abstract The direction PHASE treats as "forward" in local space for all objects.

func PHASEObjectRight

func PHASEObjectRight() unsafe.Pointer

@property right @abstract The direction PHASE treats as "right" in local space for all objects.

func PHASEObjectUp

func PHASEObjectUp() unsafe.Pointer

@property up @abstract The direction PHASE treats as "up" in local space for all objects.

func PHASESoundEventErrorDomain

func PHASESoundEventErrorDomain() *foundation.NSString

@const PHASESoundEventErrorDomain @abstract The NSErrorDomain for PHASE sound event errors.

func PHASESpatialCategoryDirectPathTransmission

func PHASESpatialCategoryDirectPathTransmission() *foundation.NSString

@constant PHASESpatialCategoryDirectPathTransmission

func PHASESpatialCategoryEarlyReflections

func PHASESpatialCategoryEarlyReflections() *foundation.NSString

@constant PHASEEarlyReflections

func PHASESpatialCategoryLateReverb

func PHASESpatialCategoryLateReverb() *foundation.NSString

@constant PHASELateReverb

Types

type Acl_entry_id_t

type Acl_entry_id_t int64
const (
	ACL_FIRST_ENTRY Acl_entry_id_t = 0
	ACL_NEXT_ENTRY  Acl_entry_id_t = -1
	ACL_LAST_ENTRY  Acl_entry_id_t = -2
)

func (Acl_entry_id_t) String

func (e Acl_entry_id_t) String() string

type Acl_flag_t

type Acl_flag_t int64
const (
	ACL_FLAG_DEFER_INHERIT      Acl_flag_t = 1
	ACL_FLAG_NO_INHERIT         Acl_flag_t = 131072
	ACL_ENTRY_INHERITED         Acl_flag_t = 16
	ACL_ENTRY_FILE_INHERIT      Acl_flag_t = 32
	ACL_ENTRY_DIRECTORY_INHERIT Acl_flag_t = 64
	ACL_ENTRY_LIMIT_INHERIT     Acl_flag_t = 128
	ACL_ENTRY_ONLY_INHERIT      Acl_flag_t = 256
)

func (Acl_flag_t) String

func (e Acl_flag_t) String() string

type Acl_perm_t

type Acl_perm_t int64
const (
	ACL_READ_DATA           Acl_perm_t = 2
	ACL_LIST_DIRECTORY      Acl_perm_t = 2
	ACL_WRITE_DATA          Acl_perm_t = 4
	ACL_ADD_FILE            Acl_perm_t = 4
	ACL_EXECUTE             Acl_perm_t = 8
	ACL_SEARCH              Acl_perm_t = 8
	ACL_DELETE              Acl_perm_t = 16
	ACL_APPEND_DATA         Acl_perm_t = 32
	ACL_ADD_SUBDIRECTORY    Acl_perm_t = 32
	ACL_DELETE_CHILD        Acl_perm_t = 64
	ACL_READ_ATTRIBUTES     Acl_perm_t = 128
	ACL_WRITE_ATTRIBUTES    Acl_perm_t = 256
	ACL_READ_EXTATTRIBUTES  Acl_perm_t = 512
	ACL_WRITE_EXTATTRIBUTES Acl_perm_t = 1024
	ACL_READ_SECURITY       Acl_perm_t = 2048
	ACL_WRITE_SECURITY      Acl_perm_t = 4096
	ACL_CHANGE_OWNER        Acl_perm_t = 8192
	ACL_SYNCHRONIZE         Acl_perm_t = 1048576
)

func (Acl_perm_t) String

func (e Acl_perm_t) String() string

type Acl_tag_t

type Acl_tag_t int64
const (
	ACL_UNDEFINED_TAG  Acl_tag_t = 0
	ACL_EXTENDED_ALLOW Acl_tag_t = 1
	ACL_EXTENDED_DENY  Acl_tag_t = 2
)

func (Acl_tag_t) String

func (e Acl_tag_t) String() string

type Acl_type_t

type Acl_type_t int64
const (
	ACL_TYPE_EXTENDED Acl_type_t = 256
	ACL_TYPE_ACCESS   Acl_type_t = 0
	ACL_TYPE_DEFAULT  Acl_type_t = 1
	ACL_TYPE_AFS      Acl_type_t = 2
	ACL_TYPE_CODA     Acl_type_t = 3
	ACL_TYPE_NTFS     Acl_type_t = 4
	ACL_TYPE_NWFS     Acl_type_t = 5
)

func (Acl_type_t) String

func (e Acl_type_t) String() string

type CGLCPContextPriorityRequest

type CGLCPContextPriorityRequest int64
const (
	KCGLCPContextPriorityRequestHigh   CGLCPContextPriorityRequest = 0
	KCGLCPContextPriorityRequestNormal CGLCPContextPriorityRequest = 1
	KCGLCPContextPriorityRequestLow    CGLCPContextPriorityRequest = 2
)

func (CGLCPContextPriorityRequest) String

type Clockid_t

type Clockid_t int64

func (Clockid_t) String

func (e Clockid_t) String() string

type Dispatch_autorelease_frequency_t

type Dispatch_autorelease_frequency_t uint64
const (
	DISPATCH_AUTORELEASE_FREQUENCY_INHERIT   Dispatch_autorelease_frequency_t = 0
	DISPATCH_AUTORELEASE_FREQUENCY_WORK_ITEM Dispatch_autorelease_frequency_t = 1
	DISPATCH_AUTORELEASE_FREQUENCY_NEVER     Dispatch_autorelease_frequency_t = 2
)

func (Dispatch_autorelease_frequency_t) String

type Dispatch_block_flags_t

type Dispatch_block_flags_t uint64
const (
	DISPATCH_BLOCK_BARRIER           Dispatch_block_flags_t = 1
	DISPATCH_BLOCK_DETACHED          Dispatch_block_flags_t = 2
	DISPATCH_BLOCK_ASSIGN_CURRENT    Dispatch_block_flags_t = 4
	DISPATCH_BLOCK_NO_QOS_CLASS      Dispatch_block_flags_t = 8
	DISPATCH_BLOCK_INHERIT_QOS_CLASS Dispatch_block_flags_t = 16
	DISPATCH_BLOCK_ENFORCE_QOS_CLASS Dispatch_block_flags_t = 32
)

func (Dispatch_block_flags_t) String

func (e Dispatch_block_flags_t) String() string

type EvCmd

type EvCmd int64
const (
	EVNOP   EvCmd = 0
	EVHIDE  EvCmd = 1
	EVSHOW  EvCmd = 2
	EVMOVE  EvCmd = 3
	EVLEVEL EvCmd = 4
)

func (EvCmd) String

func (e EvCmd) String() string

type Filesec_property_t

type Filesec_property_t int64
const (
	FILESEC_OWNER         Filesec_property_t = 1
	FILESEC_GROUP         Filesec_property_t = 2
	FILESEC_UUID          Filesec_property_t = 3
	FILESEC_MODE          Filesec_property_t = 4
	FILESEC_ACL           Filesec_property_t = 5
	FILESEC_GRPUUID       Filesec_property_t = 6
	FILESEC_ACL_RAW       Filesec_property_t = 100
	FILESEC_ACL_ALLOCSIZE Filesec_property_t = 101
)

func (Filesec_property_t) String

func (e Filesec_property_t) String() string

type Idtype_t

type Idtype_t int64
const (
	P_ALL  Idtype_t = 0
	P_PID  Idtype_t = 1
	P_PGID Idtype_t = 2
)

func (Idtype_t) String

func (e Idtype_t) String() string

type Ipc_info_object_type_t

type Ipc_info_object_type_t int64
const (
	IPC_OTYPE_NONE                 Ipc_info_object_type_t = 0
	IPC_OTYPE_THREAD_CONTROL       Ipc_info_object_type_t = 1
	IPC_OTYPE_TASK_CONTROL         Ipc_info_object_type_t = 2
	IPC_OTYPE_HOST                 Ipc_info_object_type_t = 3
	IPC_OTYPE_HOST_PRIV            Ipc_info_object_type_t = 4
	IPC_OTYPE_PROCESSOR            Ipc_info_object_type_t = 5
	IPC_OTYPE_PROCESSOR_SET        Ipc_info_object_type_t = 6
	IPC_OTYPE_PROCESSOR_SET_NAME   Ipc_info_object_type_t = 7
	IPC_OTYPE_TIMER                Ipc_info_object_type_t = 8
	IPC_OTYPE_PORT_SUBST_ONCE      Ipc_info_object_type_t = 9
	IPC_OTYPE_MIG                  Ipc_info_object_type_t = 10
	IPC_OTYPE_MEMORY_OBJECT        Ipc_info_object_type_t = 11
	IPC_OTYPE_XMM_PAGER            Ipc_info_object_type_t = 12
	IPC_OTYPE_XMM_KERNEL           Ipc_info_object_type_t = 13
	IPC_OTYPE_XMM_REPLY            Ipc_info_object_type_t = 14
	IPC_OTYPE_UND_REPLY            Ipc_info_object_type_t = 15
	IPC_OTYPE_HOST_NOTIFY          Ipc_info_object_type_t = 16
	IPC_OTYPE_HOST_SECURITY        Ipc_info_object_type_t = 17
	IPC_OTYPE_LEDGER               Ipc_info_object_type_t = 18
	IPC_OTYPE_MAIN_DEVICE          Ipc_info_object_type_t = 19
	IPC_OTYPE_TASK_NAME            Ipc_info_object_type_t = 20
	IPC_OTYPE_SUBSYSTEM            Ipc_info_object_type_t = 21
	IPC_OTYPE_IO_DONE_QUEUE        Ipc_info_object_type_t = 22
	IPC_OTYPE_SEMAPHORE            Ipc_info_object_type_t = 23
	IPC_OTYPE_LOCK_SET             Ipc_info_object_type_t = 24
	IPC_OTYPE_CLOCK                Ipc_info_object_type_t = 25
	IPC_OTYPE_CLOCK_CTRL           Ipc_info_object_type_t = 26
	IPC_OTYPE_IOKIT_IDENT          Ipc_info_object_type_t = 27
	IPC_OTYPE_NAMED_ENTRY          Ipc_info_object_type_t = 28
	IPC_OTYPE_IOKIT_CONNECT        Ipc_info_object_type_t = 29
	IPC_OTYPE_IOKIT_OBJECT         Ipc_info_object_type_t = 30
	IPC_OTYPE_UPL                  Ipc_info_object_type_t = 31
	IPC_OTYPE_MEM_OBJ_CONTROL      Ipc_info_object_type_t = 32
	IPC_OTYPE_AU_SESSIONPORT       Ipc_info_object_type_t = 33
	IPC_OTYPE_FILEPORT             Ipc_info_object_type_t = 34
	IPC_OTYPE_LABELH               Ipc_info_object_type_t = 35
	IPC_OTYPE_TASK_RESUME          Ipc_info_object_type_t = 36
	IPC_OTYPE_VOUCHER              Ipc_info_object_type_t = 37
	IPC_OTYPE_VOUCHER_ATTR_CONTROL Ipc_info_object_type_t = 38
	IPC_OTYPE_WORK_INTERVAL        Ipc_info_object_type_t = 39
	IPC_OTYPE_UX_HANDLER           Ipc_info_object_type_t = 40
	IPC_OTYPE_UEXT_OBJECT          Ipc_info_object_type_t = 41
	IPC_OTYPE_ARCADE_REG           Ipc_info_object_type_t = 42
	IPC_OTYPE_EVENTLINK            Ipc_info_object_type_t = 43
	IPC_OTYPE_TASK_INSPECT         Ipc_info_object_type_t = 44
	IPC_OTYPE_TASK_READ            Ipc_info_object_type_t = 45
	IPC_OTYPE_THREAD_INSPECT       Ipc_info_object_type_t = 46
	IPC_OTYPE_THREAD_READ          Ipc_info_object_type_t = 47
	IPC_OTYPE_SUID_CRED            Ipc_info_object_type_t = 48
	IPC_OTYPE_HYPERVISOR           Ipc_info_object_type_t = 49
	IPC_OTYPE_TASK_ID_TOKEN        Ipc_info_object_type_t = 50
	IPC_OTYPE_TASK_FATAL           Ipc_info_object_type_t = 51
	IPC_OTYPE_KCDATA               Ipc_info_object_type_t = 52
	IPC_OTYPE_EXCLAVES_RESOURCE    Ipc_info_object_type_t = 53
	IPC_OTYPE_THREAD_RESUME        Ipc_info_object_type_t = 54
	IPC_OTYPE_UNKNOWN              Ipc_info_object_type_t = 4294967295
)

func (Ipc_info_object_type_t) String

func (e Ipc_info_object_type_t) String() string

type Launch_data_type_t

type Launch_data_type_t int64
const (
	LAUNCH_DATA_DICTIONARY Launch_data_type_t = 1
	LAUNCH_DATA_ARRAY      Launch_data_type_t = 2
	LAUNCH_DATA_FD         Launch_data_type_t = 3
	LAUNCH_DATA_INTEGER    Launch_data_type_t = 4
	LAUNCH_DATA_REAL       Launch_data_type_t = 5
	LAUNCH_DATA_BOOL       Launch_data_type_t = 6
	LAUNCH_DATA_STRING     Launch_data_type_t = 7
	LAUNCH_DATA_OPAQUE     Launch_data_type_t = 8
	LAUNCH_DATA_ERRNO      Launch_data_type_t = 9
	LAUNCH_DATA_MACHPORT   Launch_data_type_t = 10
)

func (Launch_data_type_t) String

func (e Launch_data_type_t) String() string

type MDLabelDomain

type MDLabelDomain int64

@typedef MDLabelDomain @abstract These constants are used to specify a domain to MDLabelCreate().

const (
	KMDLabelUserDomain  MDLabelDomain = 0
	KMDLabelLocalDomain MDLabelDomain = 1
)

func (MDLabelDomain) String

func (e MDLabelDomain) String() string

type MDQueryOptionFlags

type MDQueryOptionFlags int64
const (
	KMDQuerySynchronous        MDQueryOptionFlags = 1
	KMDQueryWantsUpdates       MDQueryOptionFlags = 4
	KMDQueryAllowFSTranslation MDQueryOptionFlags = 8
)

func (MDQueryOptionFlags) String

func (e MDQueryOptionFlags) String() string

type MDQuerySortOptionFlags

type MDQuerySortOptionFlags int64

@enum MDQuerySortOptionFlags @constant kMDQueryReverseSortOrderFlag Sort the attribute in reverse order.

const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String

func (e MDQuerySortOptionFlags) String() string

type Mach_vm_range_flags_t

type Mach_vm_range_flags_t int64
const (
	MACH_VM_RANGE_NONE Mach_vm_range_flags_t = 0
)

func (Mach_vm_range_flags_t) String

func (e Mach_vm_range_flags_t) String() string

type Mach_vm_range_flavor_t

type Mach_vm_range_flavor_t int64
const (
	MACH_VM_RANGE_FLAVOR_INVALID Mach_vm_range_flavor_t = 0
	MACH_VM_RANGE_FLAVOR_V1      Mach_vm_range_flavor_t = 1
)

func (Mach_vm_range_flavor_t) String

func (e Mach_vm_range_flavor_t) String() string

type Mach_vm_range_tag_t

type Mach_vm_range_tag_t int64
const (
	MACH_VM_RANGE_DEFAULT Mach_vm_range_tag_t = 0
	MACH_VM_RANGE_DATA    Mach_vm_range_tag_t = 1
	MACH_VM_RANGE_FIXED   Mach_vm_range_tag_t = 2
)

func (Mach_vm_range_tag_t) String

func (e Mach_vm_range_tag_t) String() string

type Mpo_flags_t

type Mpo_flags_t int64
const (
	MPO_PORT                            Mpo_flags_t = 0
	MPO_SERVICE_PORT                    Mpo_flags_t = 1024
	MPO_CONNECTION_PORT                 Mpo_flags_t = 2048
	MPO_REPLY_PORT                      Mpo_flags_t = 4096
	MPO_WEAK_REPLY_PORT                 Mpo_flags_t = 16384
	MPO_NOTIFICATION_PORT               Mpo_flags_t = 17408
	MPO_EXCEPTION_PORT                  Mpo_flags_t = 32768
	MPO_CONNECTION_PORT_WITH_PORT_ARRAY Mpo_flags_t = 65536
)

func (Mpo_flags_t) String

func (e Mpo_flags_t) String() string

type NXMouseButton

type NXMouseButton int64
const (
	NX_OneButton   NXMouseButton = 0
	NX_LeftButton  NXMouseButton = 1
	NX_RightButton NXMouseButton = 2
)

func (NXMouseButton) String

func (e NXMouseButton) String() string

type Os_clockid_t

type Os_clockid_t int64
const (
	OS_CLOCK_MACH_ABSOLUTE_TIME Os_clockid_t = 32
)

func (Os_clockid_t) String

func (e Os_clockid_t) String() string

type PHASEAmbientMixerDefinition

type PHASEAmbientMixerDefinition struct {
	PHASEMixerDefinition
}

An audio-layering object that outputs sound in a particular direction in 3D space.

Apple documentation: https://developer.apple.com/documentation/phase/phaseambientmixerdefinition

func PHASEAmbientMixerDefinitionFromID

func PHASEAmbientMixerDefinitionFromID(id objc.ID) *PHASEAmbientMixerDefinition

func (*PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientation

func (o *PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientation(layout *avfaudio.AVAudioChannelLayout, orientation unsafe.Pointer) *PHASEAmbientMixerDefinition

Creates an ambient mixer with the given channel layout and orientation.

func (*PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientationIdentifier

func (o *PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientationIdentifier(layout *avfaudio.AVAudioChannelLayout, orientation unsafe.Pointer, identifier *foundation.NSString) *PHASEAmbientMixerDefinition

Creates a named ambient mixer with the given channel layout and orientation.

func (*PHASEAmbientMixerDefinition) InputChannelLayout

@property inputChannelLayout @abstract A readonly value of the input channel layout this mixer was initialized with.

func (*PHASEAmbientMixerDefinition) Orientation

func (o *PHASEAmbientMixerDefinition) Orientation() unsafe.Pointer

@property orientation @abstract A readonly value of the ambient source's orientation relative to the scene root.

type PHASEAsset

type PHASEAsset struct {
	foundation.NSObject
}

A base class that adds a name to framework assets.

Apple documentation: https://developer.apple.com/documentation/phase/phaseasset

func PHASEAssetFromID

func PHASEAssetFromID(id objc.ID) *PHASEAsset

func (*PHASEAsset) Identifier

func (o *PHASEAsset) Identifier() *foundation.NSString

type PHASEAssetError

type PHASEAssetError int64

An asset error that PHASE reports.

const (
	PHASEAssetErrorFailedToLoad          PHASEAssetError = 1346920801
	PHASEAssetErrorInvalidEngineInstance PHASEAssetError = 1346920802
	PHASEAssetErrorBadParameters         PHASEAssetError = 1346920803
	PHASEAssetErrorAlreadyExists         PHASEAssetError = 1346920804
	PHASEAssetErrorGeneralError          PHASEAssetError = 1346920805
	PHASEAssetErrorMemoryAllocation      PHASEAssetError = 1346920806
)

func (PHASEAssetError) String

func (e PHASEAssetError) String() string

type PHASEAssetRegistry

type PHASEAssetRegistry struct {
	foundation.NSObject
}

A central repository of audio assets.

Apple documentation: https://developer.apple.com/documentation/phase/phaseassetregistry

func PHASEAssetRegistryFromID

func PHASEAssetRegistryFromID(id objc.ID) *PHASEAssetRegistry

func (*PHASEAssetRegistry) AssetForIdentifier

func (o *PHASEAssetRegistry) AssetForIdentifier(identifier *foundation.NSString) *PHASEAsset

Provides the asset named with the designated identifier.

func (*PHASEAssetRegistry) GlobalMetaParameters

func (*PHASEAssetRegistry) RegisterGlobalMetaParameterError

func (o *PHASEAssetRegistry) RegisterGlobalMetaParameterError(metaParameterDefinition *PHASEMetaParameterDefinition) (*PHASEGlobalMetaParameterAsset, error)

Registers a global metaparameter with the asset registry.

func (*PHASEAssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationModeError

func (o *PHASEAssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationModeError(url *foundation.NSURL, identifier *foundation.NSString, assetType PHASEAssetType, channelLayout *avfaudio.AVAudioChannelLayout, normalizationMode PHASENormalizationMode) (*PHASESoundAsset, error)

Loads a sound asset from the argument URL and adds it to the engine’s list of registered assets.

func (*PHASEAssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationModeError

func (o *PHASEAssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationModeError(data *foundation.NSData, identifier *foundation.NSString, format *avfaudio.AVAudioFormat, normalizationMode PHASENormalizationMode) (*PHASESoundAsset, error)

Loads a sound asset from memory and adds it to the engine’s list of registered assets.

func (*PHASEAssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifierError

func (o *PHASEAssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifierError(rootNode *PHASESoundEventNodeDefinition, identifier *foundation.NSString) (*PHASESoundEventNodeAsset, error)

Registers the root node of the sound event asset.

func (*PHASEAssetRegistry) UnregisterAssetWithIdentifierCompletion

func (o *PHASEAssetRegistry) UnregisterAssetWithIdentifierCompletion(identifier *foundation.NSString, handler func(bool))

Deallocates system memory for a given asset and removes it from the engine’s list of registered assets.

type PHASEAssetType

type PHASEAssetType int64

Options that determine how PHASE manages sound assets in memory.

const (
	PHASEAssetTypeResident PHASEAssetType = 0
	PHASEAssetTypeStreamed PHASEAssetType = 1
)

func (PHASEAssetType) String

func (e PHASEAssetType) String() string

type PHASEAutomaticHeadTrackingFlags

type PHASEAutomaticHeadTrackingFlags uint64
const (
	PHASEAutomaticHeadTrackingFlagOrientation PHASEAutomaticHeadTrackingFlags = 1
	PHASEAutomaticHeadTrackingFlagPosition    PHASEAutomaticHeadTrackingFlags = 2
)

func (PHASEAutomaticHeadTrackingFlags) String

type PHASEBlendNodeDefinition

type PHASEBlendNodeDefinition struct {
	PHASESoundEventNodeDefinition
}

A node that smoothly fades between the audio of its child nodes.

Apple documentation: https://developer.apple.com/documentation/phase/phaseblendnodedefinition

func PHASEBlendNodeDefinitionFromID

func PHASEBlendNodeDefinitionFromID(id objc.ID) *PHASEBlendNodeDefinition

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

Adds a child node that blends above a given value.

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

Adds a child node that blends below a given value.

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree(lowValue float64, highValue float64, fullGainAtLowValue float64, fullGainAtHighValue float64, lowFadeCurveType PHASECurveType, highFadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

Adds a child node that blends between a given high and low value.

func (*PHASEBlendNodeDefinition) AddRangeWithEnvelopeSubtree

func (o *PHASEBlendNodeDefinition) AddRangeWithEnvelopeSubtree(envelope *PHASEEnvelope, subtree *PHASESoundEventNodeDefinition)

Adds a child node with an envelope.

func (*PHASEBlendNodeDefinition) BlendParameterDefinition

func (o *PHASEBlendNodeDefinition) BlendParameterDefinition() *PHASENumberMetaParameterDefinition

func (*PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinition

func (o *PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinition(spatialMixerDefinition *PHASESpatialMixerDefinition) *PHASEBlendNodeDefinition

Creates a blend node for spatial audio output.

func (*PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinitionIdentifier

func (o *PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinitionIdentifier(spatialMixerDefinition *PHASESpatialMixerDefinition, identifier *foundation.NSString) *PHASEBlendNodeDefinition

Creates a named blend node for spatial audio output.

func (*PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinition

func (o *PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinition(blendMetaParameterDefinition *PHASENumberMetaParameterDefinition) *PHASEBlendNodeDefinition

Creates a blend node with a maxiumum blend range value.

func (*PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinitionIdentifier

func (o *PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinitionIdentifier(blendMetaParameterDefinition *PHASENumberMetaParameterDefinition, identifier *foundation.NSString) *PHASEBlendNodeDefinition

Creates a named blend node with a maxiumum blend range value.

func (*PHASEBlendNodeDefinition) SpatialMixerDefinitionForDistance

func (o *PHASEBlendNodeDefinition) SpatialMixerDefinitionForDistance() *PHASESpatialMixerDefinition

type PHASECalibrationMode

type PHASECalibrationMode int64

Calibration options for sound pressure level.

const (
	// An option that specifies no loudness calibration.
	PHASECalibrationModeNone PHASECalibrationMode = 0
	// A sound pressure level that’s tuned for the device.
	PHASECalibrationModeRelativeSpl PHASECalibrationMode = 1
	// A sound pressure level based on the current output device.
	PHASECalibrationModeAbsoluteSpl PHASECalibrationMode = 2
)

func (PHASECalibrationMode) String

func (e PHASECalibrationMode) String() string

type PHASECardioidDirectivityModelParameters

type PHASECardioidDirectivityModelParameters struct {
	PHASEDirectivityModelParameters
}

An object that directs sound in a heart-shaped curve surrounding a sound source.

Apple documentation: https://developer.apple.com/documentation/phase/phasecardioiddirectivitymodelparameters

func PHASECardioidDirectivityModelParametersFromID

func PHASECardioidDirectivityModelParametersFromID(id objc.ID) *PHASECardioidDirectivityModelParameters

func (*PHASECardioidDirectivityModelParameters) InitWithSubbandParameters

Creates an object that directs sound in a heart-shaped curve surrounding a sound source.

func (*PHASECardioidDirectivityModelParameters) SubbandParameters

type PHASECardioidDirectivityModelSubbandParameters

type PHASECardioidDirectivityModelSubbandParameters struct {
	foundation.NSObject
}

A data set that projects sound of a certain frequency outward in the shape of a heart.

Apple documentation: https://developer.apple.com/documentation/phase/phasecardioiddirectivitymodelsubbandparameters

func PHASECardioidDirectivityModelSubbandParametersFromID

func PHASECardioidDirectivityModelSubbandParametersFromID(id objc.ID) *PHASECardioidDirectivityModelSubbandParameters

func (*PHASECardioidDirectivityModelSubbandParameters) Frequency

@property frequency @abstract The frequency of the subband, in hertz. @note Values are clamped to the range [20.0, 20000.0]. Default value is 1000.0.

func (*PHASECardioidDirectivityModelSubbandParameters) Init

Creates a data set that projects sound of a certain frequency outward in the shape of a heart.

func (*PHASECardioidDirectivityModelSubbandParameters) Pattern

@property pattern @abstract The directivity pattern. @note Values are clamped to the range [0.0, 1.0]. Default value is 0.0. 0.0 is omnidirectional. 0.5 is cardioid. 1.0 is dipole.

func (*PHASECardioidDirectivityModelSubbandParameters) SetFrequency

func (o *PHASECardioidDirectivityModelSubbandParameters) SetFrequency(frequency float64)

func (*PHASECardioidDirectivityModelSubbandParameters) SetPattern

func (*PHASECardioidDirectivityModelSubbandParameters) SetSharpness

func (o *PHASECardioidDirectivityModelSubbandParameters) SetSharpness(sharpness float64)

func (*PHASECardioidDirectivityModelSubbandParameters) Sharpness

@property sharpness @abstract The sharpness of the directivity pattern. @note Values are clamped to the range [1.0, DBL_MAX]. Default value is 1.0. Values > 1.0 increase sharpness.

type PHASEChannelMixerDefinition

type PHASEChannelMixerDefinition struct {
	PHASEMixerDefinition
}

An audio-layering object that routes sound directly to the device’s output.

Apple documentation: https://developer.apple.com/documentation/phase/phasechannelmixerdefinition

func PHASEChannelMixerDefinitionFromID

func PHASEChannelMixerDefinitionFromID(id objc.ID) *PHASEChannelMixerDefinition

func (*PHASEChannelMixerDefinition) InitWithChannelLayout

Creates a channel mixer with the given channel layout.

func (*PHASEChannelMixerDefinition) InitWithChannelLayoutIdentifier

func (o *PHASEChannelMixerDefinition) InitWithChannelLayoutIdentifier(layout *avfaudio.AVAudioChannelLayout, identifier *foundation.NSString) *PHASEChannelMixerDefinition

Creates a named channel mixer with the given channel layout.

func (*PHASEChannelMixerDefinition) InputChannelLayout

type PHASEConeDirectivityModelParameters

type PHASEConeDirectivityModelParameters struct {
	PHASEDirectivityModelParameters
}

An object that directs sound in a cone-shaped curve that extends from a sound source.

Apple documentation: https://developer.apple.com/documentation/phase/phaseconedirectivitymodelparameters

func PHASEConeDirectivityModelParametersFromID

func PHASEConeDirectivityModelParametersFromID(id objc.ID) *PHASEConeDirectivityModelParameters

func (*PHASEConeDirectivityModelParameters) InitWithSubbandParameters

Creates an object that directs sound in a cone-shaped curve that extends from a sound source.

func (*PHASEConeDirectivityModelParameters) SubbandParameters

type PHASEConeDirectivityModelSubbandParameters

type PHASEConeDirectivityModelSubbandParameters struct {
	foundation.NSObject
}

A data set that projects sound of a certain frequency outward in the shape of a cone.

Apple documentation: https://developer.apple.com/documentation/phase/phaseconedirectivitymodelsubbandparameters

func PHASEConeDirectivityModelSubbandParametersFromID

func PHASEConeDirectivityModelSubbandParametersFromID(id objc.ID) *PHASEConeDirectivityModelSubbandParameters

func (*PHASEConeDirectivityModelSubbandParameters) Frequency

@property frequency @abstract The frequency of the subband, in hertz. @note Default value is 1000.0.

func (*PHASEConeDirectivityModelSubbandParameters) Init

Creates a data set that projects sound of a certain frequency outward in the shape of a cone.

func (*PHASEConeDirectivityModelSubbandParameters) InnerAngle

@property innerAngle @abstract The inner angle, in degrees. @note Default value is 360.0.

func (*PHASEConeDirectivityModelSubbandParameters) OuterAngle

@property outerAngle @abstract The outer angle, in degrees. @note Default value is 360.0.

func (*PHASEConeDirectivityModelSubbandParameters) OuterGain

@property outerGain @abstract The outer gain. @note Values are clamped to the range [0.0, 1.0]. Default value is 1.0.

func (*PHASEConeDirectivityModelSubbandParameters) SetFrequency

func (o *PHASEConeDirectivityModelSubbandParameters) SetFrequency(frequency float64)

func (*PHASEConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle

func (o *PHASEConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle(innerAngle float64, outerAngle float64)

Configures a focus area for cone-based sound directivity.

func (*PHASEConeDirectivityModelSubbandParameters) SetOuterGain

func (o *PHASEConeDirectivityModelSubbandParameters) SetOuterGain(outerGain float64)

type PHASEContainerNodeDefinition

type PHASEContainerNodeDefinition struct {
	PHASESoundEventNodeDefinition
}

A node that plays all its children at the same time.

Apple documentation: https://developer.apple.com/documentation/phase/phasecontainernodedefinition

func PHASEContainerNodeDefinitionFromID

func PHASEContainerNodeDefinitionFromID(id objc.ID) *PHASEContainerNodeDefinition

func PHASEContainerNodeDefinitionNew

func PHASEContainerNodeDefinitionNew() *PHASEContainerNodeDefinition

Creates a container node.

func (*PHASEContainerNodeDefinition) AddSubtree

Adds a sound event node as a child.

func (*PHASEContainerNodeDefinition) Init

Creates a container node.

func (*PHASEContainerNodeDefinition) InitWithIdentifier

Creates a container node with the given name.

type PHASECullOption

type PHASECullOption int64

The actions the engine takes when it culls sound.

const (
	// An option that culls sound by stopping playback.
	PHASECullOptionTerminate PHASECullOption = 0
	// An option that pauses playback and resumes at the beginning.
	PHASECullOptionSleepWakeAtZero PHASECullOption = 1
	// An option that pauses playback and resumes at a random position.
	PHASECullOptionSleepWakeAtRandomOffset PHASECullOption = 2
	// An option that pauses playback and resumes where it left off.
	PHASECullOptionSleepWakeAtRealtimeOffset PHASECullOption = 3
	// An option that indicates the framework takes no action to cull sound.
	PHASECullOptionDoNotCull PHASECullOption = 4
)

func (PHASECullOption) String

func (e PHASECullOption) String() string

type PHASECurveType

type PHASECurveType int64

Options that apply a mathematical function to an input value.

const (
	// A curve that increases uniformly with its input.
	PHASECurveTypeLinear PHASECurveType = 1668435054
	// A curve that increases at a rate that squares its input.
	PHASECurveTypeSquared PHASECurveType = 1668436849
	// A curve that increases at a rate of one divided by the input’s square.
	PHASECurveTypeInverseSquared PHASECurveType = 1668434257
	// A curve that increases at a rate that cubes its input.
	PHASECurveTypeCubed PHASECurveType = 1668432757
	// A curve that increases at a rate of one divided by the input’s cube.
	PHASECurveTypeInverseCubed PHASECurveType = 1668434243
	// A sine curve.
	PHASECurveTypeSine PHASECurveType = 1668436846
	// An inverse sine curve.
	PHASECurveTypeInverseSine PHASECurveType = 1668434259
	// A sigmoid curve.
	PHASECurveTypeSigmoid PHASECurveType = 1668436839
	// An inverse sigmoid curve.
	PHASECurveTypeInverseSigmoid PHASECurveType = 1668434247
	// A curve that equals its start value for the entire duration.
	PHASECurveTypeHoldStartValue PHASECurveType = 1668434003
	// A curve that equals its end value for the entire duration.
	PHASECurveTypeJumpToEndValue PHASECurveType = 1668434501
)

func (PHASECurveType) String

func (e PHASECurveType) String() string

type PHASEDefinition

type PHASEDefinition struct {
	foundation.NSObject
}

A base class that adds a name to framework definitions.

Apple documentation: https://developer.apple.com/documentation/phase/phasedefinition

func PHASEDefinitionFromID

func PHASEDefinitionFromID(id objc.ID) *PHASEDefinition

func (*PHASEDefinition) Identifier

func (o *PHASEDefinition) Identifier() *foundation.NSString

type PHASEDirectivityModelParameters

type PHASEDirectivityModelParameters struct {
	foundation.NSObject
}

A base class for objects that direct sound.

Apple documentation: https://developer.apple.com/documentation/phase/phasedirectivitymodelparameters

func PHASEDirectivityModelParametersFromID

func PHASEDirectivityModelParametersFromID(id objc.ID) *PHASEDirectivityModelParameters

type PHASEDistanceModelFadeOutParameters

type PHASEDistanceModelFadeOutParameters struct {
	foundation.NSObject
}

A distance over which the framework fades out sound.

Apple documentation: https://developer.apple.com/documentation/phase/phasedistancemodelfadeoutparameters

func PHASEDistanceModelFadeOutParametersFromID

func PHASEDistanceModelFadeOutParametersFromID(id objc.ID) *PHASEDistanceModelFadeOutParameters

func (*PHASEDistanceModelFadeOutParameters) CullDistance

func (o *PHASEDistanceModelFadeOutParameters) CullDistance() float64

func (*PHASEDistanceModelFadeOutParameters) InitWithCullDistance

Creates a distance beyond which sound sources stop playing.

type PHASEDistanceModelParameters

type PHASEDistanceModelParameters struct {
	foundation.NSObject
}

A base class for a sound’s rate of change over distance.

Apple documentation: https://developer.apple.com/documentation/phase/phasedistancemodelparameters

func PHASEDistanceModelParametersFromID

func PHASEDistanceModelParametersFromID(id objc.ID) *PHASEDistanceModelParameters

func (*PHASEDistanceModelParameters) FadeOutParameters

func (*PHASEDistanceModelParameters) SetFadeOutParameters

func (o *PHASEDistanceModelParameters) SetFadeOutParameters(fadeOutParameters *PHASEDistanceModelFadeOutParameters)

type PHASEDucker

type PHASEDucker struct {
	foundation.NSObject
}

An object that manages competing sounds.

Apple documentation: https://developer.apple.com/documentation/phase/phaseducker

func PHASEDuckerFromID

func PHASEDuckerFromID(id objc.ID) *PHASEDucker

func (*PHASEDucker) Activate

func (o *PHASEDucker) Activate()

Instructs the ducker to begin altering sound.

func (*PHASEDucker) AttackCurve

func (o *PHASEDucker) AttackCurve() PHASECurveType

@property attackCurve @abstract The type of curve function to use during the attack phase of gain reduction.

func (*PHASEDucker) AttackTime

func (o *PHASEDucker) AttackTime() float64

@property attackTime @abstract The time for the attenuation gain to ramp into effect. @note The attack time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEDucker) Deactivate

func (o *PHASEDucker) Deactivate()

Stops the ducker from altering sound.

func (*PHASEDucker) Gain

func (o *PHASEDucker) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEDucker) Identifier

func (o *PHASEDucker) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this ducker.

func (*PHASEDucker) InitWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve

func (o *PHASEDucker) InitWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve(engine *PHASEEngine, sourceGroups *foundation.NSSet[*PHASEGroup], targetGroups *foundation.NSSet[*PHASEGroup], gain float64, attackTime float64, releaseTime float64, attackCurve PHASECurveType, releaseCurve PHASECurveType) *PHASEDucker

Creates an object that manages competing sounds.

func (*PHASEDucker) IsActive

func (o *PHASEDucker) IsActive() bool

@property active @abstract YES if the ducker is active; otherwise, NO.

func (*PHASEDucker) ReleaseCurve

func (o *PHASEDucker) ReleaseCurve() PHASECurveType

@property releaseCurve @abstract The type of curve function to use during the release phase of gain reduction.

func (*PHASEDucker) ReleaseTime

func (o *PHASEDucker) ReleaseTime() float64

@property releaseTime @abstract The time for the ducked sounds to ramp back to their original level. @note The release time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEDucker) SourceGroups

func (o *PHASEDucker) SourceGroups() *foundation.NSSet[*PHASEGroup]

@property sourceGroups @abstract The source groups that will trigger the ducker when a sound in one of the source groups starts playback.

func (*PHASEDucker) TargetGroups

func (o *PHASEDucker) TargetGroups() *foundation.NSSet[*PHASEGroup]

@property targetGroups @abstract The target groups that will be ducked when a sound in one of the source groups triggers the ducker.

type PHASEEngine

type PHASEEngine struct {
	foundation.NSObject
}

An object that manages audio assets, controls playback, and configures environmental effects.

Apple documentation: https://developer.apple.com/documentation/phase/phaseengine

func PHASEEngineFromID

func PHASEEngineFromID(id objc.ID) *PHASEEngine

func (*PHASEEngine) ActiveGroupPreset

func (o *PHASEEngine) ActiveGroupPreset() *PHASEGroupPreset

@property activeGroupPreset @abstract The active group mixer preset in the system @discussion Returns nil if there are no active group presets in the engine. Activate or Deactivate the preset via [PHASEGroupPreset activate] and [PHASEGroupPreset deactivate]

func (*PHASEEngine) AssetRegistry

func (o *PHASEEngine) AssetRegistry() *PHASEAssetRegistry

@property assetRegistry @abstract A registry for assets available to the engine

func (*PHASEEngine) DefaultMedium

func (o *PHASEEngine) DefaultMedium() *PHASEMedium

@property defaultMedium @abstract The default medium in the engine. @discussion The default value is PHASEMediumPresetAir.

func (*PHASEEngine) DefaultReverbPreset

func (o *PHASEEngine) DefaultReverbPreset() PHASEReverbPreset

@property defaultReverbPreset @abstract The default reverb preset in the engine. @discussion The default value is PHASEReverbPresetNone.

func (*PHASEEngine) Duckers

func (o *PHASEEngine) Duckers() *foundation.NSArray[*PHASEDucker]

@property duckers @abstract An array of the ducker objects in the system @discussion Returns a dictionary of the ducker objects at the time it is retrieved.

func (*PHASEEngine) Groups

@property groups @abstract A dictionary of the groups in the system @discussion Returns a dictionary of the groups at the time it is retrieved.

func (*PHASEEngine) InitWithUpdateMode

func (o *PHASEEngine) InitWithUpdateMode(updateMode PHASEUpdateMode) *PHASEEngine

Creates an engine updated by the app or framework.

func (*PHASEEngine) LastRenderTime

func (o *PHASEEngine) LastRenderTime() *avfaudio.AVAudioTime

@property lastRenderTime @abstract Obtain the time for which the engine most recently rendered. @discussion Will return nil if the engine is not running

func (*PHASEEngine) OutputSpatializationMode

func (o *PHASEEngine) OutputSpatializationMode() PHASESpatializationMode

@property outputSpatializationMode @discussion When set to a value other than PHASESpatializationModeAutomatic, overrides the default output spatializer and uses the specified one instead.

func (*PHASEEngine) Pause

func (o *PHASEEngine) Pause()

Pauses all audio playback.

func (*PHASEEngine) RenderingState

func (o *PHASEEngine) RenderingState() PHASERenderingState

@property renderingState @abstract The engine's current rendering state.

func (*PHASEEngine) RootObject

func (o *PHASEEngine) RootObject() *PHASEObject

@property rootObject @abstract The root object of the engine's scene graph. @discussion Attach objects to the engine's rootObject or one of its children to make them active within the engine's scene graph. This will ensure they take part in the simulation. @note The rootObject is created and owned by the engine. The rootObject may not be set as the child of another object. This will cause an error to be thrown. The rootObject's transform may not be changed. This will cause an error to be thrown. The rootObject may not be copied. This will cause an error to be thrown.

func (*PHASEEngine) SetDefaultMedium

func (o *PHASEEngine) SetDefaultMedium(defaultMedium *PHASEMedium)

func (*PHASEEngine) SetDefaultReverbPreset

func (o *PHASEEngine) SetDefaultReverbPreset(defaultReverbPreset PHASEReverbPreset)

func (*PHASEEngine) SetOutputSpatializationMode

func (o *PHASEEngine) SetOutputSpatializationMode(outputSpatializationMode PHASESpatializationMode)

func (*PHASEEngine) SetUnitsPerMeter

func (o *PHASEEngine) SetUnitsPerMeter(unitsPerMeter float64)

func (*PHASEEngine) SetUnitsPerSecond

func (o *PHASEEngine) SetUnitsPerSecond(unitsPerSecond float64)

func (*PHASEEngine) SoundEvents

func (o *PHASEEngine) SoundEvents() *foundation.NSArray[*PHASESoundEvent]

@property soundEvents @abstract An array of the active sound event objects in the system @discussion Returns a dictionary of the sound events at the time it is retrieved. This includes all sound events that are registered with the engine, including those that are preparing, playing, paused or stopping.

func (*PHASEEngine) StartAndReturnError

func (o *PHASEEngine) StartAndReturnError() (bool, error)

Starts or resumes all audio playback.

func (*PHASEEngine) Stop

func (o *PHASEEngine) Stop()

Stops all audio playback.

func (*PHASEEngine) UnitsPerMeter

func (o *PHASEEngine) UnitsPerMeter() float64

@property unitsPerMeter @abstract The number of units in a meter. @discussion The unitsPerMeter is used internally to scale metric values passed to the API. This allows clients to pass metric values in their own native spatial scale. @note Values are clamped to the range (0, inf]. Default value is 1.

func (*PHASEEngine) UnitsPerSecond

func (o *PHASEEngine) UnitsPerSecond() float64

@property unitsPerSecond @abstract The number of units in a second. @discussion The unitsPerSecond is used internally to scale time/duration values passed to the API. This allows clients to pass time/duration values in their own native time scale. @note Values are clamped to the range (0, inf]. Default value is 1.

func (*PHASEEngine) Update

func (o *PHASEEngine) Update()

Processes app commands and increments framework processing.

type PHASEEnvelope

type PHASEEnvelope struct {
	foundation.NSObject
}

A collection of segments that connect to graph a complex curve over a linear input.

Apple documentation: https://developer.apple.com/documentation/phase/phaseenvelope

func PHASEEnvelopeFromID

func PHASEEnvelopeFromID(id objc.ID) *PHASEEnvelope

func (*PHASEEnvelope) Domain

func (o *PHASEEnvelope) Domain() *PHASENumericPair

@property domain @abstract The domain (along the x-axis). @discussion The first value in the pair is the minimum value of the domain. The second value in the pair is the maximum value of the domain.

func (*PHASEEnvelope) EvaluateForValue

func (o *PHASEEnvelope) EvaluateForValue(x float64) float64

Provides the height of the envelope for an input value.

func (*PHASEEnvelope) InitWithStartPointSegments

func (o *PHASEEnvelope) InitWithStartPointSegments(startPoint unsafe.Pointer, segments *foundation.NSArray[*PHASEEnvelopeSegment]) *PHASEEnvelope

Creates an envelope with a start point and segments.

func (*PHASEEnvelope) Range

func (o *PHASEEnvelope) Range() *PHASENumericPair

@property range @abstract The range (along the y-axis). @discussion The first value in the pair is the minimum value of the range. The second value in the pair is the maximum value of the range.

func (*PHASEEnvelope) Segments

@property segments @abstract The segments of the envelope.

func (*PHASEEnvelope) StartPoint

func (o *PHASEEnvelope) StartPoint() unsafe.Pointer

@property startPoint @abstract The start point of the envelope.

type PHASEEnvelopeDistanceModelParameters

type PHASEEnvelopeDistanceModelParameters struct {
	PHASEDistanceModelParameters
}

A graph of points and curves that shapes the volume of a sound over distance.

Apple documentation: https://developer.apple.com/documentation/phase/phaseenvelopedistancemodelparameters

func PHASEEnvelopeDistanceModelParametersFromID

func PHASEEnvelopeDistanceModelParametersFromID(id objc.ID) *PHASEEnvelopeDistanceModelParameters

func (*PHASEEnvelopeDistanceModelParameters) Envelope

func (*PHASEEnvelopeDistanceModelParameters) InitWithEnvelope

Creates the distance model parameters with an envelope.

type PHASEEnvelopeSegment

type PHASEEnvelopeSegment struct {
	foundation.NSObject
}

A curved portion of an envelope.

Apple documentation: https://developer.apple.com/documentation/phase/phaseenvelopesegment

func PHASEEnvelopeSegmentFromID

func PHASEEnvelopeSegmentFromID(id objc.ID) *PHASEEnvelopeSegment

func (*PHASEEnvelopeSegment) CurveType

func (o *PHASEEnvelopeSegment) CurveType() PHASECurveType

@property curveType @abstract The curve type of the envelope segment. @discussion The default value is PHASECurveTypeLinear.

func (*PHASEEnvelopeSegment) EndPoint

func (o *PHASEEnvelopeSegment) EndPoint() unsafe.Pointer

@property endPoint @abstract The end point of the envelope segment. @discussion The default value is [0.0, 0.0].

func (*PHASEEnvelopeSegment) InitWithEndPointCurveType

func (o *PHASEEnvelopeSegment) InitWithEndPointCurveType(endPoint unsafe.Pointer, curveType PHASECurveType) *PHASEEnvelopeSegment

Creates a curved portion of an envelope.

func (*PHASEEnvelopeSegment) SetCurveType

func (o *PHASEEnvelopeSegment) SetCurveType(curveType PHASECurveType)

func (*PHASEEnvelopeSegment) SetEndPoint

func (o *PHASEEnvelopeSegment) SetEndPoint(endPoint unsafe.Pointer)

type PHASEError

type PHASEError int64

An error that PHASE reports.

const (
	PHASEErrorInitializeFailed PHASEError = 1346913633
	PHASEErrorInvalidObject    PHASEError = 1346913634
)

func (PHASEError) String

func (e PHASEError) String() string

type PHASEGeneratorNodeDefinition

type PHASEGeneratorNodeDefinition struct {
	PHASESoundEventNodeDefinition
}

A base class for nodes that provide audio data to generate sound.

Apple documentation: https://developer.apple.com/documentation/phase/phasegeneratornodedefinition

func PHASEGeneratorNodeDefinitionFromID

func PHASEGeneratorNodeDefinitionFromID(id objc.ID) *PHASEGeneratorNodeDefinition

func (*PHASEGeneratorNodeDefinition) CalibrationMode

@property calibrationMode @abstract The generator's calibration mode. The default value is PHASECalibrationModeNone.

func (*PHASEGeneratorNodeDefinition) GainMetaParameterDefinition

func (o *PHASEGeneratorNodeDefinition) GainMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property gainMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable dynamic control of the gain during playback.

func (*PHASEGeneratorNodeDefinition) Group

@property group @abstract The PHASEGroup object this generator should be associated with for gain and rate control.

func (*PHASEGeneratorNodeDefinition) Level

@property level @abstract The generator's level. The default value is 1. @note The level's underlying unit and range are dependent on the calibrationMode.

func (*PHASEGeneratorNodeDefinition) MixerDefinition

func (o *PHASEGeneratorNodeDefinition) MixerDefinition() *PHASEMixerDefinition

@property mixerDefinition @abstract The readonly property that returns the PHASEMixerDefinition this generator was created with and assigned to.

func (*PHASEGeneratorNodeDefinition) Rate

@property rate @abstract Linear rate scalar. @note Values are clamped to the range [0.25, 4]. Default value is 1.

func (*PHASEGeneratorNodeDefinition) RateMetaParameterDefinition

func (o *PHASEGeneratorNodeDefinition) RateMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property rateMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable dynamic control of the rate during playback.

func (*PHASEGeneratorNodeDefinition) SetCalibrationModeLevel

func (o *PHASEGeneratorNodeDefinition) SetCalibrationModeLevel(calibrationMode PHASECalibrationMode, level float64)

Selects a loudness correction strategy and reference level.

func (*PHASEGeneratorNodeDefinition) SetGainMetaParameterDefinition

func (o *PHASEGeneratorNodeDefinition) SetGainMetaParameterDefinition(gainMetaParameterDefinition *PHASENumberMetaParameterDefinition)

func (*PHASEGeneratorNodeDefinition) SetGroup

func (o *PHASEGeneratorNodeDefinition) SetGroup(group *PHASEGroup)

func (*PHASEGeneratorNodeDefinition) SetRate

func (o *PHASEGeneratorNodeDefinition) SetRate(rate float64)

func (*PHASEGeneratorNodeDefinition) SetRateMetaParameterDefinition

func (o *PHASEGeneratorNodeDefinition) SetRateMetaParameterDefinition(rateMetaParameterDefinition *PHASENumberMetaParameterDefinition)

type PHASEGeometricSpreadingDistanceModelParameters

type PHASEGeometricSpreadingDistanceModelParameters struct {
	PHASEDistanceModelParameters
}

An object that dissipates sound frequencies over distance.

Apple documentation: https://developer.apple.com/documentation/phase/phasegeometricspreadingdistancemodelparameters

func PHASEGeometricSpreadingDistanceModelParametersFromID

func PHASEGeometricSpreadingDistanceModelParametersFromID(id objc.ID) *PHASEGeometricSpreadingDistanceModelParameters

func (*PHASEGeometricSpreadingDistanceModelParameters) Init

Creates the geometric spreading distance model parameters.

func (*PHASEGeometricSpreadingDistanceModelParameters) RolloffFactor

func (*PHASEGeometricSpreadingDistanceModelParameters) SetRolloffFactor

func (o *PHASEGeometricSpreadingDistanceModelParameters) SetRolloffFactor(rolloffFactor float64)

type PHASEGlobalMetaParameterAsset

type PHASEGlobalMetaParameterAsset struct {
	PHASEAsset
}

A reference to a registered metaparameter that the app can share with multiple sound events or sources.

Apple documentation: https://developer.apple.com/documentation/phase/phaseglobalmetaparameterasset

func PHASEGlobalMetaParameterAssetFromID

func PHASEGlobalMetaParameterAssetFromID(id objc.ID) *PHASEGlobalMetaParameterAsset

type PHASEGroup

type PHASEGroup struct {
	foundation.NSObject
}

A container that shares audio parameters with a collection of sounds.

Apple documentation: https://developer.apple.com/documentation/phase/phasegroup

func PHASEGroupFromID

func PHASEGroupFromID(id objc.ID) *PHASEGroup

func (*PHASEGroup) FadeGainDurationCurveType

func (o *PHASEGroup) FadeGainDurationCurveType(gain float64, duration float64, curveType PHASECurveType)

Adjusts the volume of the sounds in a group gradually.

func (*PHASEGroup) FadeRateDurationCurveType

func (o *PHASEGroup) FadeRateDurationCurveType(rate float64, duration float64, curveType PHASECurveType)

Adjusts the playback speed of the sounds in a group gradually.

func (*PHASEGroup) Gain

func (o *PHASEGroup) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEGroup) Identifier

func (o *PHASEGroup) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this group.

func (*PHASEGroup) InitWithIdentifier

func (o *PHASEGroup) InitWithIdentifier(identifier *foundation.NSString) *PHASEGroup

Creates a group with a unique name.

func (*PHASEGroup) IsMuted

func (o *PHASEGroup) IsMuted() bool

@property muted @abstract Whether or not this group is muted.

func (*PHASEGroup) IsSoloed

func (o *PHASEGroup) IsSoloed() bool

@property soloed @abstract Whether or not this group is soloed.

func (*PHASEGroup) Mute

func (o *PHASEGroup) Mute()

Silences the group.

func (*PHASEGroup) Rate

func (o *PHASEGroup) Rate() float64

@property rate @abstract Linear rate scalar. @note Values are clamped to the range [0.25, 4]. Default value is 1.

func (*PHASEGroup) RegisterWithEngine

func (o *PHASEGroup) RegisterWithEngine(engine *PHASEEngine)

Adds the group to the engine’s dictionary.

func (*PHASEGroup) SetGain

func (o *PHASEGroup) SetGain(gain float64)

func (*PHASEGroup) SetRate

func (o *PHASEGroup) SetRate(rate float64)

func (*PHASEGroup) Solo

func (o *PHASEGroup) Solo()

Silences all other groups.

func (*PHASEGroup) Unmute

func (o *PHASEGroup) Unmute()

Restores the group’s volume.

func (*PHASEGroup) UnregisterFromEngine

func (o *PHASEGroup) UnregisterFromEngine()

Removes the group from the engine’s dictionary.

func (*PHASEGroup) Unsolo

func (o *PHASEGroup) Unsolo()

Restores the other groups’ volume.

type PHASEGroupPreset

type PHASEGroupPreset struct {
	foundation.NSObject
}

A collection of settings for groups.

Apple documentation: https://developer.apple.com/documentation/phase/phasegrouppreset

func PHASEGroupPresetFromID

func PHASEGroupPresetFromID(id objc.ID) *PHASEGroupPreset

func (*PHASEGroupPreset) Activate

func (o *PHASEGroupPreset) Activate()

Applies settings to the designated groups.

func (*PHASEGroupPreset) ActivateWithTimeToTargetOverride

func (o *PHASEGroupPreset) ActivateWithTimeToTargetOverride(timeToTargetOverride float64)

Applies settings with an overriden fade duration.

func (*PHASEGroupPreset) Deactivate

func (o *PHASEGroupPreset) Deactivate()

Reverts settings for the preset’s groups.

func (*PHASEGroupPreset) DeactivateWithTimeToResetOverride

func (o *PHASEGroupPreset) DeactivateWithTimeToResetOverride(timeToResetOverride float64)

Reverts settings for the preset’s groups using a timed adjustment.

func (*PHASEGroupPreset) InitWithEngineSettingsTimeToTargetTimeToReset

func (o *PHASEGroupPreset) InitWithEngineSettingsTimeToTargetTimeToReset(engine *PHASEEngine, settings *foundation.NSDictionary[*foundation.NSString, *PHASEGroupPresetSetting], timeToTarget float64, timeToReset float64) *PHASEGroupPreset

Creates a group preset with the designated engine, settings, and fade parameters.

func (*PHASEGroupPreset) Settings

@property settings @abstract The collection of PHASEGroupPresetSetting objects to apply when this preset is activated.

func (*PHASEGroupPreset) TimeToReset

func (o *PHASEGroupPreset) TimeToReset() float64

@property timeToReset @abstract The time interval that all group settings in this preset will take to gradually fade to the unity value @note The timeToReset is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPreset) TimeToTarget

func (o *PHASEGroupPreset) TimeToTarget() float64

@property timeToTarget @abstract The time interval that all group settings in this preset will take to gradually fade to the new value @note The timeToTarget is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

type PHASEGroupPresetSetting

type PHASEGroupPresetSetting struct {
	foundation.NSObject
}

Settings for group presets.

Apple documentation: https://developer.apple.com/documentation/phase/phasegrouppresetsetting

func PHASEGroupPresetSettingFromID

func PHASEGroupPresetSettingFromID(id objc.ID) *PHASEGroupPresetSetting

func (*PHASEGroupPresetSetting) Gain

func (o *PHASEGroupPresetSetting) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEGroupPresetSetting) GainCurveType

func (o *PHASEGroupPresetSetting) GainCurveType() PHASECurveType

@property gainCurveType @abstract The type of curve to apply to the gain as the preset changes to this new setting.

func (*PHASEGroupPresetSetting) InitWithGainRateGainCurveTypeRateCurveType

func (o *PHASEGroupPresetSetting) InitWithGainRateGainCurveTypeRateCurveType(gain float64, rate float64, gainCurveType PHASECurveType, rateCurveType PHASECurveType) *PHASEGroupPresetSetting

Creates a group preset setting.

func (*PHASEGroupPresetSetting) Rate

func (o *PHASEGroupPresetSetting) Rate() float64

@property rate @abstract Linear rate scalar.

func (*PHASEGroupPresetSetting) RateCurveType

func (o *PHASEGroupPresetSetting) RateCurveType() PHASECurveType

@property rateCurveType @abstract The type of curve to apply to the rate as the preset changes to this new setting.

type PHASEListener

type PHASEListener struct {
	PHASEObject
}

A central point of reference that defines the location within the scene that’s most audible to the user.

Apple documentation: https://developer.apple.com/documentation/phase/phaselistener

func PHASEListenerFromID

func PHASEListenerFromID(id objc.ID) *PHASEListener

func (*PHASEListener) AutomaticHeadTrackingFlags

func (o *PHASEListener) AutomaticHeadTrackingFlags() PHASEAutomaticHeadTrackingFlags

@property automaticHeadTrackingFlags @abstract A combination of flags to express automatic headtracking behaviors for this listener.

func (*PHASEListener) Gain

func (o *PHASEListener) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEListener) InitWithEngine

func (o *PHASEListener) InitWithEngine(engine *PHASEEngine) *PHASEListener

Creates a listener with the given engine.

func (*PHASEListener) SetAutomaticHeadTrackingFlags

func (o *PHASEListener) SetAutomaticHeadTrackingFlags(automaticHeadTrackingFlags PHASEAutomaticHeadTrackingFlags)

@property automaticHeadTrackingFlags @abstract A combination of flags to express automatic headtracking behaviors for this listener.

func (*PHASEListener) SetGain

func (o *PHASEListener) SetGain(gain float64)

type PHASEMappedMetaParameterDefinition

type PHASEMappedMetaParameterDefinition struct {
	PHASENumberMetaParameterDefinition
}

A metaparameter that graphs an input value on a set of mathematical curves.

Apple documentation: https://developer.apple.com/documentation/phase/phasemappedmetaparameterdefinition

func PHASEMappedMetaParameterDefinitionFromID

func PHASEMappedMetaParameterDefinitionFromID(id objc.ID) *PHASEMappedMetaParameterDefinition

func (*PHASEMappedMetaParameterDefinition) Envelope

@property envelope @abstract An Envelope to define segments of curves

func (*PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelope

func (o *PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelope(inputMetaParameterDefinition *PHASENumberMetaParameterDefinition, envelope *PHASEEnvelope) *PHASEMappedMetaParameterDefinition

Creates a specification for a metaparameter that the app plots on a graph defined by the given set of curves.

func (*PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelopeIdentifier

func (o *PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelopeIdentifier(inputMetaParameterDefinition *PHASENumberMetaParameterDefinition, envelope *PHASEEnvelope, identifier *foundation.NSString) *PHASEMappedMetaParameterDefinition

Creates a specification for a named metaparameter that the app plots on a graph defined by the given set of curves.

func (*PHASEMappedMetaParameterDefinition) InputMetaParameterDefinition

@property inputMetaParameterDefinition @abstract The readonly PHASENumberMetaParameterDefinition that this metaparameter definition was initialized with

type PHASEMaterial

type PHASEMaterial struct {
	foundation.NSObject
}

Surface characteristics that determine the acoustic properties of an object.

Apple documentation: https://developer.apple.com/documentation/phase/phasematerial

func PHASEMaterialFromID

func PHASEMaterialFromID(id objc.ID) *PHASEMaterial

func (*PHASEMaterial) InitWithEnginePreset

func (o *PHASEMaterial) InitWithEnginePreset(engine *PHASEEngine, preset PHASEMaterialPreset) *PHASEMaterial

Creates a material with the given preset.

type PHASEMaterialPreset

type PHASEMaterialPreset int64

A collection of physical surfaces that each add a unique acoustic quality to your app’s audio.

const (
	// A surface characteristic that produces the acoustic quality of cardboard.
	PHASEMaterialPresetCardboard PHASEMaterialPreset = 1833136740
	// A surface characteristic that produces the acoustic quality of glass.
	PHASEMaterialPresetGlass PHASEMaterialPreset = 1833397363
	// A surface characteristic that produces the acoustic quality of brick.
	PHASEMaterialPresetBrick PHASEMaterialPreset = 1833071211
	// A surface characteristic that produces the acoustic quality of concrete.
	PHASEMaterialPresetConcrete PHASEMaterialPreset = 1833132914
	// A surface characteristic that produces the acoustic quality of drywall.
	PHASEMaterialPresetDrywall PHASEMaterialPreset = 1833202295
	// A surface characteristic that produces the acoustic quality of wood.
	PHASEMaterialPresetWood PHASEMaterialPreset = 1834448228
)

func (PHASEMaterialPreset) String

func (e PHASEMaterialPreset) String() string

type PHASEMedium

type PHASEMedium struct {
	foundation.NSObject
}

A property or quality of the environment that affects how sound travels.

Apple documentation: https://developer.apple.com/documentation/phase/phasemedium

func PHASEMediumFromID

func PHASEMediumFromID(id objc.ID) *PHASEMedium

func (*PHASEMedium) InitWithEnginePreset

func (o *PHASEMedium) InitWithEnginePreset(engine *PHASEEngine, preset PHASEMediumPreset) *PHASEMedium

Creates a medium.

type PHASEMediumPreset

type PHASEMediumPreset int64

Predetermined qualities of an environment that affect how sound transmits.

const (
	PHASEMediumPresetAir PHASEMediumPreset = 1835286898
)

func (PHASEMediumPreset) String

func (e PHASEMediumPreset) String() string

type PHASEMetaParameter

type PHASEMetaParameter struct {
	foundation.NSObject
}

A named parameter with a value that the app can change over time.

Apple documentation: https://developer.apple.com/documentation/phase/phasemetaparameter

func PHASEMetaParameterFromID

func PHASEMetaParameterFromID(id objc.ID) *PHASEMetaParameter

func (*PHASEMetaParameter) Identifier

func (o *PHASEMetaParameter) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this metaparameter.

func (*PHASEMetaParameter) SetValue

func (o *PHASEMetaParameter) SetValue(value objc.ID)

func (*PHASEMetaParameter) Value

func (o *PHASEMetaParameter) Value() objc.ID

@property value @abstract The value of this metaparameter

type PHASEMetaParameterDefinition

type PHASEMetaParameterDefinition struct {
	PHASEDefinition
}

A specification for a named parameter with a constant value.

Apple documentation: https://developer.apple.com/documentation/phase/phasemetaparameterdefinition

func PHASEMetaParameterDefinitionFromID

func PHASEMetaParameterDefinitionFromID(id objc.ID) *PHASEMetaParameterDefinition

func (*PHASEMetaParameterDefinition) Value

type PHASEMixer

type PHASEMixer struct {
	foundation.NSObject
}

An object that combines multiple audio signals into a single signal.

Apple documentation: https://developer.apple.com/documentation/phase/phasemixer

func PHASEMixerFromID

func PHASEMixerFromID(id objc.ID) *PHASEMixer

func (*PHASEMixer) Gain

func (o *PHASEMixer) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEMixer) GainMetaParameter

func (o *PHASEMixer) GainMetaParameter() *PHASEMetaParameter

@property gainMetaParameter @abstract The metaparameter that can be used to adjust the gain during playback

func (*PHASEMixer) Identifier

func (o *PHASEMixer) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this mixer.

type PHASEMixerDefinition

type PHASEMixerDefinition struct {
	PHASEDefinition
}

An object to initialize a mixer with a given configuration.

Apple documentation: https://developer.apple.com/documentation/phase/phasemixerdefinition

func PHASEMixerDefinitionFromID

func PHASEMixerDefinitionFromID(id objc.ID) *PHASEMixerDefinition

func (*PHASEMixerDefinition) Gain

func (o *PHASEMixerDefinition) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEMixerDefinition) GainMetaParameterDefinition

func (o *PHASEMixerDefinition) GainMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property gainMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable real-time control of the gain during playback.

func (*PHASEMixerDefinition) SetGain

func (o *PHASEMixerDefinition) SetGain(gain float64)

func (*PHASEMixerDefinition) SetGainMetaParameterDefinition

func (o *PHASEMixerDefinition) SetGainMetaParameterDefinition(gainMetaParameterDefinition *PHASENumberMetaParameterDefinition)

type PHASEMixerParameters

type PHASEMixerParameters struct {
	foundation.NSObject
}

An object that specifies a mixer for sound events and orients them in 3D space.

Apple documentation: https://developer.apple.com/documentation/phase/phasemixerparameters

func PHASEMixerParametersFromID

func PHASEMixerParametersFromID(id objc.ID) *PHASEMixerParameters

func (*PHASEMixerParameters) AddAmbientMixerParametersWithIdentifierListener

func (o *PHASEMixerParameters) AddAmbientMixerParametersWithIdentifierListener(identifier *foundation.NSString, listener *PHASEListener)

Adds runtime parameters for an ambient mixer.

func (*PHASEMixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener

func (o *PHASEMixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener(identifier *foundation.NSString, source *PHASESource, listener *PHASEListener)

Adds runtime parameters for a spatial mixer.

type PHASENormalizationMode

type PHASENormalizationMode int64

Options that determine whether the framework adjusts a sound asset’s loudness for the user’s output device.

const (
	// A mode that instructs the framework not to adjust a sound’s volume according to the user’s output device.
	PHASENormalizationModeNone PHASENormalizationMode = 0
	// A mode that instructs the framework to adjust a sound’s volume according to the user’s output device.
	PHASENormalizationModeDynamic PHASENormalizationMode = 1
)

func (PHASENormalizationMode) String

func (e PHASENormalizationMode) String() string

type PHASENumberMetaParameter

type PHASENumberMetaParameter struct {
	PHASEMetaParameter
}

A metaparameter defined by a number that can change over time.

Apple documentation: https://developer.apple.com/documentation/phase/phasenumbermetaparameter

func PHASENumberMetaParameterFromID

func PHASENumberMetaParameterFromID(id objc.ID) *PHASENumberMetaParameter

func (*PHASENumberMetaParameter) FadeToValueDuration

func (o *PHASENumberMetaParameter) FadeToValueDuration(value float64, duration float64)

Sets the value gradually over the given amount of time.

func (*PHASENumberMetaParameter) Maximum

func (o *PHASENumberMetaParameter) Maximum() float64

@property maximum @abstract The maximum value this metaparameter can be set to

func (*PHASENumberMetaParameter) Minimum

func (o *PHASENumberMetaParameter) Minimum() float64

@property minimum @abstract The minimum value this metaparameter can be set to

type PHASENumberMetaParameterDefinition

type PHASENumberMetaParameterDefinition struct {
	PHASEMetaParameterDefinition
}

A specification for a metaparameter defined by a number.

Apple documentation: https://developer.apple.com/documentation/phase/phasenumbermetaparameterdefinition

func PHASENumberMetaParameterDefinitionFromID

func PHASENumberMetaParameterDefinitionFromID(id objc.ID) *PHASENumberMetaParameterDefinition

func (*PHASENumberMetaParameterDefinition) InitWithValue

Creates a specification for a metaparameter with the given numeric value.

func (*PHASENumberMetaParameterDefinition) InitWithValueIdentifier

Creates a specification for a named metaparameter with the given numeric value.

func (*PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximum

func (o *PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximum(value float64, minimum float64, maximum float64) *PHASENumberMetaParameterDefinition

Creates a specification for a metaparameter with the given numeric value and range.

func (*PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximumIdentifier

func (o *PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximumIdentifier(value float64, minimum float64, maximum float64, identifier *foundation.NSString) *PHASENumberMetaParameterDefinition

Creates a specification for a named metaparameter with the given numeric value and range.

func (*PHASENumberMetaParameterDefinition) Maximum

@property maximum @abstract The readonly maximum that this metaparameter definition was initialized with

func (*PHASENumberMetaParameterDefinition) Minimum

@property minimum @abstract The readonly minimum that this metaparameter definition was initialized with

type PHASENumericPair

type PHASENumericPair struct {
	foundation.NSObject
}

An ordered pair that defines a bounding box for an envelope.

Apple documentation: https://developer.apple.com/documentation/phase/phasenumericpair

func PHASENumericPairFromID

func PHASENumericPairFromID(id objc.ID) *PHASENumericPair

func (*PHASENumericPair) First

func (o *PHASENumericPair) First() float64

@property first @abstract The first value in the numeric pair. @discussion The default value is 0.0.

func (*PHASENumericPair) InitWithFirstValueSecondValue

func (o *PHASENumericPair) InitWithFirstValueSecondValue(first float64, second float64) *PHASENumericPair

Creates a pair of numbers with the given values.

func (*PHASENumericPair) Second

func (o *PHASENumericPair) Second() float64

@property second @abstract The second value in the numeric pair. @discussion The default value is 0.0.

func (*PHASENumericPair) SetFirst

func (o *PHASENumericPair) SetFirst(first float64)

func (*PHASENumericPair) SetSecond

func (o *PHASENumericPair) SetSecond(second float64)

type PHASEObject

type PHASEObject struct {
	foundation.NSObject
}

An object in the scene.

Apple documentation: https://developer.apple.com/documentation/phase/phaseobject

func PHASEObjectFromID

func PHASEObjectFromID(id objc.ID) *PHASEObject

func (*PHASEObject) AddChildError

func (o *PHASEObject) AddChildError(child *PHASEObject) (bool, error)

Adds the given object as a child.

func (*PHASEObject) Children

func (o *PHASEObject) Children() *foundation.NSArray[*PHASEObject]

@property children @abstract The children of this object.

func (*PHASEObject) InitWithEngine

func (o *PHASEObject) InitWithEngine(engine *PHASEEngine) *PHASEObject

Creates an object in the scene.

func (*PHASEObject) Parent

func (o *PHASEObject) Parent() *PHASEObject

@property parent @abstract The parent of this object, or nil if this object doesn't have a parent object.

func (*PHASEObject) RemoveChild

func (o *PHASEObject) RemoveChild(child *PHASEObject)

Removes the given object as a child.

func (*PHASEObject) RemoveChildren

func (o *PHASEObject) RemoveChildren()

Removes all child objects from the given object.

func (*PHASEObject) SetTransform

func (o *PHASEObject) SetTransform(transform unsafe.Pointer)

func (*PHASEObject) SetWorldTransform

func (o *PHASEObject) SetWorldTransform(worldTransform unsafe.Pointer)

func (*PHASEObject) Transform

func (o *PHASEObject) Transform() unsafe.Pointer

@property transform @abstract The object's transform. @note The transform must have orthogonal basis vectors and uniform scale.

func (*PHASEObject) WorldTransform

func (o *PHASEObject) WorldTransform() unsafe.Pointer

@property worldTransform @abstract The world transform applied to the object. @note The transform must have orthogonal basis vectors and uniform scale.

type PHASEOccluder

type PHASEOccluder struct {
	PHASEObject
}

An object with a shape and position that blocks audio from reaching the listener.

Apple documentation: https://developer.apple.com/documentation/phase/phaseoccluder

func PHASEOccluderFromID

func PHASEOccluderFromID(id objc.ID) *PHASEOccluder

func (*PHASEOccluder) InitWithEngineShapes

func (o *PHASEOccluder) InitWithEngineShapes(engine *PHASEEngine, shapes *foundation.NSArray[*PHASEShape]) *PHASEOccluder

Creates an occluder with the given engine and shapes.

func (*PHASEOccluder) Shapes

func (o *PHASEOccluder) Shapes() *foundation.NSArray[*PHASEShape]

type PHASEPlaybackMode

type PHASEPlaybackMode int64

Loop options for audio playback.

const (
	// An option that plays a sound only once.
	PHASEPlaybackModeOneShot PHASEPlaybackMode = 0
	// An option that restarts a sound from the begining after it finishes.
	PHASEPlaybackModeLooping PHASEPlaybackMode = 1
)

func (PHASEPlaybackMode) String

func (e PHASEPlaybackMode) String() string

type PHASEPullStreamNode

type PHASEPullStreamNode struct {
	PHASEStreamNode
}

Apple documentation: https://developer.apple.com/documentation/phase/phasepullstreamnode

func PHASEPullStreamNodeFromID

func PHASEPullStreamNodeFromID(id objc.ID) *PHASEPullStreamNode

func (*PHASEPullStreamNode) RenderBlock

func (o *PHASEPullStreamNode) RenderBlock() objc.Block

func (*PHASEPullStreamNode) SetRenderBlock

type PHASEPullStreamNodeDefinition

type PHASEPullStreamNodeDefinition struct {
	PHASEGeneratorNodeDefinition
}

Apple documentation: https://developer.apple.com/documentation/phase/phasepullstreamnodedefinition

func PHASEPullStreamNodeDefinitionFromID

func PHASEPullStreamNodeDefinitionFromID(id objc.ID) *PHASEPullStreamNodeDefinition

func (*PHASEPullStreamNodeDefinition) Format

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormat

func (o *PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormat(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat) *PHASEPullStreamNodeDefinition

@method initWithMixerDefinition:format @abstract Create a pull stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @return A new PHASEPullStreamNodeDefinition object

func (*PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier

func (o *PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat, identifier *foundation.NSString) *PHASEPullStreamNodeDefinition

@method initWithMixerDefinition:format:identifier @abstract Create a pull stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @param identifier An optional custom identifier to give to this object @return A new PHASEPullStreamNodeDefinition object

func (*PHASEPullStreamNodeDefinition) Normalize

func (o *PHASEPullStreamNodeDefinition) Normalize() bool

@property normalize @abstract Determines whether or not the engine should normalize the stream. The default value is NO. @discussion In general, clients are advised to normalize the input. Normalization is required to properly calibrate the output level. If you set this value to NO, it's advised that you do custom normalization of the audio data prior to passing the buffers to PHASE.

func (*PHASEPullStreamNodeDefinition) SetNormalize

func (o *PHASEPullStreamNodeDefinition) SetNormalize(normalize bool)

type PHASEPushStreamBufferOptions

type PHASEPushStreamBufferOptions uint64

Options that inform PHASE of an audio-stream buffer’s playback priority.

const (
	// Indicates a buffer processes after existing buffers in the queue.
	PHASEPushStreamBufferDefault PHASEPushStreamBufferOptions = 1
	// Indicates a buffer restarts after it finishes processing.
	PHASEPushStreamBufferLoops PHASEPushStreamBufferOptions = 2
	// Indicates a buffer begins processing immediately.
	PHASEPushStreamBufferInterrupts PHASEPushStreamBufferOptions = 4
	// Indicates a buffer begins processing when an existing buffer loops.
	PHASEPushStreamBufferInterruptsAtLoop PHASEPushStreamBufferOptions = 8
)

func (PHASEPushStreamBufferOptions) String

type PHASEPushStreamCompletionCallbackCondition

type PHASEPushStreamCompletionCallbackCondition int64

A status that describes the results after the app schedules a push-stream buffer.

const (
	// Indicates the framework invokes the callback when the engine processes the audio for output.
	PHASEPushStreamCompletionDataRendered PHASEPushStreamCompletionCallbackCondition = 0
)

func (PHASEPushStreamCompletionCallbackCondition) String

type PHASEPushStreamNode

type PHASEPushStreamNode struct {
	PHASEStreamNode
}

An audio stream you manage to provide a sound buffer data.

Apple documentation: https://developer.apple.com/documentation/phase/phasepushstreamnode

func PHASEPushStreamNodeFromID

func PHASEPushStreamNodeFromID(id objc.ID) *PHASEPushStreamNode

func (*PHASEPushStreamNode) ScheduleBuffer

func (o *PHASEPushStreamNode) ScheduleBuffer(buffer *avfaudio.AVAudioPCMBuffer)

Schedules audio data for playback.

func (*PHASEPushStreamNode) ScheduleBufferAtTimeOptions

func (o *PHASEPushStreamNode) ScheduleBufferAtTimeOptions(buffer *avfaudio.AVAudioPCMBuffer, when *avfaudio.AVAudioTime, options PHASEPushStreamBufferOptions)

Schedules audio data playback at a specific time.

func (*PHASEPushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler

func (o *PHASEPushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler(buffer *avfaudio.AVAudioPCMBuffer, when *avfaudio.AVAudioTime, options PHASEPushStreamBufferOptions, completionCallbackType PHASEPushStreamCompletionCallbackCondition, completionHandler func(PHASEPushStreamCompletionCallbackCondition))

Schedules audio data playback at a specific time with a completion handler.

func (*PHASEPushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler

func (o *PHASEPushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler(buffer *avfaudio.AVAudioPCMBuffer, completionCallbackType PHASEPushStreamCompletionCallbackCondition, completionHandler func(PHASEPushStreamCompletionCallbackCondition))

Schedules audio data playback with a completion handler.

type PHASEPushStreamNodeDefinition

type PHASEPushStreamNodeDefinition struct {
	PHASEGeneratorNodeDefinition
}

A node that plays a sequence of audio buffers.

Apple documentation: https://developer.apple.com/documentation/phase/phasepushstreamnodedefinition

func PHASEPushStreamNodeDefinitionFromID

func PHASEPushStreamNodeDefinitionFromID(id objc.ID) *PHASEPushStreamNodeDefinition

func (*PHASEPushStreamNodeDefinition) Format

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormat

func (o *PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormat(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat) *PHASEPushStreamNodeDefinition

Creates a node definition for audio streams.

func (*PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier

func (o *PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat, identifier *foundation.NSString) *PHASEPushStreamNodeDefinition

Creates a named node definition for audio streams.

func (*PHASEPushStreamNodeDefinition) Normalize

func (o *PHASEPushStreamNodeDefinition) Normalize() bool

@property normalize @abstract Determines whether or not the engine should normalize the stream. The default value is NO. @discussion In general, clients are advised to normalize the input. Normalization is required to properly calibrate the output level. If you set this value to NO, it's advised that you do custom normalization of the audio data prior to passing the buffers to PHASE.

func (*PHASEPushStreamNodeDefinition) SetNormalize

func (o *PHASEPushStreamNodeDefinition) SetNormalize(normalize bool)

type PHASERandomNodeDefinition

type PHASERandomNodeDefinition struct {
	PHASESoundEventNodeDefinition
}

A sound event node that invokes one of its child nodes at random.

Apple documentation: https://developer.apple.com/documentation/phase/phaserandomnodedefinition

func PHASERandomNodeDefinitionFromID

func PHASERandomNodeDefinitionFromID(id objc.ID) *PHASERandomNodeDefinition

func (*PHASERandomNodeDefinition) AddSubtreeWeight

func (o *PHASERandomNodeDefinition) AddSubtreeWeight(subtree *PHASESoundEventNodeDefinition, weight *foundation.NSNumber)

Adds a node tree that’s one of the random-selection options.

func (*PHASERandomNodeDefinition) Init

Creates a random node.

func (*PHASERandomNodeDefinition) InitWithIdentifier

func (o *PHASERandomNodeDefinition) InitWithIdentifier(identifier *foundation.NSString) *PHASERandomNodeDefinition

Creates a random node with the name you specify.

func (*PHASERandomNodeDefinition) SetUniqueSelectionQueueLength

func (o *PHASERandomNodeDefinition) SetUniqueSelectionQueueLength(uniqueSelectionQueueLength int)

func (*PHASERandomNodeDefinition) UniqueSelectionQueueLength

func (o *PHASERandomNodeDefinition) UniqueSelectionQueueLength() int

type PHASERenderingState

type PHASERenderingState int64

The playback status of audio.

const (
	PHASERenderingStateStopped PHASERenderingState = 0
	PHASERenderingStateStarted PHASERenderingState = 1
	PHASERenderingStatePaused  PHASERenderingState = 2
)

func (PHASERenderingState) String

func (e PHASERenderingState) String() string

type PHASEReverbPreset

type PHASEReverbPreset int64

The manner in which PHASE diffuses resonating sound.

const (
	// An option that adds no reverberation to a sound.
	PHASEReverbPresetNone PHASEReverbPreset = 1917742958
	// A resonation that simulates the experience of hearing a sound in a small room with specific dimensions.
	PHASEReverbPresetSmallRoom PHASEReverbPreset = 1918063213
	// A resonation that simulates the experience of hearing a sound in a medium-size room with specific dimensions.
	PHASEReverbPresetMediumRoom PHASEReverbPreset = 1917669997
	// A resonation that simulates the experience of hearing a sound in a large room with specific dimensions.
	PHASEReverbPresetLargeRoom PHASEReverbPreset = 1917604401
	// A resonation that simulates the experience of hearing a sound in one kind of large room with specific dimensions.
	PHASEReverbPresetLargeRoom2 PHASEReverbPreset = 1917604402
	// A resonation that simulates the experience of hearing a sound in a medium-size chamber with specific dimensions.
	PHASEReverbPresetMediumChamber PHASEReverbPreset = 1917666152
	// A resonation that simulates the experience of hearing a sound in a large chamber with specific dimensions.
	PHASEReverbPresetLargeChamber PHASEReverbPreset = 1917600616
	// A resonation that simulates the experience of hearing a sound in a medium-size hall with specific dimensions.
	PHASEReverbPresetMediumHall PHASEReverbPreset = 1917667377
	// A resonation that simulates the experience of hearing a sound in one kind of medium-size hall with specific dimensions.
	PHASEReverbPresetMediumHall2 PHASEReverbPreset = 1917667378
	// A resonation that simulates the experience of hearing a sound in another kind of medium-size hall with specific dimensions.
	PHASEReverbPresetMediumHall3 PHASEReverbPreset = 1917667379
	// A resonation that simulates the experience of hearing a sound in a large hall with specific dimensions.
	PHASEReverbPresetLargeHall PHASEReverbPreset = 1917601841
	// A resonation that simulates the experience of hearing a sound in one kind of large hall with specific dimensions.
	PHASEReverbPresetLargeHall2 PHASEReverbPreset = 1917601842
	// A resonation that simulates the experience of hearing a sound in a cathedral.
	PHASEReverbPresetCathedral PHASEReverbPreset = 1917023336
)

func (PHASEReverbPreset) String

func (e PHASEReverbPreset) String() string

type PHASESamplerNodeDefinition

type PHASESamplerNodeDefinition struct {
	PHASEGeneratorNodeDefinition
}

A node that plays complete audio data.

Apple documentation: https://developer.apple.com/documentation/phase/phasesamplernodedefinition

func PHASESamplerNodeDefinitionFromID

func PHASESamplerNodeDefinitionFromID(id objc.ID) *PHASESamplerNodeDefinition

func (*PHASESamplerNodeDefinition) AssetIdentifier

func (o *PHASESamplerNodeDefinition) AssetIdentifier() *foundation.NSString

@property assetIdentifier @abstract The identifier that uniquely represents the registered sound asset this sampler will play.

func (*PHASESamplerNodeDefinition) CullOption

@property cullOption @abstract The cull option for the sampler. @discussion The default value is PHASECullOptionTerminate.

func (*PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinition

func (o *PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinition(soundAssetIdentifier *foundation.NSString, mixerDefinition *PHASEMixerDefinition) *PHASESamplerNodeDefinition

Creates a sampler node with the given sound asset and mixer.

func (*PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinitionIdentifier

func (o *PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinitionIdentifier(soundAssetIdentifier *foundation.NSString, mixerDefinition *PHASEMixerDefinition, identifier *foundation.NSString) *PHASESamplerNodeDefinition

Creates a named sampler node with the given sound asset and mixer.

func (*PHASESamplerNodeDefinition) PlaybackMode

@property playbackMode @abstract The playback mode for the sampler. @discussion If the playback mode is set to PHASEPlaybackModeOneShot, you need to make sure the the audio data in the registered sound asset associated with this sampler begins and ends at zero crossings. Otherwise, you'll hear a click when beginning playback and / or ending playback. If the playback mode is set to PHASEPlaybackModeLooping, you need to make sure the audio data in the registered sound asset associated with this sampler loops smoothly from the end sample to the start sample. Please verify this during authoring. Failing to do so will result in audible clicks at loop boundaries. The default value is PHASEPlaybackModeOneShot.

func (*PHASESamplerNodeDefinition) SetCullOption

func (o *PHASESamplerNodeDefinition) SetCullOption(cullOption PHASECullOption)

func (*PHASESamplerNodeDefinition) SetPlaybackMode

func (o *PHASESamplerNodeDefinition) SetPlaybackMode(playbackMode PHASEPlaybackMode)

type PHASEShape

type PHASEShape struct {
	foundation.NSObject
}

A collection of points that connect to form a 3D volume.

Apple documentation: https://developer.apple.com/documentation/phase/phaseshape

func PHASEShapeFromID

func PHASEShapeFromID(id objc.ID) *PHASEShape

func (*PHASEShape) Elements

func (*PHASEShape) InitWithEngineMesh

func (o *PHASEShape) InitWithEngineMesh(engine *PHASEEngine, mesh *modelio.MDLMesh) *PHASEShape

Creates an object that the given geometric data shapes.

func (*PHASEShape) InitWithEngineMeshMaterials

func (o *PHASEShape) InitWithEngineMeshMaterials(engine *PHASEEngine, mesh *modelio.MDLMesh, materials *foundation.NSArray[*PHASEMaterial]) *PHASEShape

Creates an object of a specific material that the given geometric data shapes.

type PHASEShapeElement

type PHASEShapeElement struct {
	foundation.NSObject
}

An object that describes the characteristics of a physical surface.

Apple documentation: https://developer.apple.com/documentation/phase/phaseshapeelement

func PHASEShapeElementFromID

func PHASEShapeElementFromID(id objc.ID) *PHASEShapeElement

func (*PHASEShapeElement) Material

func (o *PHASEShapeElement) Material() *PHASEMaterial

func (*PHASEShapeElement) SetMaterial

func (o *PHASEShapeElement) SetMaterial(material *PHASEMaterial)

type PHASESoundAsset

type PHASESoundAsset struct {
	PHASEAsset
}

A sound resource stored in the asset registry.

Apple documentation: https://developer.apple.com/documentation/phase/phasesoundasset

func PHASESoundAssetFromID

func PHASESoundAssetFromID(id objc.ID) *PHASESoundAsset

func (*PHASESoundAsset) Data

func (o *PHASESoundAsset) Data() *foundation.NSData

@property data @abstract The buffer for the sound asset, if applicable.

func (*PHASESoundAsset) Type

func (o *PHASESoundAsset) Type() PHASEAssetType

@property type @abstract The sound asset type.

func (*PHASESoundAsset) Url

func (o *PHASESoundAsset) Url() *foundation.NSURL

@property url @abstract The URL of the sound asset, if applicable.

type PHASESoundEvent

type PHASESoundEvent struct {
	foundation.NSObject
}

An object that determines which audio to play.

Apple documentation: https://developer.apple.com/documentation/phase/phasesoundevent

func PHASESoundEventFromID

func PHASESoundEventFromID(id objc.ID) *PHASESoundEvent

func (*PHASESoundEvent) InitWithEngineAssetIdentifierError

func (o *PHASESoundEvent) InitWithEngineAssetIdentifierError(engine *PHASEEngine, assetIdentifier *foundation.NSString) (*PHASESoundEvent, error)

Creates a sound event node with the given asset.

func (*PHASESoundEvent) InitWithEngineAssetIdentifierMixerParametersError

func (o *PHASESoundEvent) InitWithEngineAssetIdentifierMixerParametersError(engine *PHASEEngine, assetIdentifier *foundation.NSString, mixerParameters *PHASEMixerParameters) (*PHASESoundEvent, error)

Creates a sound event node with the given asset and mixer parameters.

func (*PHASESoundEvent) IsIndefinite

func (o *PHASESoundEvent) IsIndefinite() bool

@property indefinite @abstract A boolean that tell if this sound event will run indefinitely, or finish executing on its own

func (*PHASESoundEvent) MetaParameters

@property metaParameters @abstract A Dictionary containing the MetaParameters associated with this sound event

func (*PHASESoundEvent) Mixers

@property mixNodes @abstract A Dictionary containing the mix nodes associated with this sound event

func (*PHASESoundEvent) Pause

func (o *PHASESoundEvent) Pause()

Pauses the sound event.

func (*PHASESoundEvent) PrepareState

func (o *PHASESoundEvent) PrepareState() PHASESoundEventPrepareState

@property prepareState @abstract Sound Event's current preparation state

func (*PHASESoundEvent) PrepareWithCompletion

func (o *PHASESoundEvent) PrepareWithCompletion(handler func(PHASESoundEventPrepareHandlerReason))

Enables a sound event to play and runs the argument code when the sound event plays back.

func (*PHASESoundEvent) PullStreamNodes

@property pullStreamNodes @abstract A Dictionary containing the pull stream nodes associated with this sound event, for setting renderBlocks on.

func (*PHASESoundEvent) PushStreamNodes

@property pushStreamNodes @abstract A Dictionary containing the push stream nodes associated with this sound event, for pushing buffers to.

func (*PHASESoundEvent) RenderingState

func (o *PHASESoundEvent) RenderingState() PHASERenderingState

@property renderingState @abstract Sound Event's current rendering state

func (*PHASESoundEvent) Resume

func (o *PHASESoundEvent) Resume()

Resumes the sound event.

func (*PHASESoundEvent) ResumeAtTime

func (o *PHASESoundEvent) ResumeAtTime(time_ *avfaudio.AVAudioTime)

@method resumeAtTime @abstract Resume the sound event at a specific time @param time The desired start time based on the engine time retrieved from [PHASEEngine lastRenderTime] @discussion A nil time parameter will resume immediately. The device time is not scaled by UnitsPerSecond and is in seconds.

func (*PHASESoundEvent) SeekToTimeCompletion

func (o *PHASESoundEvent) SeekToTimeCompletion(time_ float64, handler func(PHASESoundEventSeekHandlerReason))

Advances the sound event’s playback position to a specific time.

func (*PHASESoundEvent) SeekToTimeResumeAtEngineTimeCompletion

func (o *PHASESoundEvent) SeekToTimeResumeAtEngineTimeCompletion(time_ float64, engineTime *avfaudio.AVAudioTime, handler func(PHASESoundEventSeekHandlerReason))

@method seekToTime:resumeAtEngineTime:completion @abstract Seeks all leaf nodes in a PHASESoundEvent to the specified time, and automatically resumes playback at the specified engine time. @param time The desired time position in seconds to seek the nodes to. @param engineTime The engine time to resume playback. @param handler The completion callback that will be called when seeking is complete. @discussion This is a low latency convenience method that allows for tight deadlines to be met. However if the seek fails the node state will not be changed. You should check the callback and handle the failure appropriately. The time parameter will seek the nodes to the equivalent sample position based on the sample rate of the asset. The engineTime parameter is the engine timestamp to resume rendering at, based off of [PHASEEngine lastRenderTime]. 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. The time parameter is in seconds and will be scaled by unitsPerSecond. The time in the AVAudioTime structure is not scaled by unitsPerSecond. The engineTime parameter will use the sample time if valid, if not, then the host time if valid.

func (*PHASESoundEvent) StartAtTimeCompletion

func (o *PHASESoundEvent) StartAtTimeCompletion(when *avfaudio.AVAudioTime, handler func(PHASESoundEventStartHandlerReason))

@method startAtTime:completion @abstract Start the sound event @param when The desired start time based on the engine time retrieved from [PHASEEngine lastRenderTime] If the sound event starts immediately with an audible sound, it will begin rendering at this time. The sound event will otherwise begin operating at this time. A nil value will start the sound event immediately This time is not scaled by unitsPerSecond. @param handler The block that will be called when the sound event has stopped. @discussion 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 at the requested time if the sound event has finished preparing in time. You may wait for preparation to finish with the [PHASESoundEvent prepare:completion] method before calling startAtTime, to ensure that the sound event will start at the desired time. However if the desired time is far enough into the future to allow for preparation to happen, you may skip calling prepare entirely and just call startAtTime.

func (*PHASESoundEvent) StartWithCompletion

func (o *PHASESoundEvent) StartWithCompletion(handler func(PHASESoundEventStartHandlerReason))

Invokes the sound event and runs the specified code on completion.

func (*PHASESoundEvent) StopAndInvalidate

func (o *PHASESoundEvent) StopAndInvalidate()

Stops a sound event and prevents it from resuming.

type PHASESoundEventError

type PHASESoundEventError int64

A sound event error that PHASE reports.

const (
	PHASESoundEventErrorNotFound             PHASESoundEventError = 1346925665
	PHASESoundEventErrorBadData              PHASESoundEventError = 1346925666
	PHASESoundEventErrorInvalidInstance      PHASESoundEventError = 1346925667
	PHASESoundEventErrorAPIMisuse            PHASESoundEventError = 1346925668
	PHASESoundEventErrorSystemNotInitialized PHASESoundEventError = 1346925669
	PHASESoundEventErrorOutOfMemory          PHASESoundEventError = 1346925670
)

func (PHASESoundEventError) String

func (e PHASESoundEventError) String() string

type PHASESoundEventNodeAsset

type PHASESoundEventNodeAsset struct {
	PHASEAsset
}

A template object for sounds that can play in reaction to environmental state.

Apple documentation: https://developer.apple.com/documentation/phase/phasesoundeventnodeasset

func PHASESoundEventNodeAssetFromID

func PHASESoundEventNodeAssetFromID(id objc.ID) *PHASESoundEventNodeAsset

type PHASESoundEventNodeDefinition

type PHASESoundEventNodeDefinition struct {
	PHASEDefinition
}

A base class for sound event nodes that connect to form a node hierarchy.

Apple documentation: https://developer.apple.com/documentation/phase/phasesoundeventnodedefinition

func PHASESoundEventNodeDefinitionFromID

func PHASESoundEventNodeDefinitionFromID(id objc.ID) *PHASESoundEventNodeDefinition

func (*PHASESoundEventNodeDefinition) Children

type PHASESoundEventPrepareHandlerReason

type PHASESoundEventPrepareHandlerReason int64

Indicates the results of sound-event preparation.

const (
	PHASESoundEventPrepareHandlerReasonFailure    PHASESoundEventPrepareHandlerReason = 0
	PHASESoundEventPrepareHandlerReasonPrepared   PHASESoundEventPrepareHandlerReason = 1
	PHASESoundEventPrepareHandlerReasonTerminated PHASESoundEventPrepareHandlerReason = 2
)

func (PHASESoundEventPrepareHandlerReason) String

type PHASESoundEventPrepareState

type PHASESoundEventPrepareState int64

Indicates the state of sound-event preparation.

const (
	PHASESoundEventPrepareStatePrepareNotStarted PHASESoundEventPrepareState = 0
	PHASESoundEventPrepareStatePrepareInProgress PHASESoundEventPrepareState = 1
	PHASESoundEventPrepareStatePrepared          PHASESoundEventPrepareState = 2
)

func (PHASESoundEventPrepareState) String

type PHASESoundEventSeekHandlerReason

type PHASESoundEventSeekHandlerReason int64

Indicates the status after a sound event changes its playback position.

const (
	PHASESoundEventSeekHandlerReasonFailure                      PHASESoundEventSeekHandlerReason = 0
	PHASESoundEventSeekHandlerReasonFailureSeekAlreadyInProgress PHASESoundEventSeekHandlerReason = 1
	PHASESoundEventSeekHandlerReasonSeekSuccessful               PHASESoundEventSeekHandlerReason = 2
)

func (PHASESoundEventSeekHandlerReason) String

type PHASESoundEventStartHandlerReason

type PHASESoundEventStartHandlerReason int64

Indicates the status after starting a sound event.

const (
	PHASESoundEventStartHandlerReasonFailure         PHASESoundEventStartHandlerReason = 0
	PHASESoundEventStartHandlerReasonFinishedPlaying PHASESoundEventStartHandlerReason = 1
	PHASESoundEventStartHandlerReasonTerminated      PHASESoundEventStartHandlerReason = 2
)

func (PHASESoundEventStartHandlerReason) String

type PHASESource

type PHASESource struct {
	PHASEObject
}

An object that plays audio from a 3D location and orientation in a scene.

Apple documentation: https://developer.apple.com/documentation/phase/phasesource

func PHASESourceFromID

func PHASESourceFromID(id objc.ID) *PHASESource

func (*PHASESource) Gain

func (o *PHASESource) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASESource) InitWithEngine

func (o *PHASESource) InitWithEngine(engine *PHASEEngine) *PHASESource

Creates a single point in the environment from which sound emanates.

func (*PHASESource) InitWithEngineShapes

func (o *PHASESource) InitWithEngineShapes(engine *PHASEEngine, shapes *foundation.NSArray[*PHASEShape]) *PHASESource

Creates a voluminous area in the environment from which sound emanates.

func (*PHASESource) SetGain

func (o *PHASESource) SetGain(gain float64)

func (*PHASESource) Shapes

func (o *PHASESource) Shapes() *foundation.NSArray[*PHASEShape]

@property shapes @abstract Array of shapes associated with this source.

type PHASESpatialMixerDefinition

type PHASESpatialMixerDefinition struct {
	PHASEMixerDefinition
}

An audio-layering object that produces environmental effects and plays sound with a 3D position and orientation.

Apple documentation: https://developer.apple.com/documentation/phase/phasespatialmixerdefinition

func PHASESpatialMixerDefinitionFromID

func PHASESpatialMixerDefinitionFromID(id objc.ID) *PHASESpatialMixerDefinition

func (*PHASESpatialMixerDefinition) DistanceModelParameters

func (o *PHASESpatialMixerDefinition) DistanceModelParameters() *PHASEDistanceModelParameters

@property distanceModelParameters @abstract Distance model parameters (optional).

func (*PHASESpatialMixerDefinition) InitWithSpatialPipeline

func (o *PHASESpatialMixerDefinition) InitWithSpatialPipeline(spatialPipeline *PHASESpatialPipeline) *PHASESpatialMixerDefinition

Creates a mixer with the designated spatial pipeline.

func (*PHASESpatialMixerDefinition) InitWithSpatialPipelineIdentifier

func (o *PHASESpatialMixerDefinition) InitWithSpatialPipelineIdentifier(spatialPipeline *PHASESpatialPipeline, identifier *foundation.NSString) *PHASESpatialMixerDefinition

Creates a named mixer with the designated spatial pipeline.

func (*PHASESpatialMixerDefinition) ListenerDirectivityModelParameters

func (o *PHASESpatialMixerDefinition) ListenerDirectivityModelParameters() *PHASEDirectivityModelParameters

@property listenerDirectivityModelParameters @abstract Listener directivity model parameters (optional).

func (*PHASESpatialMixerDefinition) SetDistanceModelParameters

func (o *PHASESpatialMixerDefinition) SetDistanceModelParameters(distanceModelParameters *PHASEDistanceModelParameters)

func (*PHASESpatialMixerDefinition) SetListenerDirectivityModelParameters

func (o *PHASESpatialMixerDefinition) SetListenerDirectivityModelParameters(listenerDirectivityModelParameters *PHASEDirectivityModelParameters)

func (*PHASESpatialMixerDefinition) SetSourceDirectivityModelParameters

func (o *PHASESpatialMixerDefinition) SetSourceDirectivityModelParameters(sourceDirectivityModelParameters *PHASEDirectivityModelParameters)

func (*PHASESpatialMixerDefinition) SourceDirectivityModelParameters

func (o *PHASESpatialMixerDefinition) SourceDirectivityModelParameters() *PHASEDirectivityModelParameters

@property sourceDirectivityModelParameters @abstract Source directivity model parameters (optional).

func (*PHASESpatialMixerDefinition) SpatialPipeline

func (o *PHASESpatialMixerDefinition) SpatialPipeline() *PHASESpatialPipeline

@property spatialPipeline @abstract Spatial Pipeline.

type PHASESpatialPipeline

type PHASESpatialPipeline struct {
	foundation.NSObject
}

An object that specifies the volume of optional environmental effects.

Apple documentation: https://developer.apple.com/documentation/phase/phasespatialpipeline

func PHASESpatialPipelineFromID

func PHASESpatialPipelineFromID(id objc.ID) *PHASESpatialPipeline

func (*PHASESpatialPipeline) Entries

@property entries @abstract A dictionary of entries in the Spatial Pipeline. @discussion Upon initialization, an entry will be created for every flag in the PHASESpatialPipelineFlags passed to PHASESpatialPipeline:initWithFlags.

func (*PHASESpatialPipeline) Flags

@property flags @abstract Spatial Pipeline Flags.

func (*PHASESpatialPipeline) InitWithFlags

Creates a spatial pipeline with the specified flags.

type PHASESpatialPipelineEntry

type PHASESpatialPipelineEntry struct {
	foundation.NSObject
}

An audio layer with an adjustable volume for a spatial mixer’s output.

Apple documentation: https://developer.apple.com/documentation/phase/phasespatialpipelineentry

func PHASESpatialPipelineEntryFromID

func PHASESpatialPipelineEntryFromID(id objc.ID) *PHASESpatialPipelineEntry

func (*PHASESpatialPipelineEntry) SendLevel

func (o *PHASESpatialPipelineEntry) SendLevel() float64

@property sendLevel @abstract Send level. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASESpatialPipelineEntry) SendLevelMetaParameterDefinition

func (o *PHASESpatialPipelineEntry) SendLevelMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property sendLevelMetaParameterDefinition @abstract An optional metaparameter used to drive the send level during playback.

func (*PHASESpatialPipelineEntry) SetSendLevel

func (o *PHASESpatialPipelineEntry) SetSendLevel(sendLevel float64)

func (*PHASESpatialPipelineEntry) SetSendLevelMetaParameterDefinition

func (o *PHASESpatialPipelineEntry) SetSendLevelMetaParameterDefinition(sendLevelMetaParameterDefinition *PHASENumberMetaParameterDefinition)

type PHASESpatialPipelineFlags

type PHASESpatialPipelineFlags uint64

Sound resonance options for a spatial pipeline.

const (
	PHASESpatialPipelineFlagDirectPathTransmission PHASESpatialPipelineFlags = 1
	PHASESpatialPipelineFlagEarlyReflections       PHASESpatialPipelineFlags = 2
	PHASESpatialPipelineFlagLateReverb             PHASESpatialPipelineFlags = 4
)

func (PHASESpatialPipelineFlags) String

func (e PHASESpatialPipelineFlags) String() string

type PHASESpatializationMode

type PHASESpatializationMode int64

The manner in which PHASE outputs spatial audio.

const (
	// A mode that indicates that the framework chooses the spatialization mode.
	PHASESpatializationModeAutomatic PHASESpatializationMode = 0
	// A mode that introduces special processing to replicate a realistic spatial listening experience.
	PHASESpatializationModeAlwaysUseBinaural PHASESpatializationMode = 1
	// A mode that adds a 3D position and orientation to sound by panning across the available output channels.
	PHASESpatializationModeAlwaysUseChannelBased PHASESpatializationMode = 2
)

func (PHASESpatializationMode) String

func (e PHASESpatializationMode) String() string

type PHASEStreamNode

type PHASEStreamNode struct {
	foundation.NSObject
}

Apple documentation: https://developer.apple.com/documentation/phase/phasestreamnode

func PHASEStreamNodeFromID

func PHASEStreamNodeFromID(id objc.ID) *PHASEStreamNode

func (*PHASEStreamNode) Format

func (o *PHASEStreamNode) Format() *avfaudio.AVAudioFormat

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with.

func (*PHASEStreamNode) GainMetaParameter

func (o *PHASEStreamNode) GainMetaParameter() *PHASENumberMetaParameter

@property gainMetaParameter @abstract If specified during construction, the metaparameter for controlling gain will be available here

func (*PHASEStreamNode) Mixer

func (o *PHASEStreamNode) Mixer() *PHASEMixer

@property mixer @abstract The readonly property that returns the PHASEMixer this stream was created with and assigned to.

func (*PHASEStreamNode) RateMetaParameter

func (o *PHASEStreamNode) RateMetaParameter() *PHASENumberMetaParameter

@property rateMetaParameter @abstract If specified during construction, the metaparameter for controlling rate/pitch will be available here

type PHASEStringMetaParameter

type PHASEStringMetaParameter struct {
	PHASEMetaParameter
}

A metaparameter with a text definition that can change over time.

Apple documentation: https://developer.apple.com/documentation/phase/phasestringmetaparameter

func PHASEStringMetaParameterFromID

func PHASEStringMetaParameterFromID(id objc.ID) *PHASEStringMetaParameter

type PHASEStringMetaParameterDefinition

type PHASEStringMetaParameterDefinition struct {
	PHASEMetaParameterDefinition
}

A specification for a metaparameter defined by text.

Apple documentation: https://developer.apple.com/documentation/phase/phasestringmetaparameterdefinition

func PHASEStringMetaParameterDefinitionFromID

func PHASEStringMetaParameterDefinitionFromID(id objc.ID) *PHASEStringMetaParameterDefinition

func (*PHASEStringMetaParameterDefinition) InitWithValue

Creates a specification for a textual metaparameter with the given value.

func (*PHASEStringMetaParameterDefinition) InitWithValueIdentifier

Creates a specification for a named textual metaparameter with the given value.

type PHASESwitchNodeDefinition

type PHASESwitchNodeDefinition struct {
	PHASESoundEventNodeDefinition
}

A node that passes invocation to only one of its child nodes.

Apple documentation: https://developer.apple.com/documentation/phase/phaseswitchnodedefinition

func PHASESwitchNodeDefinitionFromID

func PHASESwitchNodeDefinitionFromID(id objc.ID) *PHASESwitchNodeDefinition

func (*PHASESwitchNodeDefinition) AddSubtreeSwitchValue

func (o *PHASESwitchNodeDefinition) AddSubtreeSwitchValue(subtree *PHASESoundEventNodeDefinition, switchValue *foundation.NSString)

Adds a child node with the given switch value.

func (*PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinition

func (o *PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinition(switchMetaParameterDefinition *PHASEStringMetaParameterDefinition) *PHASESwitchNodeDefinition

Creates a node that invokes a child node based on the value of the given parameter.

func (*PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinitionIdentifier

func (o *PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinitionIdentifier(switchMetaParameterDefinition *PHASEStringMetaParameterDefinition, identifier *foundation.NSString) *PHASESwitchNodeDefinition

Creates a named node that invokes a child node based on the value of the given parameter.

func (*PHASESwitchNodeDefinition) SwitchMetaParameterDefinition

func (o *PHASESwitchNodeDefinition) SwitchMetaParameterDefinition() *PHASEStringMetaParameterDefinition

type PHASEUpdateMode

type PHASEUpdateMode int64

Modes that determine when the framework consumes API calls and updates internal state.

const (
	PHASEUpdateModeAutomatic PHASEUpdateMode = 0
	PHASEUpdateModeManual    PHASEUpdateMode = 1
)

func (PHASEUpdateMode) String

func (e PHASEUpdateMode) String() string

type PMPageToPaperMappingType

type PMPageToPaperMappingType int64
const (
	KPMPageToPaperMappingNone       PMPageToPaperMappingType = 1
	KPMPageToPaperMappingScaleToFit PMPageToPaperMappingType = 2
)

func (PMPageToPaperMappingType) String

func (e PMPageToPaperMappingType) String() string

type Ptrauth_key

type Ptrauth_key int64
const (
	Ptrauth_key_none                     Ptrauth_key = -1
	Ptrauth_key_asia                     Ptrauth_key = 0
	Ptrauth_key_asib                     Ptrauth_key = 1
	Ptrauth_key_asda                     Ptrauth_key = 2
	Ptrauth_key_asdb                     Ptrauth_key = 3
	Ptrauth_key_process_independent_code Ptrauth_key = 0
	Ptrauth_key_process_dependent_code   Ptrauth_key = 1
	Ptrauth_key_process_independent_data Ptrauth_key = 2
	Ptrauth_key_process_dependent_data   Ptrauth_key = 3
	Ptrauth_key_return_address           Ptrauth_key = 1
	Ptrauth_key_frame_pointer            Ptrauth_key = 3
	Ptrauth_key_function_pointer         Ptrauth_key = 0
	Ptrauth_key_block_function           Ptrauth_key = 0
	Ptrauth_key_cxx_vtable_pointer       Ptrauth_key = 2
	Ptrauth_key_method_list_pointer      Ptrauth_key = 2
	Ptrauth_key_objc_isa_pointer         Ptrauth_key = 2
	Ptrauth_key_objc_super_pointer       Ptrauth_key = 2
	Ptrauth_key_objc_sel_pointer         Ptrauth_key = 3
	Ptrauth_key_objc_class_ro_pointer    Ptrauth_key = 2
	Ptrauth_key_block_descriptor_pointer Ptrauth_key = 2
	Ptrauth_key_init_fini_pointer        Ptrauth_key = 0
)

func (Ptrauth_key) String

func (e Ptrauth_key) String() string

type Qos_class_t

type Qos_class_t uint32
const (
	QOS_CLASS_USER_INTERACTIVE Qos_class_t = 33
	QOS_CLASS_USER_INITIATED   Qos_class_t = 25
	QOS_CLASS_DEFAULT          Qos_class_t = 21
	QOS_CLASS_UTILITY          Qos_class_t = 17
	QOS_CLASS_BACKGROUND       Qos_class_t = 9
	QOS_CLASS_UNSPECIFIED      Qos_class_t = 0
)

func (Qos_class_t) String

func (e Qos_class_t) String() string

type Virtual_memory_guard_exception_code_t

type Virtual_memory_guard_exception_code_t int64
const (
	KGUARD_EXC_DEALLOC_GAP                   Virtual_memory_guard_exception_code_t = 1
	KGUARD_EXC_RECLAIM_COPYIO_FAILURE        Virtual_memory_guard_exception_code_t = 2
	KGUARD_EXC_RECLAIM_INDEX_FAILURE         Virtual_memory_guard_exception_code_t = 4
	KGUARD_EXC_RECLAIM_DEALLOCATE_FAILURE    Virtual_memory_guard_exception_code_t = 8
	KGUARD_EXC_RECLAIM_ACCOUNTING_FAILURE    Virtual_memory_guard_exception_code_t = 9
	KGUARD_EXC_SEC_IOPL_ON_EXEC_PAGE         Virtual_memory_guard_exception_code_t = 10
	KGUARD_EXC_SEC_EXEC_ON_IOPL_PAGE         Virtual_memory_guard_exception_code_t = 11
	KGUARD_EXC_SEC_UPL_WRITE_ON_EXEC_REGION  Virtual_memory_guard_exception_code_t = 12
	KGUARD_EXC_LARGE_ALLOCATION_TELEMETRY    Virtual_memory_guard_exception_code_t = 13
	KGUARD_EXC_SEC_ACCESS_FAULT              Virtual_memory_guard_exception_code_t = 98
	KGUARD_EXC_SEC_ASYNC_ACCESS_FAULT        Virtual_memory_guard_exception_code_t = 99
	KGUARD_EXC_SEC_COPY_DENIED               Virtual_memory_guard_exception_code_t = 100
	KGUARD_EXC_SEC_SHARING_DENIED            Virtual_memory_guard_exception_code_t = 101
	KGUARD_EXC_MTE_SYNC_FAULT                Virtual_memory_guard_exception_code_t = 200
	KGUARD_EXC_MTE_ASYNC_USER_FAULT          Virtual_memory_guard_exception_code_t = 201
	KGUARD_EXC_MTE_ASYNC_KERN_FAULT          Virtual_memory_guard_exception_code_t = 202
	KGUARD_EXC_GUARD_OBJECT_ASYNC_USER_FAULT Virtual_memory_guard_exception_code_t = 203
	KGUARD_EXC_GUARD_OBJECT_ASYNC_KERN_FAULT Virtual_memory_guard_exception_code_t = 204
)

func (Virtual_memory_guard_exception_code_t) String

type Xpc_listener_create_flags_t

type Xpc_listener_create_flags_t int64
const (
	XPC_LISTENER_CREATE_NONE             Xpc_listener_create_flags_t = 0
	XPC_LISTENER_CREATE_INACTIVE         Xpc_listener_create_flags_t = 1
	XPC_LISTENER_CREATE_FORCE_MACH       Xpc_listener_create_flags_t = 2
	XPC_LISTENER_CREATE_FORCE_XPCSERVICE Xpc_listener_create_flags_t = 4
)

func (Xpc_listener_create_flags_t) String

type Xpc_session_create_flags_t

type Xpc_session_create_flags_t int64
const (
	XPC_SESSION_CREATE_NONE            Xpc_session_create_flags_t = 0
	XPC_SESSION_CREATE_INACTIVE        Xpc_session_create_flags_t = 1
	XPC_SESSION_CREATE_MACH_PRIVILEGED Xpc_session_create_flags_t = 2
)

func (Xpc_session_create_flags_t) String

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL