phase

package
v0.18.0 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package phase provides a fluent Go API over the macOS PHASE framework.

Construction

New… functions create objects; each With… method sets one property and returns its receiver, so configuration calls chain. A <Type>FromID constructor adopts an Objective-C object obtained elsewhere.

Lifecycle

A wrapper releases its Objective-C object automatically once the garbage collector finds it unreachable. Call Release to relinquish the reference deterministically (for objects holding scarce resources); Release is idempotent, and afterwards the wrapper's methods are no-ops returning zero values.

Types

Each base type below lists the concrete types you construct and pass where the base is accepted:

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Forward added in v0.18.0 

func Forward() unsafe.Pointer

Forward returns the direction PHASE treats as "forward" in local space for all objects.

func PHASEAssetErrorDomain 

func PHASEAssetErrorDomain() obj.Object

PHASEAssetErrorDomain returns the string constant PHASEAssetErrorDomain, for use as a dictionary key or argument.

func PHASEErrorDomain 

func PHASEErrorDomain() obj.Object

PHASEErrorDomain returns the string constant PHASEErrorDomain, for use as a dictionary key or argument.

func PHASESoundEventErrorDomain 

func PHASESoundEventErrorDomain() obj.Object

PHASESoundEventErrorDomain returns the string constant PHASESoundEventErrorDomain, for use as a dictionary key or argument.

func PHASESpatialCategoryDirectPathTransmission 

func PHASESpatialCategoryDirectPathTransmission() obj.Object

PHASESpatialCategoryDirectPathTransmission returns the string constant PHASESpatialCategoryDirectPathTransmission, for use as a dictionary key or argument.

func PHASESpatialCategoryEarlyReflections 

func PHASESpatialCategoryEarlyReflections() obj.Object

PHASESpatialCategoryEarlyReflections returns the string constant PHASESpatialCategoryEarlyReflections, for use as a dictionary key or argument.

func PHASESpatialCategoryLateReverb 

func PHASESpatialCategoryLateReverb() obj.Object

PHASESpatialCategoryLateReverb returns the string constant PHASESpatialCategoryLateReverb, for use as a dictionary key or argument. 

func Right() unsafe.Pointer

Right returns the direction PHASE treats as "right" in local space for all objects.

func Up added in v0.18.0 

func Up() unsafe.Pointer

Up returns the direction PHASE treats as "up" in local space for all objects.

Types

type AmbientMixerDefinition added in v0.17.0 

type AmbientMixerDefinition struct {
	MixerDefinition
}

AmbientMixerDefinition is an idiomatic wrapper over the Objective-C class PHASEAmbientMixerDefinition.

It embeds MixerDefinition, promoting that type's methods.

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

func AmbientMixerDefinitionFromID added in v0.17.0 

func AmbientMixerDefinitionFromID(id objc.ID) *AmbientMixerDefinition

AmbientMixerDefinitionFromID adopts an existing Objective-C object as a AmbientMixerDefinition (nil for 0), retaining it and registering a release finalizer.

func NewAmbientMixerDefinitionWithChannelLayoutOrientation added in v0.17.0 

func NewAmbientMixerDefinitionWithChannelLayoutOrientation(layout obj.Object, orientation unsafe.Pointer) *AmbientMixerDefinition

NewAmbientMixerDefinitionWithChannelLayoutOrientation creates an ambient mixer with the given channel layout and orientation.

func NewAmbientMixerDefinitionWithChannelLayoutOrientationIdentifier added in v0.17.0 

func NewAmbientMixerDefinitionWithChannelLayoutOrientationIdentifier(layout obj.Object, orientation unsafe.Pointer, identifier string) *AmbientMixerDefinition

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

func (*AmbientMixerDefinition) InputChannelLayout added in v0.17.0 

func (amd *AmbientMixerDefinition) InputChannelLayout() obj.Object

InputChannelLayout returns a readonly value of the input channel layout this mixer was initialized with.

func (*AmbientMixerDefinition) Orientation added in v0.18.0 

func (amd *AmbientMixerDefinition) Orientation() unsafe.Pointer

Orientation returns a readonly value of the ambient source's orientation relative to the scene root.

func (*AmbientMixerDefinition) WithGain added in v0.17.0 

func (amd *AmbientMixerDefinition) WithGain(gain float64) *AmbientMixerDefinition

WithGain sets the mixer’s volume.

func (*AmbientMixerDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (amd *AmbientMixerDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *AmbientMixerDefinition

WithGainMetaParameterDefinition sets a template for a parameter that changes the mixer’s volume gradually over a period of time.

type Asset added in v0.17.0 

type Asset struct {
	objref.Handle
}

Asset is an idiomatic wrapper over the Objective-C class PHASEAsset.

Asset is an abstract base — you do not construct it directly. Construct one of GlobalMetaParameterAsset, SoundAsset, SoundEventNodeAsset and pass it where a Asset is accepted.

A base class that adds a name to framework assets.

func AssetFromID added in v0.17.0 

func AssetFromID(id objc.ID) *Asset

AssetFromID adopts an existing Objective-C object as a Asset (nil for 0), retaining it and registering a release finalizer.

func (*Asset) Description added in v0.17.0 

func (a *Asset) Description() string

Description returns the object's -description text.

func (*Asset) Identifier added in v0.17.0 

func (a *Asset) Identifier() string

Identifier returns the identifier.

func (*Asset) IsEqual added in v0.17.0 

func (a *Asset) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Asset) IsKind added in v0.17.0 

func (a *Asset) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Asset) String added in v0.17.0 

func (a *Asset) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type AssetError added in v0.17.0 

type AssetError int64

An asset error that PHASE reports. 

const (
	AssetErrorFailedToLoad          AssetError = 1346920801
	AssetErrorInvalidEngineInstance AssetError = 1346920802
	AssetErrorBadParameters         AssetError = 1346920803
	AssetErrorAlreadyExists         AssetError = 1346920804
	AssetErrorGeneralError          AssetError = 1346920805
	AssetErrorMemoryAllocation      AssetError = 1346920806
)

func (AssetError) String added in v0.17.0 

func (e AssetError) String() string

String returns the AssetError constant's name, or its numeric form when the value is not a known constant.

type AssetProvider added in v0.17.0 

type AssetProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

AssetProvider is accepted wherever a PHASEAsset (or one of its subclasses) is expected.

type AssetRegistry added in v0.17.0 

type AssetRegistry struct {
	objref.Handle
}

AssetRegistry is an idiomatic wrapper over the Objective-C class PHASEAssetRegistry.

A central repository of audio assets.

func AssetRegistryFromID added in v0.17.0 

func AssetRegistryFromID(id objc.ID) *AssetRegistry

AssetRegistryFromID adopts an existing Objective-C object as a AssetRegistry (nil for 0), retaining it and registering a release finalizer.

func NewAssetRegistry added in v0.17.0 

func NewAssetRegistry() *AssetRegistry

NewAssetRegistry creates a new AssetRegistry.

func (*AssetRegistry) AssetForIdentifier added in v0.17.0 

func (ar *AssetRegistry) AssetForIdentifier(identifier string) *Asset

AssetForIdentifier provides the asset named with the designated identifier.

func (*AssetRegistry) Description added in v0.17.0 

func (ar *AssetRegistry) Description() string

Description returns the object's -description text.

func (*AssetRegistry) GlobalMetaParameters added in v0.17.0 

func (ar *AssetRegistry) GlobalMetaParameters() map[string]*MetaParameter

GlobalMetaParameters returns the global meta parameters.

func (*AssetRegistry) IsEqual added in v0.17.0 

func (ar *AssetRegistry) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*AssetRegistry) IsKind added in v0.17.0 

func (ar *AssetRegistry) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*AssetRegistry) RegisterGlobalMetaParameter added in v0.17.0 

func (ar *AssetRegistry) RegisterGlobalMetaParameter(metaParameterDefinition *MetaParameterDefinition) (result *GlobalMetaParameterAsset, err error)

RegisterGlobalMetaParameter registers a global metaparameter with the asset registry.

func (*AssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationMode added in v0.17.0 

func (ar *AssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationMode(url string, identifier string, assetType AssetType, channelLayout obj.Object, normalizationMode NormalizationMode) (result *SoundAsset, err error)

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

func (*AssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationMode added in v0.17.0 

func (ar *AssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationMode(data []byte, identifier string, format obj.Object, normalizationMode NormalizationMode) (result *SoundAsset, err error)

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

func (*AssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifier added in v0.17.0 

func (ar *AssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifier(rootNode *SoundEventNodeDefinition, identifier string) (result *SoundEventNodeAsset, err error)

RegisterSoundEventAssetWithRootNodeIdentifier registers the root node of the sound event asset.

func (*AssetRegistry) String added in v0.17.0 

func (ar *AssetRegistry) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*AssetRegistry) UnregisterAssetWithIdentifierCompletion added in v0.17.0 

func (ar *AssetRegistry) UnregisterAssetWithIdentifierCompletion(identifier string, handler func(bool))

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

type AssetType added in v0.17.0 

type AssetType int64

Options that determine how PHASE manages sound assets in memory. 

const (
	AssetTypeResident AssetType = 0
	AssetTypeStreamed AssetType = 1
)

func (AssetType) String added in v0.17.0 

func (e AssetType) String() string

String returns the AssetType constant's name, or its numeric form when the value is not a known constant.

type AutomaticHeadTrackingFlags added in v0.17.0 

type AutomaticHeadTrackingFlags uint64

Bitmask — values may be combined with |. 

const (
	AutomaticHeadTrackingFlagOrientation AutomaticHeadTrackingFlags = 1
	AutomaticHeadTrackingFlagPosition    AutomaticHeadTrackingFlags = 2
)

func (AutomaticHeadTrackingFlags) String added in v0.17.0 

func (e AutomaticHeadTrackingFlags) String() string

String returns the AutomaticHeadTrackingFlags constant's name, or its numeric form when the value is not a known constant.

type BlendNodeDefinition added in v0.17.0 

type BlendNodeDefinition struct {
	SoundEventNodeDefinition
}

BlendNodeDefinition is an idiomatic wrapper over the Objective-C class PHASEBlendNodeDefinition.

It embeds SoundEventNodeDefinition, promoting that type's methods.

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

func BlendNodeDefinitionFromID added in v0.17.0 

func BlendNodeDefinitionFromID(id objc.ID) *BlendNodeDefinition

BlendNodeDefinitionFromID adopts an existing Objective-C object as a BlendNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinition added in v0.17.0 

func NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinition(spatialMixerDefinition *SpatialMixerDefinition) *BlendNodeDefinition

NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinition creates a blend node for spatial audio output.

func NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinitionIdentifier added in v0.17.0 

func NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinitionIdentifier(spatialMixerDefinition *SpatialMixerDefinition, identifier string) *BlendNodeDefinition

NewBlendNodeDefinitionDistanceBlendWithSpatialMixerDefinitionIdentifier creates a named blend node for spatial audio output.

func NewBlendNodeDefinitionWithBlendMetaParameterDefinition added in v0.17.0 

func NewBlendNodeDefinitionWithBlendMetaParameterDefinition(blendMetaParameterDefinition *NumberMetaParameterDefinition) *BlendNodeDefinition

NewBlendNodeDefinitionWithBlendMetaParameterDefinition creates a blend node with a maxiumum blend range value.

func NewBlendNodeDefinitionWithBlendMetaParameterDefinitionIdentifier added in v0.17.0 

func NewBlendNodeDefinitionWithBlendMetaParameterDefinitionIdentifier(blendMetaParameterDefinition *NumberMetaParameterDefinition, identifier string) *BlendNodeDefinition

NewBlendNodeDefinitionWithBlendMetaParameterDefinitionIdentifier creates a named blend node with a maxiumum blend range value.

func (*BlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree added in v0.17.0 

func (bnd *BlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType CurveType, subtree *SoundEventNodeDefinition)

AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree adds a child node that blends above a given value.

func (*BlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree added in v0.17.0 

func (bnd *BlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType CurveType, subtree *SoundEventNodeDefinition)

AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree adds a child node that blends below a given value.

func (*BlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree added in v0.17.0 

func (bnd *BlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree(lowValue float64, highValue float64, fullGainAtLowValue float64, fullGainAtHighValue float64, lowFadeCurveType CurveType, highFadeCurveType CurveType, subtree *SoundEventNodeDefinition)

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

func (*BlendNodeDefinition) AddRangeWithEnvelopeSubtree added in v0.17.0 

func (bnd *BlendNodeDefinition) AddRangeWithEnvelopeSubtree(envelope *Envelope, subtree *SoundEventNodeDefinition)

AddRangeWithEnvelopeSubtree adds a child node with an envelope.

func (*BlendNodeDefinition) BlendParameterDefinition added in v0.17.0 

func (bnd *BlendNodeDefinition) BlendParameterDefinition() *NumberMetaParameterDefinition

BlendParameterDefinition returns the blend parameter definition.

func (*BlendNodeDefinition) SpatialMixerDefinitionForDistance added in v0.17.0 

func (bnd *BlendNodeDefinition) SpatialMixerDefinitionForDistance() *SpatialMixerDefinition

SpatialMixerDefinitionForDistance returns the spatial mixer definition for distance.

type CGLCPContextPriorityRequest 

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

func (CGLCPContextPriorityRequest) String 

func (e CGLCPContextPriorityRequest) String() string

String returns the CGLCPContextPriorityRequest constant's name, or its numeric form when the value is not a known constant.

type CalibrationMode added in v0.17.0 

type CalibrationMode int64

Calibration options for sound pressure level. 

const (
	// An option that specifies no loudness calibration.
	CalibrationModeNone CalibrationMode = 0
	// A sound pressure level that’s tuned for the device.
	CalibrationModeRelativeSpl CalibrationMode = 1
	// A sound pressure level based on the current output device.
	CalibrationModeAbsoluteSpl CalibrationMode = 2
)

func (CalibrationMode) String added in v0.17.0 

func (e CalibrationMode) String() string

String returns the CalibrationMode constant's name, or its numeric form when the value is not a known constant.

type CardioidDirectivityModelParameters added in v0.17.0 

type CardioidDirectivityModelParameters struct {
	DirectivityModelParameters
}

CardioidDirectivityModelParameters is an idiomatic wrapper over the Objective-C class PHASECardioidDirectivityModelParameters.

It embeds DirectivityModelParameters, promoting that type's methods.

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

func CardioidDirectivityModelParametersFromID added in v0.17.0 

func CardioidDirectivityModelParametersFromID(id objc.ID) *CardioidDirectivityModelParameters

CardioidDirectivityModelParametersFromID adopts an existing Objective-C object as a CardioidDirectivityModelParameters (nil for 0), retaining it and registering a release finalizer.

func NewCardioidDirectivityModelParametersWithSubbandParameters added in v0.17.0 

func NewCardioidDirectivityModelParametersWithSubbandParameters(subbandParameters []*CardioidDirectivityModelSubbandParameters) *CardioidDirectivityModelParameters

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

func (*CardioidDirectivityModelParameters) SubbandParameters added in v0.17.0 

func (cdmp *CardioidDirectivityModelParameters) SubbandParameters() []*CardioidDirectivityModelSubbandParameters

SubbandParameters returns the subband parameters.

SubbandParameters returns the collection as a Go slice.

type CardioidDirectivityModelSubbandParameters added in v0.17.0 

type CardioidDirectivityModelSubbandParameters struct {
	objref.Handle
}

CardioidDirectivityModelSubbandParameters is an idiomatic wrapper over the Objective-C class PHASECardioidDirectivityModelSubbandParameters.

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

func CardioidDirectivityModelSubbandParametersFromID added in v0.17.0 

func CardioidDirectivityModelSubbandParametersFromID(id objc.ID) *CardioidDirectivityModelSubbandParameters

CardioidDirectivityModelSubbandParametersFromID adopts an existing Objective-C object as a CardioidDirectivityModelSubbandParameters (nil for 0), retaining it and registering a release finalizer.

func NewCardioidDirectivityModelSubbandParameters added in v0.17.0 

func NewCardioidDirectivityModelSubbandParameters() *CardioidDirectivityModelSubbandParameters

NewCardioidDirectivityModelSubbandParameters creates a new CardioidDirectivityModelSubbandParameters.

func (*CardioidDirectivityModelSubbandParameters) Description added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) Description() string

Description returns the object's -description text.

func (*CardioidDirectivityModelSubbandParameters) Frequency added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) Frequency() float64

Frequency returns the frequency of the subband, in hertz.

func (*CardioidDirectivityModelSubbandParameters) IsEqual added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*CardioidDirectivityModelSubbandParameters) IsKind added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*CardioidDirectivityModelSubbandParameters) Pattern added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) Pattern() float64

Pattern returns the directivity pattern.

func (*CardioidDirectivityModelSubbandParameters) Sharpness added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) Sharpness() float64

Sharpness returns the sharpness of the directivity pattern.

func (*CardioidDirectivityModelSubbandParameters) String added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*CardioidDirectivityModelSubbandParameters) WithFrequency added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) WithFrequency(frequency float64) *CardioidDirectivityModelSubbandParameters

WithFrequency sets a frequency in the audio spectrum where the pattern and sharpness resonate most.

func (*CardioidDirectivityModelSubbandParameters) WithPattern added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) WithPattern(pattern float64) *CardioidDirectivityModelSubbandParameters

WithPattern sets a shape that determines the direction of sound.

func (*CardioidDirectivityModelSubbandParameters) WithSharpness added in v0.17.0 

func (cdmsp *CardioidDirectivityModelSubbandParameters) WithSharpness(sharpness float64) *CardioidDirectivityModelSubbandParameters

WithSharpness sets the amount that the shape overlaps with bordering subbands.

type ChannelMixerDefinition added in v0.17.0 

type ChannelMixerDefinition struct {
	MixerDefinition
}

ChannelMixerDefinition is an idiomatic wrapper over the Objective-C class PHASEChannelMixerDefinition.

It embeds MixerDefinition, promoting that type's methods.

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

func ChannelMixerDefinitionFromID added in v0.17.0 

func ChannelMixerDefinitionFromID(id objc.ID) *ChannelMixerDefinition

ChannelMixerDefinitionFromID adopts an existing Objective-C object as a ChannelMixerDefinition (nil for 0), retaining it and registering a release finalizer.

func NewChannelMixerDefinitionWithChannelLayout added in v0.17.0 

func NewChannelMixerDefinitionWithChannelLayout(layout obj.Object) *ChannelMixerDefinition

NewChannelMixerDefinitionWithChannelLayout creates a channel mixer with the given channel layout.

func NewChannelMixerDefinitionWithChannelLayoutIdentifier added in v0.17.0 

func NewChannelMixerDefinitionWithChannelLayoutIdentifier(layout obj.Object, identifier string) *ChannelMixerDefinition

NewChannelMixerDefinitionWithChannelLayoutIdentifier creates a named channel mixer with the given channel layout.

func (*ChannelMixerDefinition) InputChannelLayout added in v0.17.0 

func (cmd *ChannelMixerDefinition) InputChannelLayout() obj.Object

InputChannelLayout returns the input channel layout.

func (*ChannelMixerDefinition) WithGain added in v0.17.0 

func (cmd *ChannelMixerDefinition) WithGain(gain float64) *ChannelMixerDefinition

WithGain sets the mixer’s volume.

func (*ChannelMixerDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (cmd *ChannelMixerDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *ChannelMixerDefinition

WithGainMetaParameterDefinition sets a template for a parameter that changes the mixer’s volume gradually over a period of time.

type Clockid added in v0.17.0 

type Clockid int32
const (
	ClockidRealtime           Clockid = 0
	ClockidMonotonic          Clockid = 6
	ClockidMonotonicRaw       Clockid = 4
	ClockidMonotonicRawApprox Clockid = 5
	ClockidUptimeRaw          Clockid = 8
	ClockidUptimeRawApprox    Clockid = 9
	ClockidProcessCputimeID   Clockid = 12
	ClockidThreadCputimeID    Clockid = 16
)

func (Clockid) String added in v0.17.0 

func (e Clockid) String() string

String returns the Clockid constant's name, or its numeric form when the value is not a known constant.

type ConeDirectivityModelParameters added in v0.17.0 

type ConeDirectivityModelParameters struct {
	DirectivityModelParameters
}

ConeDirectivityModelParameters is an idiomatic wrapper over the Objective-C class PHASEConeDirectivityModelParameters.

It embeds DirectivityModelParameters, promoting that type's methods.

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

func ConeDirectivityModelParametersFromID added in v0.17.0 

func ConeDirectivityModelParametersFromID(id objc.ID) *ConeDirectivityModelParameters

ConeDirectivityModelParametersFromID adopts an existing Objective-C object as a ConeDirectivityModelParameters (nil for 0), retaining it and registering a release finalizer.

func NewConeDirectivityModelParametersWithSubbandParameters added in v0.17.0 

func NewConeDirectivityModelParametersWithSubbandParameters(subbandParameters []*ConeDirectivityModelSubbandParameters) *ConeDirectivityModelParameters

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

func (*ConeDirectivityModelParameters) SubbandParameters added in v0.17.0 

func (cdmp *ConeDirectivityModelParameters) SubbandParameters() []*ConeDirectivityModelSubbandParameters

SubbandParameters returns the subband parameters.

SubbandParameters returns the collection as a Go slice.

type ConeDirectivityModelSubbandParameters added in v0.17.0 

type ConeDirectivityModelSubbandParameters struct {
	objref.Handle
}

ConeDirectivityModelSubbandParameters is an idiomatic wrapper over the Objective-C class PHASEConeDirectivityModelSubbandParameters.

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

func ConeDirectivityModelSubbandParametersFromID added in v0.17.0 

func ConeDirectivityModelSubbandParametersFromID(id objc.ID) *ConeDirectivityModelSubbandParameters

ConeDirectivityModelSubbandParametersFromID adopts an existing Objective-C object as a ConeDirectivityModelSubbandParameters (nil for 0), retaining it and registering a release finalizer.

func NewConeDirectivityModelSubbandParameters added in v0.17.0 

func NewConeDirectivityModelSubbandParameters() *ConeDirectivityModelSubbandParameters

NewConeDirectivityModelSubbandParameters creates a new ConeDirectivityModelSubbandParameters.

func (*ConeDirectivityModelSubbandParameters) Description added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) Description() string

Description returns the object's -description text.

func (*ConeDirectivityModelSubbandParameters) Frequency added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) Frequency() float64

Frequency returns the frequency of the subband, in hertz.

func (*ConeDirectivityModelSubbandParameters) InnerAngle added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) InnerAngle() float64

InnerAngle returns the inner angle, in degrees.

func (*ConeDirectivityModelSubbandParameters) IsEqual added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ConeDirectivityModelSubbandParameters) IsKind added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ConeDirectivityModelSubbandParameters) OuterAngle added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) OuterAngle() float64

OuterAngle returns the outer angle, in degrees.

func (*ConeDirectivityModelSubbandParameters) OuterGain added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) OuterGain() float64

OuterGain returns the outer gain.

func (*ConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle(innerAngle float64, outerAngle float64)

SetInnerAngleOuterAngle configures a focus area for cone-based sound directivity.

func (*ConeDirectivityModelSubbandParameters) String added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ConeDirectivityModelSubbandParameters) WithFrequency added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) WithFrequency(frequency float64) *ConeDirectivityModelSubbandParameters

WithFrequency sets a frequency in the audio spectrum where the subband resonates most.

func (*ConeDirectivityModelSubbandParameters) WithOuterGain added in v0.17.0 

func (cdmsp *ConeDirectivityModelSubbandParameters) WithOuterGain(outerGain float64) *ConeDirectivityModelSubbandParameters

WithOuterGain sets the loudness of the audio the outside area of the cone emits.

type ContainerNodeDefinition added in v0.17.0 

type ContainerNodeDefinition struct {
	SoundEventNodeDefinition
}

ContainerNodeDefinition is an idiomatic wrapper over the Objective-C class PHASEContainerNodeDefinition.

It embeds SoundEventNodeDefinition, promoting that type's methods.

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

func ContainerNodeDefinitionFromID added in v0.17.0 

func ContainerNodeDefinitionFromID(id objc.ID) *ContainerNodeDefinition

ContainerNodeDefinitionFromID adopts an existing Objective-C object as a ContainerNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func New added in v0.17.0 

func New() *ContainerNodeDefinition

New creates a container node.

func NewContainerNodeDefinition added in v0.17.0 

func NewContainerNodeDefinition() *ContainerNodeDefinition

NewContainerNodeDefinition creates a new ContainerNodeDefinition.

func NewContainerNodeDefinitionWithIdentifier added in v0.17.0 

func NewContainerNodeDefinitionWithIdentifier(identifier string) *ContainerNodeDefinition

NewContainerNodeDefinitionWithIdentifier creates a container node with the given name.

func (*ContainerNodeDefinition) AddSubtree added in v0.17.0 

func (cnd *ContainerNodeDefinition) AddSubtree(subtree *SoundEventNodeDefinition)

AddSubtree adds a sound event node as a child.

type CullOption added in v0.17.0 

type CullOption int64

The actions the engine takes when it culls sound. 

const (
	// An option that culls sound by stopping playback.
	CullOptionTerminate CullOption = 0
	// An option that pauses playback and resumes at the beginning.
	CullOptionSleepWakeAtZero CullOption = 1
	// An option that pauses playback and resumes at a random position.
	CullOptionSleepWakeAtRandomOffset CullOption = 2
	// An option that pauses playback and resumes where it left off.
	CullOptionSleepWakeAtRealtimeOffset CullOption = 3
	// An option that indicates the framework takes no action to cull sound.
	CullOptionDoNotCull CullOption = 4
)

func (CullOption) String added in v0.17.0 

func (e CullOption) String() string

String returns the CullOption constant's name, or its numeric form when the value is not a known constant.

type CurveType added in v0.17.0 

type CurveType int64

Options that apply a mathematical function to an input value. 

const (
	// A curve that increases uniformly with its input.
	CurveTypeLinear CurveType = 1668435054
	// A curve that increases at a rate that squares its input.
	CurveTypeSquared CurveType = 1668436849
	// A curve that increases at a rate of one divided by the input’s square.
	CurveTypeInverseSquared CurveType = 1668434257
	// A curve that increases at a rate that cubes its input.
	CurveTypeCubed CurveType = 1668432757
	// A curve that increases at a rate of one divided by the input’s cube.
	CurveTypeInverseCubed CurveType = 1668434243
	// A sine curve.
	CurveTypeSine CurveType = 1668436846
	// An inverse sine curve.
	CurveTypeInverseSine CurveType = 1668434259
	// A sigmoid curve.
	CurveTypeSigmoid CurveType = 1668436839
	// An inverse sigmoid curve.
	CurveTypeInverseSigmoid CurveType = 1668434247
	// A curve that equals its start value for the entire duration.
	CurveTypeHoldStartValue CurveType = 1668434003
	// A curve that equals its end value for the entire duration.
	CurveTypeJumpToEndValue CurveType = 1668434501
)

func (CurveType) String added in v0.17.0 

func (e CurveType) String() string

String returns the CurveType constant's name, or its numeric form when the value is not a known constant.

type Definition added in v0.17.0 

type Definition struct {
	objref.Handle
}

Definition is an idiomatic wrapper over the Objective-C class PHASEDefinition.

Definition is an abstract base — you do not construct it directly. Construct one of MetaParameterDefinition, MixerDefinition, SoundEventNodeDefinition and pass it where a Definition is accepted.

A base class that adds a name to framework definitions.

func DefinitionFromID added in v0.17.0 

func DefinitionFromID(id objc.ID) *Definition

DefinitionFromID adopts an existing Objective-C object as a Definition (nil for 0), retaining it and registering a release finalizer.

func (*Definition) Description added in v0.17.0 

func (d *Definition) Description() string

Description returns the object's -description text.

func (*Definition) Identifier added in v0.17.0 

func (d *Definition) Identifier() string

Identifier returns the identifier.

func (*Definition) IsEqual added in v0.17.0 

func (d *Definition) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Definition) IsKind added in v0.17.0 

func (d *Definition) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Definition) String added in v0.17.0 

func (d *Definition) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type DefinitionProvider added in v0.17.0 

type DefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

DefinitionProvider is accepted wherever a PHASEDefinition (or one of its subclasses) is expected.

type DirectivityModelParameters added in v0.17.0 

type DirectivityModelParameters struct {
	objref.Handle
}

DirectivityModelParameters is an idiomatic wrapper over the Objective-C class PHASEDirectivityModelParameters.

DirectivityModelParameters is an abstract base — you do not construct it directly. Construct one of CardioidDirectivityModelParameters, ConeDirectivityModelParameters and pass it where a DirectivityModelParameters is accepted.

A base class for objects that direct sound.

func DirectivityModelParametersFromID added in v0.17.0 

func DirectivityModelParametersFromID(id objc.ID) *DirectivityModelParameters

DirectivityModelParametersFromID adopts an existing Objective-C object as a DirectivityModelParameters (nil for 0), retaining it and registering a release finalizer.

func (*DirectivityModelParameters) Description added in v0.17.0 

func (dmp *DirectivityModelParameters) Description() string

Description returns the object's -description text.

func (*DirectivityModelParameters) IsEqual added in v0.17.0 

func (dmp *DirectivityModelParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*DirectivityModelParameters) IsKind added in v0.17.0 

func (dmp *DirectivityModelParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*DirectivityModelParameters) String added in v0.17.0 

func (dmp *DirectivityModelParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type DirectivityModelParametersProvider added in v0.17.0 

type DirectivityModelParametersProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

DirectivityModelParametersProvider is accepted wherever a PHASEDirectivityModelParameters (or one of its subclasses) is expected.

type DispatchAutoreleaseFrequency added in v0.17.0 

type DispatchAutoreleaseFrequency uint64
const (
	DispatchAutoreleaseFrequencyInherit  DispatchAutoreleaseFrequency = 0
	DispatchAutoreleaseFrequencyWorkItem DispatchAutoreleaseFrequency = 1
	DispatchAutoreleaseFrequencyNever    DispatchAutoreleaseFrequency = 2
)

func (DispatchAutoreleaseFrequency) String added in v0.17.0 

func (e DispatchAutoreleaseFrequency) String() string

String returns the DispatchAutoreleaseFrequency constant's name, or its numeric form when the value is not a known constant.

type DispatchBlockFlags added in v0.17.0 

type DispatchBlockFlags uint64

Bitmask — values may be combined with |. 

const (
	DispatchBlockFlagsBarrier         DispatchBlockFlags = 1
	DispatchBlockFlagsDetached        DispatchBlockFlags = 2
	DispatchBlockFlagsAssignCurrent   DispatchBlockFlags = 4
	DispatchBlockFlagsNoQosClass      DispatchBlockFlags = 8
	DispatchBlockFlagsInheritQosClass DispatchBlockFlags = 16
	DispatchBlockFlagsEnforceQosClass DispatchBlockFlags = 32
)

func (DispatchBlockFlags) String added in v0.17.0 

func (e DispatchBlockFlags) String() string

String returns the DispatchBlockFlags constant's name, or its numeric form when the value is not a known constant.

type DistanceModelFadeOutParameters added in v0.17.0 

type DistanceModelFadeOutParameters struct {
	objref.Handle
}

DistanceModelFadeOutParameters is an idiomatic wrapper over the Objective-C class PHASEDistanceModelFadeOutParameters.

A distance over which the framework fades out sound.

func DistanceModelFadeOutParametersFromID added in v0.17.0 

func DistanceModelFadeOutParametersFromID(id objc.ID) *DistanceModelFadeOutParameters

DistanceModelFadeOutParametersFromID adopts an existing Objective-C object as a DistanceModelFadeOutParameters (nil for 0), retaining it and registering a release finalizer.

func NewDistanceModelFadeOutParametersWithCullDistance added in v0.17.0 

func NewDistanceModelFadeOutParametersWithCullDistance(cullDistance float64) *DistanceModelFadeOutParameters

NewDistanceModelFadeOutParametersWithCullDistance creates a distance beyond which sound sources stop playing.

func (*DistanceModelFadeOutParameters) CullDistance added in v0.17.0 

func (dmfop *DistanceModelFadeOutParameters) CullDistance() float64

CullDistance returns the cull distance.

func (*DistanceModelFadeOutParameters) Description added in v0.17.0 

func (dmfop *DistanceModelFadeOutParameters) Description() string

Description returns the object's -description text.

func (*DistanceModelFadeOutParameters) IsEqual added in v0.17.0 

func (dmfop *DistanceModelFadeOutParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*DistanceModelFadeOutParameters) IsKind added in v0.17.0 

func (dmfop *DistanceModelFadeOutParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*DistanceModelFadeOutParameters) String added in v0.17.0 

func (dmfop *DistanceModelFadeOutParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type DistanceModelParameters added in v0.17.0 

type DistanceModelParameters struct {
	objref.Handle
}

DistanceModelParameters is an idiomatic wrapper over the Objective-C class PHASEDistanceModelParameters.

DistanceModelParameters is an abstract base — you do not construct it directly. Construct one of EnvelopeDistanceModelParameters, GeometricSpreadingDistanceModelParameters and pass it where a DistanceModelParameters is accepted.

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

func DistanceModelParametersFromID added in v0.17.0 

func DistanceModelParametersFromID(id objc.ID) *DistanceModelParameters

DistanceModelParametersFromID adopts an existing Objective-C object as a DistanceModelParameters (nil for 0), retaining it and registering a release finalizer.

func (*DistanceModelParameters) Description added in v0.17.0 

func (dmp *DistanceModelParameters) Description() string

Description returns the object's -description text.

func (*DistanceModelParameters) FadeOutParameters added in v0.17.0 

func (dmp *DistanceModelParameters) FadeOutParameters() *DistanceModelFadeOutParameters

FadeOutParameters returns the fade out parameters.

func (*DistanceModelParameters) IsEqual added in v0.17.0 

func (dmp *DistanceModelParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*DistanceModelParameters) IsKind added in v0.17.0 

func (dmp *DistanceModelParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*DistanceModelParameters) String added in v0.17.0 

func (dmp *DistanceModelParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*DistanceModelParameters) WithFadeOutParameters added in v0.17.0 

func (dmp *DistanceModelParameters) WithFadeOutParameters(fadeOutParameters *DistanceModelFadeOutParameters) *DistanceModelParameters

WithFadeOutParameters sets a distance over which the framework fades out the mixer’s sound.

type DistanceModelParametersProvider added in v0.17.0 

type DistanceModelParametersProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

DistanceModelParametersProvider is accepted wherever a PHASEDistanceModelParameters (or one of its subclasses) is expected.

type Ducker added in v0.17.0 

type Ducker struct {
	objref.Handle
}

Ducker is an idiomatic wrapper over the Objective-C class PHASEDucker.

An object that manages competing sounds.

func DuckerFromID added in v0.17.0 

func DuckerFromID(id objc.ID) *Ducker

DuckerFromID adopts an existing Objective-C object as a Ducker (nil for 0), retaining it and registering a release finalizer.

func NewDuckerWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve added in v0.17.0 

func NewDuckerWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve(engine *Engine, sourceGroups []*Group, targetGroups []*Group, gain float64, attackTime float64, releaseTime float64, attackCurve CurveType, releaseCurve CurveType) *Ducker

NewDuckerWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve creates an object that manages competing sounds.

func (*Ducker) Activate added in v0.17.0 

func (d *Ducker) Activate()

Activate instructs the ducker to begin altering sound.

func (*Ducker) AttackCurve added in v0.17.0 

func (d *Ducker) AttackCurve() CurveType

AttackCurve returns the type of curve function to use during the attack phase of gain reduction.

func (*Ducker) AttackTime added in v0.17.0 

func (d *Ducker) AttackTime() float64

AttackTime returns the time for the attenuation gain to ramp into effect.

func (*Ducker) Deactivate added in v0.17.0 

func (d *Ducker) Deactivate()

Deactivate stops the ducker from altering sound.

func (*Ducker) Description added in v0.17.0 

func (d *Ducker) Description() string

Description returns the object's -description text.

func (*Ducker) Gain added in v0.17.0 

func (d *Ducker) Gain() float64

Gain returns linear gain scalar.

func (*Ducker) Identifier added in v0.17.0 

func (d *Ducker) Identifier() string

Identifier returns the identifier that uniquely represents this ducker.

func (*Ducker) IsActive added in v0.17.0 

func (d *Ducker) IsActive() bool

IsActive reports whether the ducker is active; otherwise, false.

func (*Ducker) IsEqual added in v0.17.0 

func (d *Ducker) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Ducker) IsKind added in v0.17.0 

func (d *Ducker) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Ducker) ReleaseCurve added in v0.17.0 

func (d *Ducker) ReleaseCurve() CurveType

ReleaseCurve returns the type of curve function to use during the release phase of gain reduction.

func (*Ducker) ReleaseTime added in v0.17.0 

func (d *Ducker) ReleaseTime() float64

ReleaseTime returns the time for the ducked sounds to ramp back to their original level.

func (*Ducker) SourceGroups added in v0.17.0 

func (d *Ducker) SourceGroups() []*Group

SourceGroups returns the source groups that will trigger the ducker when a sound in one of the source groups starts playback. The order of the returned elements is unspecified.

func (*Ducker) String added in v0.17.0 

func (d *Ducker) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Ducker) TargetGroups added in v0.17.0 

func (d *Ducker) TargetGroups() []*Group

TargetGroups returns the target groups that will be ducked when a sound in one of the source groups triggers the ducker. The order of the returned elements is unspecified.

type Engine added in v0.17.0 

type Engine struct {
	objref.Handle
}

Engine is an idiomatic wrapper over the Objective-C class PHASEEngine.

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

func EngineFromID added in v0.17.0 

func EngineFromID(id objc.ID) *Engine

EngineFromID adopts an existing Objective-C object as a Engine (nil for 0), retaining it and registering a release finalizer.

func NewEngineWithUpdateMode added in v0.17.0 

func NewEngineWithUpdateMode(updateMode UpdateMode) *Engine

NewEngineWithUpdateMode creates an engine updated by the app or framework.

func (*Engine) ActiveGroupPreset added in v0.17.0 

func (e *Engine) ActiveGroupPreset() *GroupPreset

ActiveGroupPreset returns the active group mixer preset in the system Returns nil if there are no active group presets in the engine. Activate or Deactivate the preset via [PHASEGroupPreset activate] and [PHASEGroupPreset deactivate]

func (*Engine) AssetRegistry added in v0.17.0 

func (e *Engine) AssetRegistry() *AssetRegistry

AssetRegistry returns a registry for assets available to the engine

func (*Engine) DefaultMedium added in v0.17.0 

func (e *Engine) DefaultMedium() *Medium

DefaultMedium returns the default medium in the engine. The default value is PHASEMediumPresetAir.

func (*Engine) DefaultReverbPreset added in v0.17.0 

func (e *Engine) DefaultReverbPreset() ReverbPreset

DefaultReverbPreset returns the default reverb preset in the engine. The default value is PHASEReverbPresetNone.

func (*Engine) Description added in v0.17.0 

func (e *Engine) Description() string

Description returns the object's -description text.

func (*Engine) Duckers added in v0.17.0 

func (e *Engine) Duckers() []*Ducker

Duckers returns an array of the ducker objects in the system Returns a dictionary of the ducker objects at the time it is retrieved.

Duckers returns the collection as a Go slice.

func (*Engine) Groups added in v0.17.0 

func (e *Engine) Groups() map[string]*Group

Groups returns a dictionary of the groups in the system Returns a dictionary of the groups at the time it is retrieved.

func (*Engine) IsEqual added in v0.17.0 

func (e *Engine) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Engine) IsKind added in v0.17.0 

func (e *Engine) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Engine) LastRenderTime added in v0.17.0 

func (e *Engine) LastRenderTime() obj.Object

LastRenderTime returns obtain the time for which the engine most recently rendered. Will return nil if the engine is not running

func (*Engine) OutputSpatializationMode added in v0.17.0 

func (e *Engine) OutputSpatializationMode() SpatializationMode

OutputSpatializationMode returns when set to a value other than PHASESpatializationModeAutomatic, overrides the default output spatializer and uses the specified one instead.

func (*Engine) Pause added in v0.17.0 

func (e *Engine) Pause()

Pause pauses all audio playback.

func (*Engine) RenderingState added in v0.17.0 

func (e *Engine) RenderingState() RenderingState

RenderingState returns the engine's current rendering state.

func (*Engine) RootObject added in v0.17.0 

func (e *Engine) RootObject() *Object

RootObject returns the root object of the engine's scene graph. 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.

func (*Engine) SoundEvents added in v0.17.0 

func (e *Engine) SoundEvents() []*SoundEvent

SoundEvents returns an array of the active sound event objects in the system 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.

SoundEvents returns the collection as a Go slice.

func (*Engine) StartAndReturnError added in v0.17.0 

func (e *Engine) StartAndReturnError() error

StartAndReturnError starts or resumes all audio playback.

StartAndReturnError returns an error if the operation did not succeed.

func (*Engine) Stop added in v0.17.0 

func (e *Engine) Stop()

Stop stops all audio playback.

func (*Engine) String added in v0.17.0 

func (e *Engine) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Engine) UnitsPerMeter added in v0.17.0 

func (e *Engine) UnitsPerMeter() float64

UnitsPerMeter returns the number of units in a meter. 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.

func (*Engine) UnitsPerSecond added in v0.17.0 

func (e *Engine) UnitsPerSecond() float64

UnitsPerSecond returns the number of units in a second. 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.

func (*Engine) Update added in v0.17.0 

func (e *Engine) Update()

Update processes app commands and increments framework processing.

func (*Engine) WithDefaultMedium added in v0.17.0 

func (e *Engine) WithDefaultMedium(defaultMedium *Medium) *Engine

WithDefaultMedium sets the physical matter through which sound travels.

func (*Engine) WithDefaultReverbPreset added in v0.17.0 

func (e *Engine) WithDefaultReverbPreset(defaultReverbPreset ReverbPreset) *Engine

WithDefaultReverbPreset sets the environmental surroundings that determine how sound resonates.

func (*Engine) WithOutputSpatializationMode added in v0.17.0 

func (e *Engine) WithOutputSpatializationMode(outputSpatializationMode SpatializationMode) *Engine

WithOutputSpatializationMode sets the mode the engine implements to create a 3D sound experience.

func (*Engine) WithUnitsPerMeter added in v0.17.0 

func (e *Engine) WithUnitsPerMeter(unitsPerMeter float64) *Engine

WithUnitsPerMeter sets a conversion factor from meters to your app’s preferred unit of measurement.

func (*Engine) WithUnitsPerSecond added in v0.17.0 

func (e *Engine) WithUnitsPerSecond(unitsPerSecond float64) *Engine

WithUnitsPerSecond sets a conversion factor from seconds to your app’s preferred unit of time.

type EntryID added in v0.17.0 

type EntryID int32
const (
	EntryIDFirstEntry EntryID = 0
	EntryIDNextEntry  EntryID = -1
	EntryIDLastEntry  EntryID = -2
)

func (EntryID) String added in v0.17.0 

func (e EntryID) String() string

String returns the EntryID constant's name, or its numeric form when the value is not a known constant.

type Envelope added in v0.17.0 

type Envelope struct {
	objref.Handle
}

Envelope is an idiomatic wrapper over the Objective-C class PHASEEnvelope.

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

func EnvelopeFromID added in v0.17.0 

func EnvelopeFromID(id objc.ID) *Envelope

EnvelopeFromID adopts an existing Objective-C object as a Envelope (nil for 0), retaining it and registering a release finalizer.

func NewEnvelopeWithStartPointSegments added in v0.17.0 

func NewEnvelopeWithStartPointSegments(startPoint unsafe.Pointer, segments []*EnvelopeSegment) *Envelope

NewEnvelopeWithStartPointSegments creates an envelope with a start point and segments.

func (*Envelope) Description added in v0.17.0 

func (e *Envelope) Description() string

Description returns the object's -description text.

func (*Envelope) Domain added in v0.17.0 

func (e *Envelope) Domain() *NumericPair

Domain returns the domain (along the x-axis). 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 (*Envelope) EvaluateForValue added in v0.17.0 

func (e *Envelope) EvaluateForValue(x_ float64) float64

EvaluateForValue provides the height of the envelope for an input value.

func (*Envelope) IsEqual added in v0.17.0 

func (e *Envelope) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Envelope) IsKind added in v0.17.0 

func (e *Envelope) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Envelope) Range added in v0.17.0 

func (e *Envelope) Range() *NumericPair

Range returns the range (along the y-axis). 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 (*Envelope) Segments added in v0.17.0 

func (e *Envelope) Segments() []*EnvelopeSegment

Segments returns the segments of the envelope.

Segments returns the collection as a Go slice.

func (*Envelope) StartPoint added in v0.18.0 

func (e *Envelope) StartPoint() unsafe.Pointer

StartPoint returns the start point of the envelope.

func (*Envelope) String added in v0.17.0 

func (e *Envelope) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type EnvelopeDistanceModelParameters added in v0.17.0 

type EnvelopeDistanceModelParameters struct {
	DistanceModelParameters
}

EnvelopeDistanceModelParameters is an idiomatic wrapper over the Objective-C class PHASEEnvelopeDistanceModelParameters.

It embeds DistanceModelParameters, promoting that type's methods.

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

func EnvelopeDistanceModelParametersFromID added in v0.17.0 

func EnvelopeDistanceModelParametersFromID(id objc.ID) *EnvelopeDistanceModelParameters

EnvelopeDistanceModelParametersFromID adopts an existing Objective-C object as a EnvelopeDistanceModelParameters (nil for 0), retaining it and registering a release finalizer.

func NewEnvelopeDistanceModelParametersWithEnvelope added in v0.17.0 

func NewEnvelopeDistanceModelParametersWithEnvelope(envelope *Envelope) *EnvelopeDistanceModelParameters

NewEnvelopeDistanceModelParametersWithEnvelope creates the distance model parameters with an envelope.

func (*EnvelopeDistanceModelParameters) Envelope added in v0.17.0 

func (edmp *EnvelopeDistanceModelParameters) Envelope() *Envelope

Envelope returns the envelope.

func (*EnvelopeDistanceModelParameters) WithFadeOutParameters added in v0.17.0 

func (edmp *EnvelopeDistanceModelParameters) WithFadeOutParameters(fadeOutParameters *DistanceModelFadeOutParameters) *EnvelopeDistanceModelParameters

WithFadeOutParameters sets a distance over which the framework fades out the mixer’s sound.

type EnvelopeSegment added in v0.17.0 

type EnvelopeSegment struct {
	objref.Handle
}

EnvelopeSegment is an idiomatic wrapper over the Objective-C class PHASEEnvelopeSegment.

A curved portion of an envelope.

func EnvelopeSegmentFromID added in v0.17.0 

func EnvelopeSegmentFromID(id objc.ID) *EnvelopeSegment

EnvelopeSegmentFromID adopts an existing Objective-C object as a EnvelopeSegment (nil for 0), retaining it and registering a release finalizer.

func NewEnvelopeSegmentWithEndPointCurveType added in v0.17.0 

func NewEnvelopeSegmentWithEndPointCurveType(endPoint unsafe.Pointer, curveType CurveType) *EnvelopeSegment

NewEnvelopeSegmentWithEndPointCurveType creates a curved portion of an envelope.

func (*EnvelopeSegment) CurveType added in v0.17.0 

func (es *EnvelopeSegment) CurveType() CurveType

CurveType returns the curve type of the envelope segment. The default value is PHASECurveTypeLinear.

func (*EnvelopeSegment) Description added in v0.17.0 

func (es *EnvelopeSegment) Description() string

Description returns the object's -description text.

func (*EnvelopeSegment) EndPoint added in v0.18.0 

func (es *EnvelopeSegment) EndPoint() unsafe.Pointer

EndPoint returns the end point of the envelope segment. The default value is [0.0, 0.0].

func (*EnvelopeSegment) IsEqual added in v0.17.0 

func (es *EnvelopeSegment) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*EnvelopeSegment) IsKind added in v0.17.0 

func (es *EnvelopeSegment) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*EnvelopeSegment) String added in v0.17.0 

func (es *EnvelopeSegment) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*EnvelopeSegment) WithCurveType added in v0.17.0 

func (es *EnvelopeSegment) WithCurveType(curveType CurveType) *EnvelopeSegment

WithCurveType sets a curve along the envelope that shapes the segment.

func (*EnvelopeSegment) WithEndPoint added in v0.17.0 

func (es *EnvelopeSegment) WithEndPoint(endPoint unsafe.Pointer) *EnvelopeSegment

WithEndPoint sets a point that identifies the end of the segment along the envelope.

type Error added in v0.17.0 

type Error int64

An error that PHASE reports. 

const (
	ErrorInitializeFailed Error = 1346913633
	ErrorInvalidObject    Error = 1346913634
)

func (Error) String added in v0.17.0 

func (e Error) String() string

String returns the Error constant's name, or its numeric form when the value is not a known constant.

type EvCmd 

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

func (EvCmd) String 

func (e EvCmd) String() string

String returns the EvCmd constant's name, or its numeric form when the value is not a known constant.

type FilesecProperty added in v0.17.0 

type FilesecProperty int32
const (
	FilesecPropertyOwner        FilesecProperty = 1
	FilesecPropertyGroup        FilesecProperty = 2
	FilesecPropertyUUID         FilesecProperty = 3
	FilesecPropertyMode         FilesecProperty = 4
	FilesecPropertyACL          FilesecProperty = 5
	FilesecPropertyGrpuuid      FilesecProperty = 6
	FilesecPropertyACLRaw       FilesecProperty = 100
	FilesecPropertyACLAllocsize FilesecProperty = 101
)

func (FilesecProperty) String added in v0.17.0 

func (e FilesecProperty) String() string

String returns the FilesecProperty constant's name, or its numeric form when the value is not a known constant.

type Flag added in v0.17.0 

type Flag int32
const (
	FlagFlagDeferInherit      Flag = 1
	FlagFlagNoInherit         Flag = 131072
	FlagEntryInherited        Flag = 16
	FlagEntryFileInherit      Flag = 32
	FlagEntryDirectoryInherit Flag = 64
	FlagEntryLimitInherit     Flag = 128
	FlagEntryOnlyInherit      Flag = 256
)

func (Flag) String added in v0.17.0 

func (e Flag) String() string

String returns the Flag constant's name, or its numeric form when the value is not a known constant.

type GeneratorNodeDefinition added in v0.17.0 

type GeneratorNodeDefinition struct {
	SoundEventNodeDefinition
}

GeneratorNodeDefinition is an idiomatic wrapper over the Objective-C class PHASEGeneratorNodeDefinition.

GeneratorNodeDefinition is an abstract base — you do not construct it directly. Construct one of PullStreamNodeDefinition, PushStreamNodeDefinition, SamplerNodeDefinition and pass it where a GeneratorNodeDefinition is accepted.

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

func GeneratorNodeDefinitionFromID added in v0.17.0 

func GeneratorNodeDefinitionFromID(id objc.ID) *GeneratorNodeDefinition

GeneratorNodeDefinitionFromID adopts an existing Objective-C object as a GeneratorNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*GeneratorNodeDefinition) CalibrationMode added in v0.17.0 

func (gnd *GeneratorNodeDefinition) CalibrationMode() CalibrationMode

CalibrationMode returns the generator's calibration mode. The default value is PHASECalibrationModeNone.

func (*GeneratorNodeDefinition) GainMetaParameterDefinition added in v0.17.0 

func (gnd *GeneratorNodeDefinition) GainMetaParameterDefinition() *NumberMetaParameterDefinition

GainMetaParameterDefinition returns optionally attach a metaparameter definition here to enable dynamic control of the gain during playback.

func (*GeneratorNodeDefinition) Group added in v0.17.0 

func (gnd *GeneratorNodeDefinition) Group() *Group

Group returns the PHASEGroup object this generator should be associated with for gain and rate control.

func (*GeneratorNodeDefinition) Level added in v0.17.0 

func (gnd *GeneratorNodeDefinition) Level() float64

Level returns the generator's level. The default value is 1.

func (*GeneratorNodeDefinition) MixerDefinition added in v0.17.0 

func (gnd *GeneratorNodeDefinition) MixerDefinition() *MixerDefinition

MixerDefinition returns the readonly property that returns the PHASEMixerDefinition this generator was created with and assigned to.

func (*GeneratorNodeDefinition) Rate added in v0.17.0 

func (gnd *GeneratorNodeDefinition) Rate() float64

Rate returns linear rate scalar.

func (*GeneratorNodeDefinition) RateMetaParameterDefinition added in v0.17.0 

func (gnd *GeneratorNodeDefinition) RateMetaParameterDefinition() *NumberMetaParameterDefinition

RateMetaParameterDefinition returns optionally attach a metaparameter definition here to enable dynamic control of the rate during playback.

func (*GeneratorNodeDefinition) SetCalibrationModeLevel added in v0.17.0 

func (gnd *GeneratorNodeDefinition) SetCalibrationModeLevel(calibrationMode CalibrationMode, level float64)

SetCalibrationModeLevel selects a loudness correction strategy and reference level.

func (*GeneratorNodeDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (gnd *GeneratorNodeDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *GeneratorNodeDefinition

WithGainMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s loudness.

func (*GeneratorNodeDefinition) WithGroup added in v0.17.0 

func (gnd *GeneratorNodeDefinition) WithGroup(group *Group) *GeneratorNodeDefinition

WithGroup sets a group this node conforms to for gain and rate control.

func (*GeneratorNodeDefinition) WithRate added in v0.17.0 

func (gnd *GeneratorNodeDefinition) WithRate(rate float64) *GeneratorNodeDefinition

WithRate sets a playback speed for the node’s audio.

func (*GeneratorNodeDefinition) WithRateMetaParameterDefinition added in v0.17.0 

func (gnd *GeneratorNodeDefinition) WithRateMetaParameterDefinition(rateMetaParameterDefinition NumberMetaParameterDefinitionProvider) *GeneratorNodeDefinition

WithRateMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s rate.

type GeneratorNodeDefinitionProvider added in v0.17.0 

type GeneratorNodeDefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

GeneratorNodeDefinitionProvider is accepted wherever a PHASEGeneratorNodeDefinition (or one of its subclasses) is expected.

type GeometricSpreadingDistanceModelParameters added in v0.17.0 

type GeometricSpreadingDistanceModelParameters struct {
	DistanceModelParameters
}

GeometricSpreadingDistanceModelParameters is an idiomatic wrapper over the Objective-C class PHASEGeometricSpreadingDistanceModelParameters.

It embeds DistanceModelParameters, promoting that type's methods.

An object that dissipates sound frequencies over distance.

func GeometricSpreadingDistanceModelParametersFromID added in v0.17.0 

func GeometricSpreadingDistanceModelParametersFromID(id objc.ID) *GeometricSpreadingDistanceModelParameters

GeometricSpreadingDistanceModelParametersFromID adopts an existing Objective-C object as a GeometricSpreadingDistanceModelParameters (nil for 0), retaining it and registering a release finalizer.

func NewGeometricSpreadingDistanceModelParameters added in v0.17.0 

func NewGeometricSpreadingDistanceModelParameters() *GeometricSpreadingDistanceModelParameters

NewGeometricSpreadingDistanceModelParameters creates a new GeometricSpreadingDistanceModelParameters.

func (*GeometricSpreadingDistanceModelParameters) RolloffFactor added in v0.17.0 

func (gsdmp *GeometricSpreadingDistanceModelParameters) RolloffFactor() float64

RolloffFactor returns the rolloff factor.

func (*GeometricSpreadingDistanceModelParameters) WithFadeOutParameters added in v0.17.0 

func (gsdmp *GeometricSpreadingDistanceModelParameters) WithFadeOutParameters(fadeOutParameters *DistanceModelFadeOutParameters) *GeometricSpreadingDistanceModelParameters

WithFadeOutParameters sets a distance over which the framework fades out the mixer’s sound.

func (*GeometricSpreadingDistanceModelParameters) WithRolloffFactor added in v0.17.0 

func (gsdmp *GeometricSpreadingDistanceModelParameters) WithRolloffFactor(rolloffFactor float64) *GeometricSpreadingDistanceModelParameters

WithRolloffFactor sets a value that fades specific frequencies over a distance.

type GlobalMetaParameterAsset added in v0.17.0 

type GlobalMetaParameterAsset struct {
	Asset
}

GlobalMetaParameterAsset is an idiomatic wrapper over the Objective-C class PHASEGlobalMetaParameterAsset.

It embeds Asset, promoting that type's methods.

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

func GlobalMetaParameterAssetFromID added in v0.17.0 

func GlobalMetaParameterAssetFromID(id objc.ID) *GlobalMetaParameterAsset

GlobalMetaParameterAssetFromID adopts an existing Objective-C object as a GlobalMetaParameterAsset (nil for 0), retaining it and registering a release finalizer.

func NewGlobalMetaParameterAsset added in v0.17.0 

func NewGlobalMetaParameterAsset() *GlobalMetaParameterAsset

NewGlobalMetaParameterAsset creates a new GlobalMetaParameterAsset.

type Group added in v0.17.0 

type Group struct {
	objref.Handle
}

Group is an idiomatic wrapper over the Objective-C class PHASEGroup.

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

func GroupFromID added in v0.17.0 

func GroupFromID(id objc.ID) *Group

GroupFromID adopts an existing Objective-C object as a Group (nil for 0), retaining it and registering a release finalizer.

func NewGroupWithIdentifier added in v0.17.0 

func NewGroupWithIdentifier(identifier string) *Group

NewGroupWithIdentifier creates a group with a unique name.

func (*Group) Description added in v0.17.0 

func (g *Group) Description() string

Description returns the object's -description text.

func (*Group) FadeGainDurationCurveType added in v0.17.0 

func (g *Group) FadeGainDurationCurveType(gain float64, duration float64, curveType CurveType)

FadeGainDurationCurveType adjusts the volume of the sounds in a group gradually.

func (*Group) FadeRateDurationCurveType added in v0.17.0 

func (g *Group) FadeRateDurationCurveType(rate float64, duration float64, curveType CurveType)

FadeRateDurationCurveType adjusts the playback speed of the sounds in a group gradually.

func (*Group) Gain added in v0.17.0 

func (g *Group) Gain() float64

Gain returns linear gain scalar.

func (*Group) Identifier added in v0.17.0 

func (g *Group) Identifier() string

Identifier returns the identifier that uniquely represents this group.

func (*Group) IsEqual added in v0.17.0 

func (g *Group) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Group) IsKind added in v0.17.0 

func (g *Group) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Group) IsMuted added in v0.17.0 

func (g *Group) IsMuted() bool

IsMuted reports whether this group is muted.

func (*Group) IsSoloed added in v0.17.0 

func (g *Group) IsSoloed() bool

IsSoloed reports whether this group is soloed.

func (*Group) Mute added in v0.17.0 

func (g *Group) Mute()

Mute silences the group.

func (*Group) Rate added in v0.17.0 

func (g *Group) Rate() float64

Rate returns linear rate scalar.

func (*Group) Register added in v0.17.0 

func (g *Group) Register(engine *Engine)

Register adds the group to the engine’s dictionary.

func (*Group) Solo added in v0.17.0 

func (g *Group) Solo()

Solo silences all other groups.

func (*Group) String added in v0.17.0 

func (g *Group) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Group) Unmute added in v0.17.0 

func (g *Group) Unmute()

Unmute restores the group’s volume.

func (*Group) UnregisterFromEngine added in v0.17.0 

func (g *Group) UnregisterFromEngine()

UnregisterFromEngine removes the group from the engine’s dictionary.

func (*Group) Unsolo added in v0.17.0 

func (g *Group) Unsolo()

Unsolo restores the other groups’ volume.

func (*Group) WithGain added in v0.17.0 

func (g *Group) WithGain(gain float64) *Group

WithGain sets modifies the volume of the group’s sounds.

func (*Group) WithRate added in v0.17.0 

func (g *Group) WithRate(rate float64) *Group

WithRate sets the group’s playback speed.

type GroupPreset added in v0.17.0 

type GroupPreset struct {
	objref.Handle
}

GroupPreset is an idiomatic wrapper over the Objective-C class PHASEGroupPreset.

A collection of settings for groups.

func GroupPresetFromID added in v0.17.0 

func GroupPresetFromID(id objc.ID) *GroupPreset

GroupPresetFromID adopts an existing Objective-C object as a GroupPreset (nil for 0), retaining it and registering a release finalizer.

func NewGroupPresetWithEngineSettingsTimeToTargetTimeToReset added in v0.17.0 

func NewGroupPresetWithEngineSettingsTimeToTargetTimeToReset(engine *Engine, settings map[string]*GroupPresetSetting, timeToTarget float64, timeToReset float64) *GroupPreset

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

func (*GroupPreset) Activate added in v0.17.0 

func (gp *GroupPreset) Activate()

Activate applies settings to the designated groups.

func (*GroupPreset) ActivateWithTimeToTargetOverride added in v0.17.0 

func (gp *GroupPreset) ActivateWithTimeToTargetOverride(timeToTargetOverride float64)

ActivateWithTimeToTargetOverride applies settings with an overriden fade duration.

func (*GroupPreset) Deactivate added in v0.17.0 

func (gp *GroupPreset) Deactivate()

Deactivate reverts settings for the preset’s groups.

func (*GroupPreset) DeactivateWithTimeToResetOverride added in v0.17.0 

func (gp *GroupPreset) DeactivateWithTimeToResetOverride(timeToResetOverride float64)

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

func (*GroupPreset) Description added in v0.17.0 

func (gp *GroupPreset) Description() string

Description returns the object's -description text.

func (*GroupPreset) IsEqual added in v0.17.0 

func (gp *GroupPreset) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*GroupPreset) IsKind added in v0.17.0 

func (gp *GroupPreset) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*GroupPreset) Settings added in v0.17.0 

func (gp *GroupPreset) Settings() map[string]*GroupPresetSetting

Settings returns the collection of PHASEGroupPresetSetting objects to apply when this preset is activated.

func (*GroupPreset) String added in v0.17.0 

func (gp *GroupPreset) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*GroupPreset) TimeToReset added in v0.17.0 

func (gp *GroupPreset) TimeToReset() float64

TimeToReset returns the time interval that all group settings in this preset will take to gradually fade to the unity value

func (*GroupPreset) TimeToTarget added in v0.17.0 

func (gp *GroupPreset) TimeToTarget() float64

TimeToTarget returns the time interval that all group settings in this preset will take to gradually fade to the new value

type GroupPresetSetting added in v0.17.0 

type GroupPresetSetting struct {
	objref.Handle
}

GroupPresetSetting is an idiomatic wrapper over the Objective-C class PHASEGroupPresetSetting.

Settings for group presets.

func GroupPresetSettingFromID added in v0.17.0 

func GroupPresetSettingFromID(id objc.ID) *GroupPresetSetting

GroupPresetSettingFromID adopts an existing Objective-C object as a GroupPresetSetting (nil for 0), retaining it and registering a release finalizer.

func NewGroupPresetSettingWithGainRateGainCurveTypeRateCurveType added in v0.17.0 

func NewGroupPresetSettingWithGainRateGainCurveTypeRateCurveType(gain float64, rate float64, gainCurveType CurveType, rateCurveType CurveType) *GroupPresetSetting

NewGroupPresetSettingWithGainRateGainCurveTypeRateCurveType creates a group preset setting.

func (*GroupPresetSetting) Description added in v0.17.0 

func (gps *GroupPresetSetting) Description() string

Description returns the object's -description text.

func (*GroupPresetSetting) Gain added in v0.17.0 

func (gps *GroupPresetSetting) Gain() float64

Gain returns linear gain scalar.

func (*GroupPresetSetting) GainCurveType added in v0.17.0 

func (gps *GroupPresetSetting) GainCurveType() CurveType

GainCurveType returns the type of curve to apply to the gain as the preset changes to this new setting.

func (*GroupPresetSetting) IsEqual added in v0.17.0 

func (gps *GroupPresetSetting) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*GroupPresetSetting) IsKind added in v0.17.0 

func (gps *GroupPresetSetting) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*GroupPresetSetting) Rate added in v0.17.0 

func (gps *GroupPresetSetting) Rate() float64

Rate returns linear rate scalar.

func (*GroupPresetSetting) RateCurveType added in v0.17.0 

func (gps *GroupPresetSetting) RateCurveType() CurveType

RateCurveType returns the type of curve to apply to the rate as the preset changes to this new setting.

func (*GroupPresetSetting) String added in v0.17.0 

func (gps *GroupPresetSetting) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type Idtype added in v0.17.0 

type Idtype int32
const (
	IdtypeAll  Idtype = 0
	IdtypePid  Idtype = 1
	IdtypePgid Idtype = 2
)

func (Idtype) String added in v0.17.0 

func (e Idtype) String() string

String returns the Idtype constant's name, or its numeric form when the value is not a known constant.

type IpcInfoObjectType added in v0.17.0 

type IpcInfoObjectType uint32
const (
	IpcInfoObjectTypeNone               IpcInfoObjectType = 0
	IpcInfoObjectTypeThreadControl      IpcInfoObjectType = 1
	IpcInfoObjectTypeTaskControl        IpcInfoObjectType = 2
	IpcInfoObjectTypeHost               IpcInfoObjectType = 3
	IpcInfoObjectTypeHostPriv           IpcInfoObjectType = 4
	IpcInfoObjectTypeProcessor          IpcInfoObjectType = 5
	IpcInfoObjectTypeProcessorSet       IpcInfoObjectType = 6
	IpcInfoObjectTypeProcessorSetName   IpcInfoObjectType = 7
	IpcInfoObjectTypeTimer              IpcInfoObjectType = 8
	IpcInfoObjectTypePortSubstOnce      IpcInfoObjectType = 9
	IpcInfoObjectTypeMig                IpcInfoObjectType = 10
	IpcInfoObjectTypeMemoryObject       IpcInfoObjectType = 11
	IpcInfoObjectTypeXmmPager           IpcInfoObjectType = 12
	IpcInfoObjectTypeXmmKernel          IpcInfoObjectType = 13
	IpcInfoObjectTypeXmmReply           IpcInfoObjectType = 14
	IpcInfoObjectTypeUndReply           IpcInfoObjectType = 15
	IpcInfoObjectTypeHostNotify         IpcInfoObjectType = 16
	IpcInfoObjectTypeHostSecurity       IpcInfoObjectType = 17
	IpcInfoObjectTypeLedger             IpcInfoObjectType = 18
	IpcInfoObjectTypeMainDevice         IpcInfoObjectType = 19
	IpcInfoObjectTypeTaskName           IpcInfoObjectType = 20
	IpcInfoObjectTypeSubsystem          IpcInfoObjectType = 21
	IpcInfoObjectTypeIODoneQueue        IpcInfoObjectType = 22
	IpcInfoObjectTypeSemaphore          IpcInfoObjectType = 23
	IpcInfoObjectTypeLockSet            IpcInfoObjectType = 24
	IpcInfoObjectTypeClock              IpcInfoObjectType = 25
	IpcInfoObjectTypeClockCtrl          IpcInfoObjectType = 26
	IpcInfoObjectTypeIokitIdent         IpcInfoObjectType = 27
	IpcInfoObjectTypeNamedEntry         IpcInfoObjectType = 28
	IpcInfoObjectTypeIokitConnect       IpcInfoObjectType = 29
	IpcInfoObjectTypeIokitObject        IpcInfoObjectType = 30
	IpcInfoObjectTypeUpl                IpcInfoObjectType = 31
	IpcInfoObjectTypeMemObjControl      IpcInfoObjectType = 32
	IpcInfoObjectTypeAuSessionport      IpcInfoObjectType = 33
	IpcInfoObjectTypeFileport           IpcInfoObjectType = 34
	IpcInfoObjectTypeLabelh             IpcInfoObjectType = 35
	IpcInfoObjectTypeTaskResume         IpcInfoObjectType = 36
	IpcInfoObjectTypeVoucher            IpcInfoObjectType = 37
	IpcInfoObjectTypeVoucherAttrControl IpcInfoObjectType = 38
	IpcInfoObjectTypeWorkInterval       IpcInfoObjectType = 39
	IpcInfoObjectTypeUxHandler          IpcInfoObjectType = 40
	IpcInfoObjectTypeUextObject         IpcInfoObjectType = 41
	IpcInfoObjectTypeArcadeReg          IpcInfoObjectType = 42
	IpcInfoObjectTypeEventlink          IpcInfoObjectType = 43
	IpcInfoObjectTypeTaskInspect        IpcInfoObjectType = 44
	IpcInfoObjectTypeTaskRead           IpcInfoObjectType = 45
	IpcInfoObjectTypeThreadInspect      IpcInfoObjectType = 46
	IpcInfoObjectTypeThreadRead         IpcInfoObjectType = 47
	IpcInfoObjectTypeSuidCred           IpcInfoObjectType = 48
	IpcInfoObjectTypeHypervisor         IpcInfoObjectType = 49
	IpcInfoObjectTypeTaskIDToken        IpcInfoObjectType = 50
	IpcInfoObjectTypeTaskFatal          IpcInfoObjectType = 51
	IpcInfoObjectTypeKcdata             IpcInfoObjectType = 52
	IpcInfoObjectTypeExclavesResource   IpcInfoObjectType = 53
	IpcInfoObjectTypeThreadResume       IpcInfoObjectType = 54
	IpcInfoObjectTypeUnknown            IpcInfoObjectType = 4294967295
)

func (IpcInfoObjectType) String added in v0.17.0 

func (e IpcInfoObjectType) String() string

String returns the IpcInfoObjectType constant's name, or its numeric form when the value is not a known constant.

type LaunchDataType added in v0.17.0 

type LaunchDataType int32
const (
	LaunchDataTypeDictionary LaunchDataType = 1
	LaunchDataTypeArray      LaunchDataType = 2
	LaunchDataTypeFd         LaunchDataType = 3
	LaunchDataTypeInteger    LaunchDataType = 4
	LaunchDataTypeReal       LaunchDataType = 5
	LaunchDataTypeBool       LaunchDataType = 6
	LaunchDataTypeString     LaunchDataType = 7
	LaunchDataTypeOpaque     LaunchDataType = 8
	LaunchDataTypeErrno      LaunchDataType = 9
	LaunchDataTypeMachport   LaunchDataType = 10
)

func (LaunchDataType) String added in v0.17.0 

func (e LaunchDataType) String() string

String returns the LaunchDataType constant's name, or its numeric form when the value is not a known constant.

type Listener added in v0.17.0 

type Listener struct {
	Object
}

Listener is an idiomatic wrapper over the Objective-C class PHASEListener.

It embeds Object, promoting that type's methods.

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

func ListenerFromID added in v0.17.0 

func ListenerFromID(id objc.ID) *Listener

ListenerFromID adopts an existing Objective-C object as a Listener (nil for 0), retaining it and registering a release finalizer.

func NewListenerWithEngine added in v0.17.0 

func NewListenerWithEngine(engine *Engine) *Listener

NewListenerWithEngine creates a listener with the given engine.

func (*Listener) AutomaticHeadTrackingFlags added in v0.17.0 

func (l *Listener) AutomaticHeadTrackingFlags() AutomaticHeadTrackingFlags

AutomaticHeadTrackingFlags returns a combination of flags to express automatic headtracking behaviors for this listener.

func (*Listener) Gain added in v0.17.0 

func (l *Listener) Gain() float64

Gain returns linear gain scalar.

func (*Listener) WithAutomaticHeadTrackingFlags added in v0.17.0 

func (l *Listener) WithAutomaticHeadTrackingFlags(automaticHeadTrackingFlags AutomaticHeadTrackingFlags) *Listener

WithAutomaticHeadTrackingFlags sets a combination of flags to express automatic headtracking behaviors for this listener.

func (*Listener) WithGain added in v0.17.0 

func (l *Listener) WithGain(gain float64) *Listener

WithGain sets modifies the volume of all audio playback for the listener’s mixers.

func (*Listener) WithTransform added in v0.17.0 

func (l *Listener) WithTransform(transform unsafe.Pointer) *Listener

WithTransform sets a matrix, in local coordinates, that determines the object’s pose in the scene.

func (*Listener) WithWorldTransform added in v0.17.0 

func (l *Listener) WithWorldTransform(worldTransform unsafe.Pointer) *Listener

WithWorldTransform sets a matrix, in scene coordinates, that determines the object’s pose in the scene.

type MDLabelDomain 

type MDLabelDomain int32

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

String returns the MDLabelDomain constant's name, or its numeric form when the value is not a known constant.

type MDQueryOptionFlags 

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

func (MDQueryOptionFlags) String 

func (e MDQueryOptionFlags) String() string

String returns the MDQueryOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MDQuerySortOptionFlags 

type MDQuerySortOptionFlags int32
const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String 

func (e MDQuerySortOptionFlags) String() string

String returns the MDQuerySortOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlags added in v0.17.0 

type MachVMRangeFlags uint64

Bitmask — values may be combined with |. 

const (
	MachVMRangeFlagsNone MachVMRangeFlags = 0
)

func (MachVMRangeFlags) String added in v0.17.0 

func (e MachVMRangeFlags) String() string

String returns the MachVMRangeFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlavor added in v0.17.0 

type MachVMRangeFlavor uint32
const (
	MachVMRangeFlavorInvalid MachVMRangeFlavor = 0
	MachVMRangeFlavorV1      MachVMRangeFlavor = 1
)

func (MachVMRangeFlavor) String added in v0.17.0 

func (e MachVMRangeFlavor) String() string

String returns the MachVMRangeFlavor constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeTag added in v0.17.0 

type MachVMRangeTag uint16
const (
	MachVMRangeTagDefault MachVMRangeTag = 0
	MachVMRangeTagData    MachVMRangeTag = 1
	MachVMRangeTagFixed   MachVMRangeTag = 2
)

func (MachVMRangeTag) String added in v0.17.0 

func (e MachVMRangeTag) String() string

String returns the MachVMRangeTag constant's name, or its numeric form when the value is not a known constant.

type MappedMetaParameterDefinition added in v0.17.0 

type MappedMetaParameterDefinition struct {
	NumberMetaParameterDefinition
}

MappedMetaParameterDefinition is an idiomatic wrapper over the Objective-C class PHASEMappedMetaParameterDefinition.

It embeds NumberMetaParameterDefinition, promoting that type's methods.

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

func MappedMetaParameterDefinitionFromID added in v0.17.0 

func MappedMetaParameterDefinitionFromID(id objc.ID) *MappedMetaParameterDefinition

MappedMetaParameterDefinitionFromID adopts an existing Objective-C object as a MappedMetaParameterDefinition (nil for 0), retaining it and registering a release finalizer.

func NewMappedMetaParameterDefinitionWithInputMetaParameterDefinitionEnvelope added in v0.17.0 

func NewMappedMetaParameterDefinitionWithInputMetaParameterDefinitionEnvelope(inputMetaParameterDefinition *NumberMetaParameterDefinition, envelope *Envelope) *MappedMetaParameterDefinition

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

func NewMappedMetaParameterDefinitionWithInputMetaParameterDefinitionEnvelopeIdentifier added in v0.17.0 

func NewMappedMetaParameterDefinitionWithInputMetaParameterDefinitionEnvelopeIdentifier(inputMetaParameterDefinition *NumberMetaParameterDefinition, envelope *Envelope, identifier string) *MappedMetaParameterDefinition

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

func (*MappedMetaParameterDefinition) Envelope added in v0.17.0 

func (mmpd *MappedMetaParameterDefinition) Envelope() *Envelope

Envelope returns an Envelope to define segments of curves

func (*MappedMetaParameterDefinition) InputMetaParameterDefinition added in v0.17.0 

func (mmpd *MappedMetaParameterDefinition) InputMetaParameterDefinition() *NumberMetaParameterDefinition

InputMetaParameterDefinition returns the readonly PHASENumberMetaParameterDefinition that this metaparameter definition was initialized with

type Material added in v0.17.0 

type Material struct {
	objref.Handle
}

Material is an idiomatic wrapper over the Objective-C class PHASEMaterial.

Surface characteristics that determine the acoustic properties of an object.

func MaterialFromID added in v0.17.0 

func MaterialFromID(id objc.ID) *Material

MaterialFromID adopts an existing Objective-C object as a Material (nil for 0), retaining it and registering a release finalizer.

func NewMaterialWithEnginePreset added in v0.17.0 

func NewMaterialWithEnginePreset(engine *Engine, preset MaterialPreset) *Material

NewMaterialWithEnginePreset creates a material with the given preset.

func (*Material) Description added in v0.17.0 

func (m *Material) Description() string

Description returns the object's -description text.

func (*Material) IsEqual added in v0.17.0 

func (m *Material) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Material) IsKind added in v0.17.0 

func (m *Material) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Material) String added in v0.17.0 

func (m *Material) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MaterialPreset added in v0.17.0 

type MaterialPreset 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.
	MaterialPresetCardboard MaterialPreset = 1833136740
	// A surface characteristic that produces the acoustic quality of glass.
	MaterialPresetGlass MaterialPreset = 1833397363
	// A surface characteristic that produces the acoustic quality of brick.
	MaterialPresetBrick MaterialPreset = 1833071211
	// A surface characteristic that produces the acoustic quality of concrete.
	MaterialPresetConcrete MaterialPreset = 1833132914
	// A surface characteristic that produces the acoustic quality of drywall.
	MaterialPresetDrywall MaterialPreset = 1833202295
	// A surface characteristic that produces the acoustic quality of wood.
	MaterialPresetWood MaterialPreset = 1834448228
)

func (MaterialPreset) String added in v0.17.0 

func (e MaterialPreset) String() string

String returns the MaterialPreset constant's name, or its numeric form when the value is not a known constant.

type Medium added in v0.17.0 

type Medium struct {
	objref.Handle
}

Medium is an idiomatic wrapper over the Objective-C class PHASEMedium.

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

func MediumFromID added in v0.17.0 

func MediumFromID(id objc.ID) *Medium

MediumFromID adopts an existing Objective-C object as a Medium (nil for 0), retaining it and registering a release finalizer.

func NewMediumWithEnginePreset added in v0.17.0 

func NewMediumWithEnginePreset(engine *Engine, preset MediumPreset) *Medium

NewMediumWithEnginePreset creates a medium.

func (*Medium) Description added in v0.17.0 

func (m *Medium) Description() string

Description returns the object's -description text.

func (*Medium) IsEqual added in v0.17.0 

func (m *Medium) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Medium) IsKind added in v0.17.0 

func (m *Medium) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Medium) String added in v0.17.0 

func (m *Medium) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MediumPreset added in v0.17.0 

type MediumPreset int64

Predetermined qualities of an environment that affect how sound transmits. 

const (
	MediumPresetAir MediumPreset = 1835286898
)

func (MediumPreset) String added in v0.17.0 

func (e MediumPreset) String() string

String returns the MediumPreset constant's name, or its numeric form when the value is not a known constant.

type MetaParameter added in v0.17.0 

type MetaParameter struct {
	objref.Handle
}

MetaParameter is an idiomatic wrapper over the Objective-C class PHASEMetaParameter.

MetaParameter is an abstract base — you do not construct it directly. Construct one of NumberMetaParameter, StringMetaParameter and pass it where a MetaParameter is accepted.

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

func MetaParameterFromID added in v0.17.0 

func MetaParameterFromID(id objc.ID) *MetaParameter

MetaParameterFromID adopts an existing Objective-C object as a MetaParameter (nil for 0), retaining it and registering a release finalizer.

func (*MetaParameter) Description added in v0.17.0 

func (mp *MetaParameter) Description() string

Description returns the object's -description text.

func (*MetaParameter) Identifier added in v0.17.0 

func (mp *MetaParameter) Identifier() string

Identifier returns the identifier that uniquely represents this metaparameter.

func (*MetaParameter) IsEqual added in v0.17.0 

func (mp *MetaParameter) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MetaParameter) IsKind added in v0.17.0 

func (mp *MetaParameter) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MetaParameter) String added in v0.17.0 

func (mp *MetaParameter) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MetaParameter) Value added in v0.17.0 

func (mp *MetaParameter) Value() obj.Object

Value returns the value of this metaparameter

func (*MetaParameter) WithValue added in v0.17.0 

func (mp *MetaParameter) WithValue(value obj.Object) *MetaParameter

WithValue sets a value for the metaparameter.

type MetaParameterDefinition added in v0.17.0 

type MetaParameterDefinition struct {
	Definition
}

MetaParameterDefinition is an idiomatic wrapper over the Objective-C class PHASEMetaParameterDefinition.

MetaParameterDefinition is an abstract base — you do not construct it directly. Construct one of NumberMetaParameterDefinition, StringMetaParameterDefinition and pass it where a MetaParameterDefinition is accepted.

A specification for a named parameter with a constant value.

func MetaParameterDefinitionFromID added in v0.17.0 

func MetaParameterDefinitionFromID(id objc.ID) *MetaParameterDefinition

MetaParameterDefinitionFromID adopts an existing Objective-C object as a MetaParameterDefinition (nil for 0), retaining it and registering a release finalizer.

func (*MetaParameterDefinition) Value added in v0.17.0 

func (mpd *MetaParameterDefinition) Value() obj.Object

Value returns the value.

type MetaParameterDefinitionProvider added in v0.17.0 

type MetaParameterDefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MetaParameterDefinitionProvider is accepted wherever a PHASEMetaParameterDefinition (or one of its subclasses) is expected.

type MetaParameterProvider added in v0.17.0 

type MetaParameterProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MetaParameterProvider is accepted wherever a PHASEMetaParameter (or one of its subclasses) is expected.

type Mixer added in v0.17.0 

type Mixer struct {
	objref.Handle
}

Mixer is an idiomatic wrapper over the Objective-C class PHASEMixer.

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

func MixerFromID added in v0.17.0 

func MixerFromID(id objc.ID) *Mixer

MixerFromID adopts an existing Objective-C object as a Mixer (nil for 0), retaining it and registering a release finalizer.

func NewMixer added in v0.17.0 

func NewMixer() *Mixer

NewMixer creates a new Mixer.

func (*Mixer) Description added in v0.17.0 

func (m *Mixer) Description() string

Description returns the object's -description text.

func (*Mixer) Gain added in v0.17.0 

func (m *Mixer) Gain() float64

Gain returns linear gain scalar.

func (*Mixer) GainMetaParameter added in v0.17.0 

func (m *Mixer) GainMetaParameter() *MetaParameter

GainMetaParameter returns the metaparameter that can be used to adjust the gain during playback

func (*Mixer) Identifier added in v0.17.0 

func (m *Mixer) Identifier() string

Identifier returns the identifier that uniquely represents this mixer.

func (*Mixer) IsEqual added in v0.17.0 

func (m *Mixer) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Mixer) IsKind added in v0.17.0 

func (m *Mixer) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Mixer) String added in v0.17.0 

func (m *Mixer) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MixerDefinition added in v0.17.0 

type MixerDefinition struct {
	Definition
}

MixerDefinition is an idiomatic wrapper over the Objective-C class PHASEMixerDefinition.

MixerDefinition is an abstract base — you do not construct it directly. Construct one of AmbientMixerDefinition, ChannelMixerDefinition, SpatialMixerDefinition and pass it where a MixerDefinition is accepted.

An object to initialize a mixer with a given configuration.

func MixerDefinitionFromID added in v0.17.0 

func MixerDefinitionFromID(id objc.ID) *MixerDefinition

MixerDefinitionFromID adopts an existing Objective-C object as a MixerDefinition (nil for 0), retaining it and registering a release finalizer.

func (*MixerDefinition) Gain added in v0.17.0 

func (md *MixerDefinition) Gain() float64

Gain returns linear gain scalar.

func (*MixerDefinition) GainMetaParameterDefinition added in v0.17.0 

func (md *MixerDefinition) GainMetaParameterDefinition() *NumberMetaParameterDefinition

GainMetaParameterDefinition returns optionally attach a metaparameter definition here to enable real-time control of the gain during playback.

func (*MixerDefinition) WithGain added in v0.17.0 

func (md *MixerDefinition) WithGain(gain float64) *MixerDefinition

WithGain sets the mixer’s volume.

func (*MixerDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (md *MixerDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *MixerDefinition

WithGainMetaParameterDefinition sets a template for a parameter that changes the mixer’s volume gradually over a period of time.

type MixerDefinitionProvider added in v0.17.0 

type MixerDefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MixerDefinitionProvider is accepted wherever a PHASEMixerDefinition (or one of its subclasses) is expected.

type MixerParameters added in v0.17.0 

type MixerParameters struct {
	objref.Handle
}

MixerParameters is an idiomatic wrapper over the Objective-C class PHASEMixerParameters.

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

func MixerParametersFromID added in v0.17.0 

func MixerParametersFromID(id objc.ID) *MixerParameters

MixerParametersFromID adopts an existing Objective-C object as a MixerParameters (nil for 0), retaining it and registering a release finalizer.

func NewMixerParameters added in v0.17.0 

func NewMixerParameters() *MixerParameters

NewMixerParameters creates a new MixerParameters.

func (*MixerParameters) AddAmbientMixerParametersWithIdentifierListener added in v0.17.0 

func (mp *MixerParameters) AddAmbientMixerParametersWithIdentifierListener(identifier string, listener *Listener)

AddAmbientMixerParametersWithIdentifierListener adds runtime parameters for an ambient mixer.

func (*MixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener added in v0.17.0 

func (mp *MixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener(identifier string, source *Source, listener *Listener)

AddSpatialMixerParametersWithIdentifierSourceListener adds runtime parameters for a spatial mixer.

func (*MixerParameters) Description added in v0.17.0 

func (mp *MixerParameters) Description() string

Description returns the object's -description text.

func (*MixerParameters) IsEqual added in v0.17.0 

func (mp *MixerParameters) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MixerParameters) IsKind added in v0.17.0 

func (mp *MixerParameters) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MixerParameters) String added in v0.17.0 

func (mp *MixerParameters) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MpoFlags added in v0.17.0 

type MpoFlags uint32

Bitmask — values may be combined with |. 

const (
	MpoFlagsPort                        MpoFlags = 0
	MpoFlagsServicePort                 MpoFlags = 1024
	MpoFlagsConnectionPort              MpoFlags = 2048
	MpoFlagsReplyPort                   MpoFlags = 4096
	MpoFlagsWeakReplyPort               MpoFlags = 16384
	MpoFlagsNotificationPort            MpoFlags = 17408
	MpoFlagsExceptionPort               MpoFlags = 32768
	MpoFlagsConnectionPortWithPortArray MpoFlags = 65536
)

func (MpoFlags) String added in v0.17.0 

func (e MpoFlags) String() string

String returns the MpoFlags constant's name, or its numeric form when the value is not a known constant.

type NXMouseButton 

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

func (NXMouseButton) String 

func (e NXMouseButton) String() string

String returns the NXMouseButton constant's name, or its numeric form when the value is not a known constant.

type NormalizationMode added in v0.17.0 

type NormalizationMode 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.
	NormalizationModeNone NormalizationMode = 0
	// A mode that instructs the framework to adjust a sound’s volume according to the user’s output device.
	NormalizationModeDynamic NormalizationMode = 1
)

func (NormalizationMode) String added in v0.17.0 

func (e NormalizationMode) String() string

String returns the NormalizationMode constant's name, or its numeric form when the value is not a known constant.

type NumberMetaParameter added in v0.17.0 

type NumberMetaParameter struct {
	MetaParameter
}

NumberMetaParameter is an idiomatic wrapper over the Objective-C class PHASENumberMetaParameter.

It embeds MetaParameter, promoting that type's methods.

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

func NewNumberMetaParameter added in v0.17.0 

func NewNumberMetaParameter() *NumberMetaParameter

NewNumberMetaParameter creates a new NumberMetaParameter.

func NumberMetaParameterFromID added in v0.17.0 

func NumberMetaParameterFromID(id objc.ID) *NumberMetaParameter

NumberMetaParameterFromID adopts an existing Objective-C object as a NumberMetaParameter (nil for 0), retaining it and registering a release finalizer.

func (*NumberMetaParameter) FadeToValueDuration added in v0.17.0 

func (nmp *NumberMetaParameter) FadeToValueDuration(value float64, duration float64)

FadeToValueDuration sets the value gradually over the given amount of time.

func (*NumberMetaParameter) Maximum added in v0.17.0 

func (nmp *NumberMetaParameter) Maximum() float64

Maximum returns the maximum value this metaparameter can be set to

func (*NumberMetaParameter) Minimum added in v0.17.0 

func (nmp *NumberMetaParameter) Minimum() float64

Minimum returns the minimum value this metaparameter can be set to

func (*NumberMetaParameter) WithValue added in v0.17.0 

func (nmp *NumberMetaParameter) WithValue(value obj.Object) *NumberMetaParameter

WithValue sets a value for the metaparameter.

type NumberMetaParameterDefinition added in v0.17.0 

type NumberMetaParameterDefinition struct {
	MetaParameterDefinition
}

NumberMetaParameterDefinition is an idiomatic wrapper over the Objective-C class PHASENumberMetaParameterDefinition.

NumberMetaParameterDefinition is an abstract base — you do not construct it directly. Construct one of MappedMetaParameterDefinition and pass it where a NumberMetaParameterDefinition is accepted.

A specification for a metaparameter defined by a number.

func NewNumberMetaParameterDefinitionWithValue added in v0.17.0 

func NewNumberMetaParameterDefinitionWithValue(value float64) *NumberMetaParameterDefinition

NewNumberMetaParameterDefinitionWithValue creates a specification for a metaparameter with the given numeric value.

func NewNumberMetaParameterDefinitionWithValueIdentifier added in v0.17.0 

func NewNumberMetaParameterDefinitionWithValueIdentifier(value float64, identifier string) *NumberMetaParameterDefinition

NewNumberMetaParameterDefinitionWithValueIdentifier creates a specification for a named metaparameter with the given numeric value.

func NewNumberMetaParameterDefinitionWithValueMinimumMaximum added in v0.17.0 

func NewNumberMetaParameterDefinitionWithValueMinimumMaximum(value float64, minimum float64, maximum float64) *NumberMetaParameterDefinition

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

func NewNumberMetaParameterDefinitionWithValueMinimumMaximumIdentifier added in v0.17.0 

func NewNumberMetaParameterDefinitionWithValueMinimumMaximumIdentifier(value float64, minimum float64, maximum float64, identifier string) *NumberMetaParameterDefinition

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

func NumberMetaParameterDefinitionFromID added in v0.17.0 

func NumberMetaParameterDefinitionFromID(id objc.ID) *NumberMetaParameterDefinition

NumberMetaParameterDefinitionFromID adopts an existing Objective-C object as a NumberMetaParameterDefinition (nil for 0), retaining it and registering a release finalizer.

func (*NumberMetaParameterDefinition) Maximum added in v0.17.0 

func (nmpd *NumberMetaParameterDefinition) Maximum() float64

Maximum returns the readonly maximum that this metaparameter definition was initialized with

func (*NumberMetaParameterDefinition) Minimum added in v0.17.0 

func (nmpd *NumberMetaParameterDefinition) Minimum() float64

Minimum returns the readonly minimum that this metaparameter definition was initialized with

type NumberMetaParameterDefinitionProvider added in v0.17.0 

type NumberMetaParameterDefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

NumberMetaParameterDefinitionProvider is accepted wherever a PHASENumberMetaParameterDefinition (or one of its subclasses) is expected.

type NumericPair added in v0.17.0 

type NumericPair struct {
	objref.Handle
}

NumericPair is an idiomatic wrapper over the Objective-C class PHASENumericPair.

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

func NewNumericPairWithFirstValueSecondValue added in v0.17.0 

func NewNumericPairWithFirstValueSecondValue(first float64, second float64) *NumericPair

NewNumericPairWithFirstValueSecondValue creates a pair of numbers with the given values.

func NumericPairFromID added in v0.17.0 

func NumericPairFromID(id objc.ID) *NumericPair

NumericPairFromID adopts an existing Objective-C object as a NumericPair (nil for 0), retaining it and registering a release finalizer.

func (*NumericPair) Description added in v0.17.0 

func (np *NumericPair) Description() string

Description returns the object's -description text.

func (*NumericPair) First added in v0.17.0 

func (np *NumericPair) First() float64

First returns the first value in the numeric pair. The default value is 0.0.

func (*NumericPair) IsEqual added in v0.17.0 

func (np *NumericPair) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*NumericPair) IsKind added in v0.17.0 

func (np *NumericPair) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*NumericPair) Second added in v0.17.0 

func (np *NumericPair) Second() float64

Second returns the second value in the numeric pair. The default value is 0.0.

func (*NumericPair) String added in v0.17.0 

func (np *NumericPair) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*NumericPair) WithFirst added in v0.17.0 

func (np *NumericPair) WithFirst(first float64) *NumericPair

WithFirst sets the first value in the pair.

func (*NumericPair) WithSecond added in v0.17.0 

func (np *NumericPair) WithSecond(second float64) *NumericPair

WithSecond sets the second value in the pair.

type OSClockid added in v0.17.0 

type OSClockid uint32
const (
	OSClockidTime OSClockid = 32
)

func (OSClockid) String added in v0.17.0 

func (e OSClockid) String() string

String returns the OSClockid constant's name, or its numeric form when the value is not a known constant.

type Object added in v0.17.0 

type Object struct {
	objref.Handle
}

Object is an idiomatic wrapper over the Objective-C class PHASEObject.

Object is an abstract base — you do not construct it directly. Construct one of Listener, Occluder, Source and pass it where a Object is accepted.

An object in the scene.

func NewObjectWithEngine added in v0.17.0 

func NewObjectWithEngine(engine *Engine) *Object

NewObjectWithEngine creates an object in the scene.

func ObjectFromID added in v0.17.0 

func ObjectFromID(id objc.ID) *Object

ObjectFromID adopts an existing Objective-C object as a Object (nil for 0), retaining it and registering a release finalizer.

func (*Object) AddChild added in v0.17.0 

func (o *Object) AddChild(child *Object) error

AddChild adds the given object as a child.

func (*Object) Children added in v0.17.0 

func (o *Object) Children() []*Object

Children returns the children of this object.

Children returns the collection as a Go slice.

func (*Object) Description added in v0.17.0 

func (o *Object) Description() string

Description returns the object's -description text.

func (*Object) IsEqual added in v0.17.0 

func (o *Object) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Object) IsKind added in v0.17.0 

func (o *Object) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Object) Parent added in v0.17.0 

func (o *Object) Parent() *Object

Parent returns the parent of this object, or nil if this object doesn't have a parent object.

func (*Object) RemoveChild added in v0.17.0 

func (o *Object) RemoveChild(child *Object)

RemoveChild removes the given object as a child.

func (*Object) RemoveChildren added in v0.17.0 

func (o *Object) RemoveChildren()

RemoveChildren removes all child objects from the given object.

func (*Object) String added in v0.17.0 

func (o *Object) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Object) Transform added in v0.18.0 

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

Transform returns the object's transform.

func (*Object) WithTransform added in v0.17.0 

func (o *Object) WithTransform(transform unsafe.Pointer) *Object

WithTransform sets a matrix, in local coordinates, that determines the object’s pose in the scene.

func (*Object) WithWorldTransform added in v0.17.0 

func (o *Object) WithWorldTransform(worldTransform unsafe.Pointer) *Object

WithWorldTransform sets a matrix, in scene coordinates, that determines the object’s pose in the scene.

func (*Object) WorldTransform added in v0.18.0 

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

WorldTransform returns the world transform applied to the object.

type ObjectProvider added in v0.17.0 

type ObjectProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

ObjectProvider is accepted wherever a PHASEObject (or one of its subclasses) is expected.

type Occluder added in v0.17.0 

type Occluder struct {
	Object
}

Occluder is an idiomatic wrapper over the Objective-C class PHASEOccluder.

It embeds Object, promoting that type's methods.

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

func NewOccluderWithEngineShapes added in v0.17.0 

func NewOccluderWithEngineShapes(engine *Engine, shapes []*Shape) *Occluder

NewOccluderWithEngineShapes creates an occluder with the given engine and shapes.

func OccluderFromID added in v0.17.0 

func OccluderFromID(id objc.ID) *Occluder

OccluderFromID adopts an existing Objective-C object as a Occluder (nil for 0), retaining it and registering a release finalizer.

func (*Occluder) Shapes added in v0.17.0 

func (o *Occluder) Shapes() []*Shape

Shapes returns the shapes.

Shapes returns the collection as a Go slice.

func (*Occluder) WithTransform added in v0.17.0 

func (o *Occluder) WithTransform(transform unsafe.Pointer) *Occluder

WithTransform sets a matrix, in local coordinates, that determines the object’s pose in the scene.

func (*Occluder) WithWorldTransform added in v0.17.0 

func (o *Occluder) WithWorldTransform(worldTransform unsafe.Pointer) *Occluder

WithWorldTransform sets a matrix, in scene coordinates, that determines the object’s pose in the scene.

type PMPageToPaperMappingType 

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

func (PMPageToPaperMappingType) String 

func (e PMPageToPaperMappingType) String() string

String returns the PMPageToPaperMappingType constant's name, or its numeric form when the value is not a known constant.

type Perm added in v0.17.0 

type Perm int32
const (
	PermReadData           Perm = 2
	PermListDirectory      Perm = 2
	PermWriteData          Perm = 4
	PermAddFile            Perm = 4
	PermExecute            Perm = 8
	PermSearch             Perm = 8
	PermDelete             Perm = 16
	PermAppendData         Perm = 32
	PermAddSubdirectory    Perm = 32
	PermDeleteChild        Perm = 64
	PermReadAttributes     Perm = 128
	PermWriteAttributes    Perm = 256
	PermReadExtattributes  Perm = 512
	PermWriteExtattributes Perm = 1024
	PermReadSecurity       Perm = 2048
	PermWriteSecurity      Perm = 4096
	PermChangeOwner        Perm = 8192
	PermSynchronize        Perm = 1048576
)

func (Perm) String added in v0.17.0 

func (e Perm) String() string

String returns the Perm constant's name, or its numeric form when the value is not a known constant.

type PlaybackMode added in v0.17.0 

type PlaybackMode int64

Loop options for audio playback. 

const (
	// An option that plays a sound only once.
	PlaybackModeOneShot PlaybackMode = 0
	// An option that restarts a sound from the begining after it finishes.
	PlaybackModeLooping PlaybackMode = 1
)

func (PlaybackMode) String added in v0.17.0 

func (e PlaybackMode) String() string

String returns the PlaybackMode constant's name, or its numeric form when the value is not a known constant.

type PtrauthKey added in v0.17.0 

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

func (PtrauthKey) String added in v0.17.0 

func (e PtrauthKey) String() string

String returns the PtrauthKey constant's name, or its numeric form when the value is not a known constant.

type PullStreamNode added in v0.17.0 

type PullStreamNode struct {
	StreamNode
}

PullStreamNode is an idiomatic wrapper over the Objective-C class PHASEPullStreamNode.

It embeds StreamNode, promoting that type's methods.

func NewPullStreamNode added in v0.17.0 

func NewPullStreamNode() *PullStreamNode

NewPullStreamNode creates a new PullStreamNode.

func PullStreamNodeFromID added in v0.17.0 

func PullStreamNodeFromID(id objc.ID) *PullStreamNode

PullStreamNodeFromID adopts an existing Objective-C object as a PullStreamNode (nil for 0), retaining it and registering a release finalizer.

type PullStreamNodeDefinition added in v0.17.0 

type PullStreamNodeDefinition struct {
	GeneratorNodeDefinition
}

PullStreamNodeDefinition is an idiomatic wrapper over the Objective-C class PHASEPullStreamNodeDefinition.

It embeds GeneratorNodeDefinition, promoting that type's methods.

func NewPullStreamNodeDefinitionWithMixerDefinitionFormat added in v0.17.0 

func NewPullStreamNodeDefinitionWithMixerDefinitionFormat(mixerDefinition *MixerDefinition, format obj.Object) *PullStreamNodeDefinition

NewPullStreamNodeDefinitionWithMixerDefinitionFormat create a pull stream node definition

func NewPullStreamNodeDefinitionWithMixerDefinitionFormatIdentifier added in v0.17.0 

func NewPullStreamNodeDefinitionWithMixerDefinitionFormatIdentifier(mixerDefinition *MixerDefinition, format obj.Object, identifier string) *PullStreamNodeDefinition

NewPullStreamNodeDefinitionWithMixerDefinitionFormatIdentifier create a pull stream node definition

func PullStreamNodeDefinitionFromID added in v0.17.0 

func PullStreamNodeDefinitionFromID(id objc.ID) *PullStreamNodeDefinition

PullStreamNodeDefinitionFromID adopts an existing Objective-C object as a PullStreamNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*PullStreamNodeDefinition) Format added in v0.17.0 

func (psnd *PullStreamNodeDefinition) Format() obj.Object

Format returns the readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PullStreamNodeDefinition) Normalize added in v0.17.0 

func (psnd *PullStreamNodeDefinition) Normalize() bool

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

func (*PullStreamNodeDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (psnd *PullStreamNodeDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *PullStreamNodeDefinition

WithGainMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s loudness.

func (*PullStreamNodeDefinition) WithGroup added in v0.17.0 

func (psnd *PullStreamNodeDefinition) WithGroup(group *Group) *PullStreamNodeDefinition

WithGroup sets a group this node conforms to for gain and rate control.

func (*PullStreamNodeDefinition) WithNormalize added in v0.17.0 

func (psnd *PullStreamNodeDefinition) WithNormalize(normalize bool) *PullStreamNodeDefinition

WithNormalize sets determines whether or not the engine should normalize the stream. The default value is NO. 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 (*PullStreamNodeDefinition) WithRate added in v0.17.0 

func (psnd *PullStreamNodeDefinition) WithRate(rate float64) *PullStreamNodeDefinition

WithRate sets a playback speed for the node’s audio.

func (*PullStreamNodeDefinition) WithRateMetaParameterDefinition added in v0.17.0 

func (psnd *PullStreamNodeDefinition) WithRateMetaParameterDefinition(rateMetaParameterDefinition NumberMetaParameterDefinitionProvider) *PullStreamNodeDefinition

WithRateMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s rate.

type PushStreamBufferOptions added in v0.17.0 

type PushStreamBufferOptions uint64

Options that inform PHASE of an audio-stream buffer’s playback priority. Bitmask — values may be combined with |. 

const (
	// Indicates a buffer processes after existing buffers in the queue.
	PushStreamBufferDefault PushStreamBufferOptions = 1
	// Indicates a buffer restarts after it finishes processing.
	PushStreamBufferLoops PushStreamBufferOptions = 2
	// Indicates a buffer begins processing immediately.
	PushStreamBufferInterrupts PushStreamBufferOptions = 4
	// Indicates a buffer begins processing when an existing buffer loops.
	PushStreamBufferInterruptsAtLoop PushStreamBufferOptions = 8
)

func (PushStreamBufferOptions) String added in v0.17.0 

func (e PushStreamBufferOptions) String() string

String returns the PushStreamBufferOptions constant's name, or its numeric form when the value is not a known constant.

type PushStreamCompletionCallbackCondition added in v0.17.0 

type PushStreamCompletionCallbackCondition 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.
	PushStreamCompletionDataRendered PushStreamCompletionCallbackCondition = 0
)

func (PushStreamCompletionCallbackCondition) String added in v0.17.0 

func (e PushStreamCompletionCallbackCondition) String() string

String returns the PushStreamCompletionCallbackCondition constant's name, or its numeric form when the value is not a known constant.

type PushStreamNode added in v0.17.0 

type PushStreamNode struct {
	StreamNode
}

PushStreamNode is an idiomatic wrapper over the Objective-C class PHASEPushStreamNode.

It embeds StreamNode, promoting that type's methods.

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

func NewPushStreamNode added in v0.17.0 

func NewPushStreamNode() *PushStreamNode

NewPushStreamNode creates a new PushStreamNode.

func PushStreamNodeFromID added in v0.17.0 

func PushStreamNodeFromID(id objc.ID) *PushStreamNode

PushStreamNodeFromID adopts an existing Objective-C object as a PushStreamNode (nil for 0), retaining it and registering a release finalizer.

func (*PushStreamNode) ScheduleBuffer added in v0.17.0 

func (psn *PushStreamNode) ScheduleBuffer(buffer obj.Object)

ScheduleBuffer schedules audio data for playback.

func (*PushStreamNode) ScheduleBufferAtTime added in v0.17.0 

func (psn *PushStreamNode) ScheduleBufferAtTime(buffer obj.Object, when obj.Object, options PushStreamBufferOptions)

ScheduleBufferAtTime schedules audio data playback at a specific time.

func (*PushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler added in v0.18.0 

func (psn *PushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler(buffer obj.Object, when obj.Object, options PushStreamBufferOptions, completionCallbackType PushStreamCompletionCallbackCondition, completionHandler func(PushStreamCompletionCallbackCondition))

ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler schedules audio data playback at a specific time with a completion handler.

func (*PushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler added in v0.18.0 

func (psn *PushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler(buffer obj.Object, completionCallbackType PushStreamCompletionCallbackCondition, completionHandler func(PushStreamCompletionCallbackCondition))

ScheduleBufferCompletionCallbackTypeCompletionHandler schedules audio data playback with a completion handler.

type PushStreamNodeDefinition added in v0.17.0 

type PushStreamNodeDefinition struct {
	GeneratorNodeDefinition
}

PushStreamNodeDefinition is an idiomatic wrapper over the Objective-C class PHASEPushStreamNodeDefinition.

It embeds GeneratorNodeDefinition, promoting that type's methods.

A node that plays a sequence of audio buffers.

func NewPushStreamNodeDefinitionWithMixerDefinitionFormat added in v0.17.0 

func NewPushStreamNodeDefinitionWithMixerDefinitionFormat(mixerDefinition *MixerDefinition, format obj.Object) *PushStreamNodeDefinition

NewPushStreamNodeDefinitionWithMixerDefinitionFormat creates a node definition for audio streams.

func NewPushStreamNodeDefinitionWithMixerDefinitionFormatIdentifier added in v0.17.0 

func NewPushStreamNodeDefinitionWithMixerDefinitionFormatIdentifier(mixerDefinition *MixerDefinition, format obj.Object, identifier string) *PushStreamNodeDefinition

NewPushStreamNodeDefinitionWithMixerDefinitionFormatIdentifier creates a named node definition for audio streams.

func PushStreamNodeDefinitionFromID added in v0.17.0 

func PushStreamNodeDefinitionFromID(id objc.ID) *PushStreamNodeDefinition

PushStreamNodeDefinitionFromID adopts an existing Objective-C object as a PushStreamNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*PushStreamNodeDefinition) Format added in v0.17.0 

func (psnd *PushStreamNodeDefinition) Format() obj.Object

Format returns the readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PushStreamNodeDefinition) Normalize added in v0.17.0 

func (psnd *PushStreamNodeDefinition) Normalize() bool

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

func (*PushStreamNodeDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (psnd *PushStreamNodeDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *PushStreamNodeDefinition

WithGainMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s loudness.

func (*PushStreamNodeDefinition) WithGroup added in v0.17.0 

func (psnd *PushStreamNodeDefinition) WithGroup(group *Group) *PushStreamNodeDefinition

WithGroup sets a group this node conforms to for gain and rate control.

func (*PushStreamNodeDefinition) WithNormalize added in v0.17.0 

func (psnd *PushStreamNodeDefinition) WithNormalize(normalize bool) *PushStreamNodeDefinition

WithNormalize sets an option that resizes loudness of the audio stream for consistency.

func (*PushStreamNodeDefinition) WithRate added in v0.17.0 

func (psnd *PushStreamNodeDefinition) WithRate(rate float64) *PushStreamNodeDefinition

WithRate sets a playback speed for the node’s audio.

func (*PushStreamNodeDefinition) WithRateMetaParameterDefinition added in v0.17.0 

func (psnd *PushStreamNodeDefinition) WithRateMetaParameterDefinition(rateMetaParameterDefinition NumberMetaParameterDefinitionProvider) *PushStreamNodeDefinition

WithRateMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s rate.

type QosClass added in v0.17.0 

type QosClass uint32
const (
	QosClassUserInteractive QosClass = 33
	QosClassUserInitiated   QosClass = 25
	QosClassDefault         QosClass = 21
	QosClassUtility         QosClass = 17
	QosClassBackground      QosClass = 9
	QosClassUnspecified     QosClass = 0
)

func (QosClass) String added in v0.17.0 

func (e QosClass) String() string

String returns the QosClass constant's name, or its numeric form when the value is not a known constant.

type RandomNodeDefinition added in v0.17.0 

type RandomNodeDefinition struct {
	SoundEventNodeDefinition
}

RandomNodeDefinition is an idiomatic wrapper over the Objective-C class PHASERandomNodeDefinition.

It embeds SoundEventNodeDefinition, promoting that type's methods.

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

func NewRandomNodeDefinition added in v0.17.0 

func NewRandomNodeDefinition() *RandomNodeDefinition

NewRandomNodeDefinition creates a new RandomNodeDefinition.

func NewRandomNodeDefinitionWithIdentifier added in v0.17.0 

func NewRandomNodeDefinitionWithIdentifier(identifier string) *RandomNodeDefinition

NewRandomNodeDefinitionWithIdentifier creates a random node with the name you specify.

func RandomNodeDefinitionFromID added in v0.17.0 

func RandomNodeDefinitionFromID(id objc.ID) *RandomNodeDefinition

RandomNodeDefinitionFromID adopts an existing Objective-C object as a RandomNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*RandomNodeDefinition) AddSubtreeWeight added in v0.17.0 

func (rnd *RandomNodeDefinition) AddSubtreeWeight(subtree *SoundEventNodeDefinition, weight obj.Object)

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

func (*RandomNodeDefinition) UniqueSelectionQueueLength added in v0.17.0 

func (rnd *RandomNodeDefinition) UniqueSelectionQueueLength() int

UniqueSelectionQueueLength returns the unique selection queue length.

func (*RandomNodeDefinition) WithUniqueSelectionQueueLength added in v0.17.0 

func (rnd *RandomNodeDefinition) WithUniqueSelectionQueueLength(uniqueSelectionQueueLength int) *RandomNodeDefinition

WithUniqueSelectionQueueLength sets the length of the unique selection queue.

type RenderingState added in v0.17.0 

type RenderingState int64

The playback status of audio. 

const (
	RenderingStateStopped RenderingState = 0
	RenderingStateStarted RenderingState = 1
	RenderingStatePaused  RenderingState = 2
)

func (RenderingState) String added in v0.17.0 

func (e RenderingState) String() string

String returns the RenderingState constant's name, or its numeric form when the value is not a known constant.

type ReverbPreset added in v0.17.0 

type ReverbPreset int64

The manner in which PHASE diffuses resonating sound. 

const (
	// An option that adds no reverberation to a sound.
	ReverbPresetNone ReverbPreset = 1917742958
	// A resonation that simulates the experience of hearing a sound in a small room with specific dimensions.
	ReverbPresetSmallRoom ReverbPreset = 1918063213
	// A resonation that simulates the experience of hearing a sound in a medium-size room with specific dimensions.
	ReverbPresetMediumRoom ReverbPreset = 1917669997
	// A resonation that simulates the experience of hearing a sound in a large room with specific dimensions.
	ReverbPresetLargeRoom ReverbPreset = 1917604401
	// A resonation that simulates the experience of hearing a sound in one kind of large room with specific dimensions.
	ReverbPresetLargeRoom2 ReverbPreset = 1917604402
	// A resonation that simulates the experience of hearing a sound in a medium-size chamber with specific dimensions.
	ReverbPresetMediumChamber ReverbPreset = 1917666152
	// A resonation that simulates the experience of hearing a sound in a large chamber with specific dimensions.
	ReverbPresetLargeChamber ReverbPreset = 1917600616
	// A resonation that simulates the experience of hearing a sound in a medium-size hall with specific dimensions.
	ReverbPresetMediumHall ReverbPreset = 1917667377
	// A resonation that simulates the experience of hearing a sound in one kind of medium-size hall with specific dimensions.
	ReverbPresetMediumHall2 ReverbPreset = 1917667378
	// A resonation that simulates the experience of hearing a sound in another kind of medium-size hall with specific dimensions.
	ReverbPresetMediumHall3 ReverbPreset = 1917667379
	// A resonation that simulates the experience of hearing a sound in a large hall with specific dimensions.
	ReverbPresetLargeHall ReverbPreset = 1917601841
	// A resonation that simulates the experience of hearing a sound in one kind of large hall with specific dimensions.
	ReverbPresetLargeHall2 ReverbPreset = 1917601842
	// A resonation that simulates the experience of hearing a sound in a cathedral.
	ReverbPresetCathedral ReverbPreset = 1917023336
)

func (ReverbPreset) String added in v0.17.0 

func (e ReverbPreset) String() string

String returns the ReverbPreset constant's name, or its numeric form when the value is not a known constant.

type SamplerNodeDefinition added in v0.17.0 

type SamplerNodeDefinition struct {
	GeneratorNodeDefinition
}

SamplerNodeDefinition is an idiomatic wrapper over the Objective-C class PHASESamplerNodeDefinition.

It embeds GeneratorNodeDefinition, promoting that type's methods.

A node that plays complete audio data.

func NewSamplerNodeDefinitionWithSoundAssetIdentifierMixerDefinition added in v0.17.0 

func NewSamplerNodeDefinitionWithSoundAssetIdentifierMixerDefinition(soundAssetIdentifier string, mixerDefinition *MixerDefinition) *SamplerNodeDefinition

NewSamplerNodeDefinitionWithSoundAssetIdentifierMixerDefinition creates a sampler node with the given sound asset and mixer.

func NewSamplerNodeDefinitionWithSoundAssetIdentifierMixerDefinitionIdentifier added in v0.17.0 

func NewSamplerNodeDefinitionWithSoundAssetIdentifierMixerDefinitionIdentifier(soundAssetIdentifier string, mixerDefinition *MixerDefinition, identifier string) *SamplerNodeDefinition

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

func SamplerNodeDefinitionFromID added in v0.17.0 

func SamplerNodeDefinitionFromID(id objc.ID) *SamplerNodeDefinition

SamplerNodeDefinitionFromID adopts an existing Objective-C object as a SamplerNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*SamplerNodeDefinition) AssetIdentifier added in v0.17.0 

func (snd *SamplerNodeDefinition) AssetIdentifier() string

AssetIdentifier returns the identifier that uniquely represents the registered sound asset this sampler will play.

func (*SamplerNodeDefinition) CullOption added in v0.17.0 

func (snd *SamplerNodeDefinition) CullOption() CullOption

CullOption returns the cull option for the sampler. The default value is PHASECullOptionTerminate.

func (*SamplerNodeDefinition) PlaybackMode added in v0.17.0 

func (snd *SamplerNodeDefinition) PlaybackMode() PlaybackMode

PlaybackMode returns the playback mode for the sampler. 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 (*SamplerNodeDefinition) WithCullOption added in v0.17.0 

func (snd *SamplerNodeDefinition) WithCullOption(cullOption CullOption) *SamplerNodeDefinition

WithCullOption sets the action the engine performs after it temporarily removes the node’s sound from the audio output.

func (*SamplerNodeDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (snd *SamplerNodeDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *SamplerNodeDefinition

WithGainMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s loudness.

func (*SamplerNodeDefinition) WithGroup added in v0.17.0 

func (snd *SamplerNodeDefinition) WithGroup(group *Group) *SamplerNodeDefinition

WithGroup sets a group this node conforms to for gain and rate control.

func (*SamplerNodeDefinition) WithPlaybackMode added in v0.17.0 

func (snd *SamplerNodeDefinition) WithPlaybackMode(playbackMode PlaybackMode) *SamplerNodeDefinition

WithPlaybackMode sets an option that determines whether the node’s audio plays in a loop.

func (*SamplerNodeDefinition) WithRate added in v0.17.0 

func (snd *SamplerNodeDefinition) WithRate(rate float64) *SamplerNodeDefinition

WithRate sets a playback speed for the node’s audio.

func (*SamplerNodeDefinition) WithRateMetaParameterDefinition added in v0.17.0 

func (snd *SamplerNodeDefinition) WithRateMetaParameterDefinition(rateMetaParameterDefinition NumberMetaParameterDefinitionProvider) *SamplerNodeDefinition

WithRateMetaParameterDefinition sets a meta parameter that dynamically changes the audio’s rate.

type Shape added in v0.17.0 

type Shape struct {
	objref.Handle
}

Shape is an idiomatic wrapper over the Objective-C class PHASEShape.

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

func NewShapeWithEngineMesh added in v0.17.0 

func NewShapeWithEngineMesh(engine *Engine, mesh obj.Object) *Shape

NewShapeWithEngineMesh creates an object that the given geometric data shapes.

func NewShapeWithEngineMeshMaterials added in v0.17.0 

func NewShapeWithEngineMeshMaterials(engine *Engine, mesh obj.Object, materials []*Material) *Shape

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

func ShapeFromID added in v0.17.0 

func ShapeFromID(id objc.ID) *Shape

ShapeFromID adopts an existing Objective-C object as a Shape (nil for 0), retaining it and registering a release finalizer.

func (*Shape) Description added in v0.17.0 

func (s *Shape) Description() string

Description returns the object's -description text.

func (*Shape) Elements added in v0.17.0 

func (s *Shape) Elements() []*ShapeElement

Elements returns the elements.

Elements returns the collection as a Go slice.

func (*Shape) IsEqual added in v0.17.0 

func (s *Shape) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Shape) IsKind added in v0.17.0 

func (s *Shape) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Shape) String added in v0.17.0 

func (s *Shape) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type ShapeElement added in v0.17.0 

type ShapeElement struct {
	objref.Handle
}

ShapeElement is an idiomatic wrapper over the Objective-C class PHASEShapeElement.

An object that describes the characteristics of a physical surface.

func NewShapeElement added in v0.17.0 

func NewShapeElement() *ShapeElement

NewShapeElement creates a new ShapeElement.

func ShapeElementFromID added in v0.17.0 

func ShapeElementFromID(id objc.ID) *ShapeElement

ShapeElementFromID adopts an existing Objective-C object as a ShapeElement (nil for 0), retaining it and registering a release finalizer.

func (*ShapeElement) Description added in v0.17.0 

func (se *ShapeElement) Description() string

Description returns the object's -description text.

func (*ShapeElement) IsEqual added in v0.17.0 

func (se *ShapeElement) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ShapeElement) IsKind added in v0.17.0 

func (se *ShapeElement) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ShapeElement) Material added in v0.17.0 

func (se *ShapeElement) Material() *Material

Material returns the material.

func (*ShapeElement) String added in v0.17.0 

func (se *ShapeElement) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ShapeElement) WithMaterial added in v0.17.0 

func (se *ShapeElement) WithMaterial(material *Material) *ShapeElement

WithMaterial sets the shape's material defines the acoustical properties of this element.

type SoundAsset added in v0.17.0 

type SoundAsset struct {
	Asset
}

SoundAsset is an idiomatic wrapper over the Objective-C class PHASESoundAsset.

It embeds Asset, promoting that type's methods.

A sound resource stored in the asset registry.

func NewSoundAsset added in v0.17.0 

func NewSoundAsset() *SoundAsset

NewSoundAsset creates a new SoundAsset.

func SoundAssetFromID added in v0.17.0 

func SoundAssetFromID(id objc.ID) *SoundAsset

SoundAssetFromID adopts an existing Objective-C object as a SoundAsset (nil for 0), retaining it and registering a release finalizer.

func (*SoundAsset) Data added in v0.17.0 

func (sa *SoundAsset) Data() []byte

Data returns the buffer for the sound asset, if applicable.

func (*SoundAsset) Type added in v0.17.0 

func (sa *SoundAsset) Type() AssetType

Type returns the sound asset type.

func (*SoundAsset) URL added in v0.17.0 

func (sa *SoundAsset) URL() string

URL returns the URL of the sound asset, if applicable.

type SoundEvent added in v0.17.0 

type SoundEvent struct {
	objref.Handle
}

SoundEvent is an idiomatic wrapper over the Objective-C class PHASESoundEvent.

An object that determines which audio to play.

func NewSoundEventWithEngineAssetIdentifier added in v0.17.0 

func NewSoundEventWithEngineAssetIdentifier(engine *Engine, assetIdentifier string) (result *SoundEvent, err error)

NewSoundEventWithEngineAssetIdentifier creates a sound event node with the given asset.

func NewSoundEventWithEngineAssetIdentifierMixerParameters added in v0.17.0 

func NewSoundEventWithEngineAssetIdentifierMixerParameters(engine *Engine, assetIdentifier string, mixerParameters *MixerParameters) (result *SoundEvent, err error)

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

func SoundEventFromID added in v0.17.0 

func SoundEventFromID(id objc.ID) *SoundEvent

SoundEventFromID adopts an existing Objective-C object as a SoundEvent (nil for 0), retaining it and registering a release finalizer.

func (*SoundEvent) Description added in v0.17.0 

func (se *SoundEvent) Description() string

Description returns the object's -description text.

func (*SoundEvent) IsEqual added in v0.17.0 

func (se *SoundEvent) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SoundEvent) IsIndefinite added in v0.17.0 

func (se *SoundEvent) IsIndefinite() bool

IsIndefinite reports whether a boolean that tell if this sound event will run indefinitely, or finish executing on its own

func (*SoundEvent) IsKind added in v0.17.0 

func (se *SoundEvent) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SoundEvent) MetaParameters added in v0.17.0 

func (se *SoundEvent) MetaParameters() map[string]*MetaParameter

MetaParameters returns a Dictionary containing the MetaParameters associated with this sound event

func (*SoundEvent) Mixers added in v0.17.0 

func (se *SoundEvent) Mixers() map[string]*Mixer

Mixers returns a Dictionary containing the mix nodes associated with this sound event

func (*SoundEvent) Pause added in v0.17.0 

func (se *SoundEvent) Pause()

Pause pauses the sound event.

func (*SoundEvent) PrepareState added in v0.17.0 

func (se *SoundEvent) PrepareState() SoundEventPrepareState

PrepareState returns sound Event's current preparation state

func (*SoundEvent) PrepareWithCompletion added in v0.18.0 

func (se *SoundEvent) PrepareWithCompletion(handler func(SoundEventPrepareHandlerReason))

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

func (*SoundEvent) PullStreamNodes added in v0.17.0 

func (se *SoundEvent) PullStreamNodes() map[string]*PullStreamNode

PullStreamNodes returns a Dictionary containing the pull stream nodes associated with this sound event, for setting renderBlocks on.

func (*SoundEvent) PushStreamNodes added in v0.17.0 

func (se *SoundEvent) PushStreamNodes() map[string]*PushStreamNode

PushStreamNodes returns a Dictionary containing the push stream nodes associated with this sound event, for pushing buffers to.

func (*SoundEvent) RenderingState added in v0.17.0 

func (se *SoundEvent) RenderingState() RenderingState

RenderingState returns sound Event's current rendering state

func (*SoundEvent) Resume added in v0.17.0 

func (se *SoundEvent) Resume()

Resume resumes the sound event.

func (*SoundEvent) ResumeAtTime added in v0.17.0 

func (se *SoundEvent) ResumeAtTime(time_ obj.Object)

ResumeAtTime resume the sound event at a specific time A nil time parameter will resume immediately. The device time is not scaled by UnitsPerSecond and is in seconds.

func (*SoundEvent) SeekToTimeCompletion added in v0.18.0 

func (se *SoundEvent) SeekToTimeCompletion(time_ float64, handler func(SoundEventSeekHandlerReason))

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

func (*SoundEvent) SeekToTimeResumeAtEngineTimeCompletion added in v0.18.0 

func (se *SoundEvent) SeekToTimeResumeAtEngineTimeCompletion(time_ float64, engineTime obj.Object, handler func(SoundEventSeekHandlerReason))

SeekToTimeResumeAtEngineTimeCompletion seeks all leaf nodes in a PHASESoundEvent to the specified time, and automatically resumes playback at the specified engine time. 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 (*SoundEvent) StartAtTimeCompletion added in v0.18.0 

func (se *SoundEvent) StartAtTimeCompletion(when obj.Object, handler func(SoundEventStartHandlerReason))

StartAtTimeCompletion start the sound event This function notifies the engine to start the sound event, then returns immediately. Once the sound event is playing (or has failed to start), you will receive a callback via the completion. Playback will begin 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 (*SoundEvent) StartWithCompletion added in v0.18.0 

func (se *SoundEvent) StartWithCompletion(handler func(SoundEventStartHandlerReason))

StartWithCompletion invokes the sound event and runs the specified code on completion.

func (*SoundEvent) StopAndInvalidate added in v0.17.0 

func (se *SoundEvent) StopAndInvalidate()

StopAndInvalidate stops a sound event and prevents it from resuming.

func (*SoundEvent) String added in v0.17.0 

func (se *SoundEvent) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SoundEventError added in v0.17.0 

type SoundEventError int64

A sound event error that PHASE reports. 

const (
	SoundEventErrorNotFound             SoundEventError = 1346925665
	SoundEventErrorBadData              SoundEventError = 1346925666
	SoundEventErrorInvalidInstance      SoundEventError = 1346925667
	SoundEventErrorAPIMisuse            SoundEventError = 1346925668
	SoundEventErrorSystemNotInitialized SoundEventError = 1346925669
	SoundEventErrorOutOfMemory          SoundEventError = 1346925670
)

func (SoundEventError) String added in v0.17.0 

func (e SoundEventError) String() string

String returns the SoundEventError constant's name, or its numeric form when the value is not a known constant.

type SoundEventNodeAsset added in v0.17.0 

type SoundEventNodeAsset struct {
	Asset
}

SoundEventNodeAsset is an idiomatic wrapper over the Objective-C class PHASESoundEventNodeAsset.

It embeds Asset, promoting that type's methods.

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

func NewSoundEventNodeAsset added in v0.17.0 

func NewSoundEventNodeAsset() *SoundEventNodeAsset

NewSoundEventNodeAsset creates a new SoundEventNodeAsset.

func SoundEventNodeAssetFromID added in v0.17.0 

func SoundEventNodeAssetFromID(id objc.ID) *SoundEventNodeAsset

SoundEventNodeAssetFromID adopts an existing Objective-C object as a SoundEventNodeAsset (nil for 0), retaining it and registering a release finalizer.

type SoundEventNodeDefinition added in v0.17.0 

type SoundEventNodeDefinition struct {
	Definition
}

SoundEventNodeDefinition is an idiomatic wrapper over the Objective-C class PHASESoundEventNodeDefinition.

SoundEventNodeDefinition is an abstract base — you do not construct it directly. Construct one of BlendNodeDefinition, ContainerNodeDefinition, GeneratorNodeDefinition, RandomNodeDefinition, SwitchNodeDefinition and pass it where a SoundEventNodeDefinition is accepted.

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

func SoundEventNodeDefinitionFromID added in v0.17.0 

func SoundEventNodeDefinitionFromID(id objc.ID) *SoundEventNodeDefinition

SoundEventNodeDefinitionFromID adopts an existing Objective-C object as a SoundEventNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*SoundEventNodeDefinition) Children added in v0.17.0 

func (send *SoundEventNodeDefinition) Children() []*SoundEventNodeDefinition

Children returns the children.

Children returns the collection as a Go slice.

type SoundEventNodeDefinitionProvider added in v0.17.0 

type SoundEventNodeDefinitionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

SoundEventNodeDefinitionProvider is accepted wherever a PHASESoundEventNodeDefinition (or one of its subclasses) is expected.

type SoundEventPrepareHandlerReason added in v0.17.0 

type SoundEventPrepareHandlerReason int64

Indicates the results of sound-event preparation. 

const (
	SoundEventPrepareHandlerReasonFailure    SoundEventPrepareHandlerReason = 0
	SoundEventPrepareHandlerReasonPrepared   SoundEventPrepareHandlerReason = 1
	SoundEventPrepareHandlerReasonTerminated SoundEventPrepareHandlerReason = 2
)

func (SoundEventPrepareHandlerReason) String added in v0.17.0 

func (e SoundEventPrepareHandlerReason) String() string

String returns the SoundEventPrepareHandlerReason constant's name, or its numeric form when the value is not a known constant.

type SoundEventPrepareState added in v0.17.0 

type SoundEventPrepareState int64

Indicates the state of sound-event preparation. 

const (
	SoundEventPrepareStatePrepareNotStarted SoundEventPrepareState = 0
	SoundEventPrepareStatePrepareInProgress SoundEventPrepareState = 1
	SoundEventPrepareStatePrepared          SoundEventPrepareState = 2
)

func (SoundEventPrepareState) String added in v0.17.0 

func (e SoundEventPrepareState) String() string

String returns the SoundEventPrepareState constant's name, or its numeric form when the value is not a known constant.

type SoundEventSeekHandlerReason added in v0.17.0 

type SoundEventSeekHandlerReason int64

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

const (
	SoundEventSeekHandlerReasonFailure                      SoundEventSeekHandlerReason = 0
	SoundEventSeekHandlerReasonFailureSeekAlreadyInProgress SoundEventSeekHandlerReason = 1
	SoundEventSeekHandlerReasonSeekSuccessful               SoundEventSeekHandlerReason = 2
)

func (SoundEventSeekHandlerReason) String added in v0.17.0 

func (e SoundEventSeekHandlerReason) String() string

String returns the SoundEventSeekHandlerReason constant's name, or its numeric form when the value is not a known constant.

type SoundEventStartHandlerReason added in v0.17.0 

type SoundEventStartHandlerReason int64

Indicates the status after starting a sound event. 

const (
	SoundEventStartHandlerReasonFailure         SoundEventStartHandlerReason = 0
	SoundEventStartHandlerReasonFinishedPlaying SoundEventStartHandlerReason = 1
	SoundEventStartHandlerReasonTerminated      SoundEventStartHandlerReason = 2
)

func (SoundEventStartHandlerReason) String added in v0.17.0 

func (e SoundEventStartHandlerReason) String() string

String returns the SoundEventStartHandlerReason constant's name, or its numeric form when the value is not a known constant.

type Source added in v0.17.0 

type Source struct {
	Object
}

Source is an idiomatic wrapper over the Objective-C class PHASESource.

It embeds Object, promoting that type's methods.

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

func NewSourceWithEngine added in v0.17.0 

func NewSourceWithEngine(engine *Engine) *Source

NewSourceWithEngine creates a single point in the environment from which sound emanates.

func NewSourceWithEngineShapes added in v0.17.0 

func NewSourceWithEngineShapes(engine *Engine, shapes []*Shape) *Source

NewSourceWithEngineShapes creates a voluminous area in the environment from which sound emanates.

func SourceFromID added in v0.17.0 

func SourceFromID(id objc.ID) *Source

SourceFromID adopts an existing Objective-C object as a Source (nil for 0), retaining it and registering a release finalizer.

func (*Source) Gain added in v0.17.0 

func (s *Source) Gain() float64

Gain returns linear gain scalar.

func (*Source) Shapes added in v0.17.0 

func (s *Source) Shapes() []*Shape

Shapes returns array of shapes associated with this source.

Shapes returns the collection as a Go slice.

func (*Source) WithGain added in v0.17.0 

func (s *Source) WithGain(gain float64) *Source

WithGain sets the amount of sound the source emanates.

func (*Source) WithTransform added in v0.17.0 

func (s *Source) WithTransform(transform unsafe.Pointer) *Source

WithTransform sets a matrix, in local coordinates, that determines the object’s pose in the scene.

func (*Source) WithWorldTransform added in v0.17.0 

func (s *Source) WithWorldTransform(worldTransform unsafe.Pointer) *Source

WithWorldTransform sets a matrix, in scene coordinates, that determines the object’s pose in the scene.

type SpatialMixerDefinition added in v0.17.0 

type SpatialMixerDefinition struct {
	MixerDefinition
}

SpatialMixerDefinition is an idiomatic wrapper over the Objective-C class PHASESpatialMixerDefinition.

It embeds MixerDefinition, promoting that type's methods.

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

func NewSpatialMixerDefinitionWithSpatialPipeline added in v0.17.0 

func NewSpatialMixerDefinitionWithSpatialPipeline(spatialPipeline *SpatialPipeline) *SpatialMixerDefinition

NewSpatialMixerDefinitionWithSpatialPipeline creates a mixer with the designated spatial pipeline.

func NewSpatialMixerDefinitionWithSpatialPipelineIdentifier added in v0.17.0 

func NewSpatialMixerDefinitionWithSpatialPipelineIdentifier(spatialPipeline *SpatialPipeline, identifier string) *SpatialMixerDefinition

NewSpatialMixerDefinitionWithSpatialPipelineIdentifier creates a named mixer with the designated spatial pipeline.

func SpatialMixerDefinitionFromID added in v0.17.0 

func SpatialMixerDefinitionFromID(id objc.ID) *SpatialMixerDefinition

SpatialMixerDefinitionFromID adopts an existing Objective-C object as a SpatialMixerDefinition (nil for 0), retaining it and registering a release finalizer.

func (*SpatialMixerDefinition) DistanceModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) DistanceModelParameters() *DistanceModelParameters

DistanceModelParameters returns distance model parameters (optional).

func (*SpatialMixerDefinition) ListenerDirectivityModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) ListenerDirectivityModelParameters() *DirectivityModelParameters

ListenerDirectivityModelParameters returns listener directivity model parameters (optional).

func (*SpatialMixerDefinition) SourceDirectivityModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) SourceDirectivityModelParameters() *DirectivityModelParameters

SourceDirectivityModelParameters returns source directivity model parameters (optional).

func (*SpatialMixerDefinition) SpatialPipeline added in v0.17.0 

func (smd *SpatialMixerDefinition) SpatialPipeline() *SpatialPipeline

SpatialPipeline returns spatial Pipeline.

func (*SpatialMixerDefinition) WithDistanceModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) WithDistanceModelParameters(distanceModelParameters DistanceModelParametersProvider) *SpatialMixerDefinition

WithDistanceModelParameters sets an effect that changes sound as it carries over a distance.

func (*SpatialMixerDefinition) WithGain added in v0.17.0 

func (smd *SpatialMixerDefinition) WithGain(gain float64) *SpatialMixerDefinition

WithGain sets the mixer’s volume.

func (*SpatialMixerDefinition) WithGainMetaParameterDefinition added in v0.17.0 

func (smd *SpatialMixerDefinition) WithGainMetaParameterDefinition(gainMetaParameterDefinition NumberMetaParameterDefinitionProvider) *SpatialMixerDefinition

WithGainMetaParameterDefinition sets a template for a parameter that changes the mixer’s volume gradually over a period of time.

func (*SpatialMixerDefinition) WithListenerDirectivityModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) WithListenerDirectivityModelParameters(listenerDirectivityModelParameters DirectivityModelParametersProvider) *SpatialMixerDefinition

WithListenerDirectivityModelParameters sets a data set that determines how well the listener hears depending on its direction relative to a sound source.

func (*SpatialMixerDefinition) WithSourceDirectivityModelParameters added in v0.17.0 

func (smd *SpatialMixerDefinition) WithSourceDirectivityModelParameters(sourceDirectivityModelParameters DirectivityModelParametersProvider) *SpatialMixerDefinition

WithSourceDirectivityModelParameters sets a data set that directs sound such that it’s louder when directed at the listener.

type SpatialPipeline added in v0.17.0 

type SpatialPipeline struct {
	objref.Handle
}

SpatialPipeline is an idiomatic wrapper over the Objective-C class PHASESpatialPipeline.

An object that specifies the volume of optional environmental effects.

func NewSpatialPipelineWithFlags added in v0.17.0 

func NewSpatialPipelineWithFlags(flags SpatialPipelineFlags) *SpatialPipeline

NewSpatialPipelineWithFlags creates a spatial pipeline with the specified flags.

func SpatialPipelineFromID added in v0.17.0 

func SpatialPipelineFromID(id objc.ID) *SpatialPipeline

SpatialPipelineFromID adopts an existing Objective-C object as a SpatialPipeline (nil for 0), retaining it and registering a release finalizer.

func (*SpatialPipeline) Description added in v0.17.0 

func (sp *SpatialPipeline) Description() string

Description returns the object's -description text.

func (*SpatialPipeline) Entries added in v0.17.0 

func (sp *SpatialPipeline) Entries() obj.Object

Entries returns a dictionary of entries in the Spatial Pipeline. Upon initialization, an entry will be created for every flag in the PHASESpatialPipelineFlags passed to PHASESpatialPipeline:initWithFlags.

func (*SpatialPipeline) Flags added in v0.17.0 

func (sp *SpatialPipeline) Flags() SpatialPipelineFlags

Flags returns spatial Pipeline Flags.

func (*SpatialPipeline) IsEqual added in v0.17.0 

func (sp *SpatialPipeline) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SpatialPipeline) IsKind added in v0.17.0 

func (sp *SpatialPipeline) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SpatialPipeline) String added in v0.17.0 

func (sp *SpatialPipeline) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SpatialPipelineEntry added in v0.17.0 

type SpatialPipelineEntry struct {
	objref.Handle
}

SpatialPipelineEntry is an idiomatic wrapper over the Objective-C class PHASESpatialPipelineEntry.

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

func NewSpatialPipelineEntry added in v0.17.0 

func NewSpatialPipelineEntry() *SpatialPipelineEntry

NewSpatialPipelineEntry creates a new SpatialPipelineEntry.

func SpatialPipelineEntryFromID added in v0.17.0 

func SpatialPipelineEntryFromID(id objc.ID) *SpatialPipelineEntry

SpatialPipelineEntryFromID adopts an existing Objective-C object as a SpatialPipelineEntry (nil for 0), retaining it and registering a release finalizer.

func (*SpatialPipelineEntry) Description added in v0.17.0 

func (spe *SpatialPipelineEntry) Description() string

Description returns the object's -description text.

func (*SpatialPipelineEntry) IsEqual added in v0.17.0 

func (spe *SpatialPipelineEntry) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SpatialPipelineEntry) IsKind added in v0.17.0 

func (spe *SpatialPipelineEntry) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SpatialPipelineEntry) SendLevel added in v0.17.0 

func (spe *SpatialPipelineEntry) SendLevel() float64

SendLevel returns send level.

func (*SpatialPipelineEntry) SendLevelMetaParameterDefinition added in v0.17.0 

func (spe *SpatialPipelineEntry) SendLevelMetaParameterDefinition() *NumberMetaParameterDefinition

SendLevelMetaParameterDefinition returns an optional metaparameter used to drive the send level during playback.

func (*SpatialPipelineEntry) String added in v0.17.0 

func (spe *SpatialPipelineEntry) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SpatialPipelineEntry) WithSendLevel added in v0.17.0 

func (spe *SpatialPipelineEntry) WithSendLevel(sendLevel float64) *SpatialPipelineEntry

WithSendLevel sets the amount of audio signal to add to the output.

func (*SpatialPipelineEntry) WithSendLevelMetaParameterDefinition added in v0.17.0 

func (spe *SpatialPipelineEntry) WithSendLevelMetaParameterDefinition(sendLevelMetaParameterDefinition NumberMetaParameterDefinitionProvider) *SpatialPipelineEntry

WithSendLevelMetaParameterDefinition sets a parameter that gradually updates the amount of audio signal that passes through to the output.

type SpatialPipelineFlags added in v0.17.0 

type SpatialPipelineFlags uint64

Sound resonance options for a spatial pipeline. Bitmask — values may be combined with |. 

const (
	SpatialPipelineFlagDirectPathTransmission SpatialPipelineFlags = 1
	SpatialPipelineFlagEarlyReflections       SpatialPipelineFlags = 2
	SpatialPipelineFlagLateReverb             SpatialPipelineFlags = 4
)

func (SpatialPipelineFlags) String added in v0.17.0 

func (e SpatialPipelineFlags) String() string

String returns the SpatialPipelineFlags constant's name, or its numeric form when the value is not a known constant.

type SpatializationMode added in v0.17.0 

type SpatializationMode int64

The manner in which PHASE outputs spatial audio. 

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

func (SpatializationMode) String added in v0.17.0 

func (e SpatializationMode) String() string

String returns the SpatializationMode constant's name, or its numeric form when the value is not a known constant.

type StreamNode added in v0.17.0 

type StreamNode struct {
	objref.Handle
}

StreamNode is an idiomatic wrapper over the Objective-C class PHASEStreamNode.

StreamNode is an abstract base — you do not construct it directly. Construct one of PullStreamNode, PushStreamNode and pass it where a StreamNode is accepted.

func StreamNodeFromID added in v0.17.0 

func StreamNodeFromID(id objc.ID) *StreamNode

StreamNodeFromID adopts an existing Objective-C object as a StreamNode (nil for 0), retaining it and registering a release finalizer.

func (*StreamNode) Description added in v0.17.0 

func (sn *StreamNode) Description() string

Description returns the object's -description text.

func (*StreamNode) Format added in v0.17.0 

func (sn *StreamNode) Format() obj.Object

Format returns the readonly property that returns the AVAudioFormat that this stream was initialized with.

func (*StreamNode) GainMetaParameter added in v0.17.0 

func (sn *StreamNode) GainMetaParameter() *NumberMetaParameter

GainMetaParameter returns if specified during construction, the metaparameter for controlling gain will be available here

func (*StreamNode) IsEqual added in v0.17.0 

func (sn *StreamNode) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*StreamNode) IsKind added in v0.17.0 

func (sn *StreamNode) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*StreamNode) Mixer added in v0.17.0 

func (sn *StreamNode) Mixer() *Mixer

Mixer returns the readonly property that returns the PHASEMixer this stream was created with and assigned to.

func (*StreamNode) RateMetaParameter added in v0.17.0 

func (sn *StreamNode) RateMetaParameter() *NumberMetaParameter

RateMetaParameter returns if specified during construction, the metaparameter for controlling rate/pitch will be available here

func (*StreamNode) String added in v0.17.0 

func (sn *StreamNode) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type StreamNodeProvider added in v0.17.0 

type StreamNodeProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

StreamNodeProvider is accepted wherever a PHASEStreamNode (or one of its subclasses) is expected.

type StringMetaParameter added in v0.17.0 

type StringMetaParameter struct {
	MetaParameter
}

StringMetaParameter is an idiomatic wrapper over the Objective-C class PHASEStringMetaParameter.

It embeds MetaParameter, promoting that type's methods.

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

func NewStringMetaParameter added in v0.17.0 

func NewStringMetaParameter() *StringMetaParameter

NewStringMetaParameter creates a new StringMetaParameter.

func StringMetaParameterFromID added in v0.17.0 

func StringMetaParameterFromID(id objc.ID) *StringMetaParameter

StringMetaParameterFromID adopts an existing Objective-C object as a StringMetaParameter (nil for 0), retaining it and registering a release finalizer.

func (*StringMetaParameter) WithValue added in v0.17.0 

func (smp *StringMetaParameter) WithValue(value obj.Object) *StringMetaParameter

WithValue sets a value for the metaparameter.

type StringMetaParameterDefinition added in v0.17.0 

type StringMetaParameterDefinition struct {
	MetaParameterDefinition
}

StringMetaParameterDefinition is an idiomatic wrapper over the Objective-C class PHASEStringMetaParameterDefinition.

It embeds MetaParameterDefinition, promoting that type's methods.

A specification for a metaparameter defined by text.

func NewStringMetaParameterDefinitionWithValue added in v0.17.0 

func NewStringMetaParameterDefinitionWithValue(value string) *StringMetaParameterDefinition

NewStringMetaParameterDefinitionWithValue creates a specification for a textual metaparameter with the given value.

func NewStringMetaParameterDefinitionWithValueIdentifier added in v0.17.0 

func NewStringMetaParameterDefinitionWithValueIdentifier(value string, identifier string) *StringMetaParameterDefinition

NewStringMetaParameterDefinitionWithValueIdentifier creates a specification for a named textual metaparameter with the given value.

func StringMetaParameterDefinitionFromID added in v0.17.0 

func StringMetaParameterDefinitionFromID(id objc.ID) *StringMetaParameterDefinition

StringMetaParameterDefinitionFromID adopts an existing Objective-C object as a StringMetaParameterDefinition (nil for 0), retaining it and registering a release finalizer.

type SwitchNodeDefinition added in v0.17.0 

type SwitchNodeDefinition struct {
	SoundEventNodeDefinition
}

SwitchNodeDefinition is an idiomatic wrapper over the Objective-C class PHASESwitchNodeDefinition.

It embeds SoundEventNodeDefinition, promoting that type's methods.

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

func NewSwitchNodeDefinitionWithSwitchMetaParameterDefinition added in v0.17.0 

func NewSwitchNodeDefinitionWithSwitchMetaParameterDefinition(switchMetaParameterDefinition *StringMetaParameterDefinition) *SwitchNodeDefinition

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

func NewSwitchNodeDefinitionWithSwitchMetaParameterDefinitionIdentifier added in v0.17.0 

func NewSwitchNodeDefinitionWithSwitchMetaParameterDefinitionIdentifier(switchMetaParameterDefinition *StringMetaParameterDefinition, identifier string) *SwitchNodeDefinition

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

func SwitchNodeDefinitionFromID added in v0.17.0 

func SwitchNodeDefinitionFromID(id objc.ID) *SwitchNodeDefinition

SwitchNodeDefinitionFromID adopts an existing Objective-C object as a SwitchNodeDefinition (nil for 0), retaining it and registering a release finalizer.

func (*SwitchNodeDefinition) AddSubtreeSwitchValue added in v0.17.0 

func (snd *SwitchNodeDefinition) AddSubtreeSwitchValue(subtree *SoundEventNodeDefinition, switchValue string)

AddSubtreeSwitchValue adds a child node with the given switch value.

func (*SwitchNodeDefinition) SwitchMetaParameterDefinition added in v0.17.0 

func (snd *SwitchNodeDefinition) SwitchMetaParameterDefinition() *StringMetaParameterDefinition

SwitchMetaParameterDefinition returns the switch meta parameter definition.

type Tag added in v0.17.0 

type Tag int32
const (
	TagUndefinedTag  Tag = 0
	TagExtendedAllow Tag = 1
	TagExtendedDeny  Tag = 2
)

func (Tag) String added in v0.17.0 

func (e Tag) String() string

String returns the Tag constant's name, or its numeric form when the value is not a known constant.

type Type added in v0.17.0 

type Type int32
const (
	TypeExtended Type = 256
	TypeAccess   Type = 0
	TypeDefault  Type = 1
	TypeAfs      Type = 2
	TypeCoda     Type = 3
	TypeNtfs     Type = 4
	TypeNwfs     Type = 5
)

func (Type) String added in v0.17.0 

func (e Type) String() string

String returns the Type constant's name, or its numeric form when the value is not a known constant.

type UpdateMode added in v0.17.0 

type UpdateMode int64

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

const (
	UpdateModeAutomatic UpdateMode = 0
	UpdateModeManual    UpdateMode = 1
)

func (UpdateMode) String added in v0.17.0 

func (e UpdateMode) String() string

String returns the UpdateMode constant's name, or its numeric form when the value is not a known constant.

type VirtualMemoryGuardExceptionCode added in v0.17.0 

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

func (VirtualMemoryGuardExceptionCode) String added in v0.17.0 

func (e VirtualMemoryGuardExceptionCode) String() string

String returns the VirtualMemoryGuardExceptionCode constant's name, or its numeric form when the value is not a known constant.

type XpcListenerCreateFlags added in v0.17.0 

type XpcListenerCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcListenerCreateFlagsNone            XpcListenerCreateFlags = 0
	XpcListenerCreateFlagsInactive        XpcListenerCreateFlags = 1
	XpcListenerCreateFlagsForceMach       XpcListenerCreateFlags = 2
	XpcListenerCreateFlagsForceXpcservice XpcListenerCreateFlags = 4
)

func (XpcListenerCreateFlags) String added in v0.17.0 

func (e XpcListenerCreateFlags) String() string

String returns the XpcListenerCreateFlags constant's name, or its numeric form when the value is not a known constant.

type XpcSessionCreateFlags added in v0.17.0 

type XpcSessionCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcSessionCreateFlagsNone           XpcSessionCreateFlags = 0
	XpcSessionCreateFlagsInactive       XpcSessionCreateFlags = 1
	XpcSessionCreateFlagsMachPrivileged XpcSessionCreateFlags = 2
)

func (XpcSessionCreateFlags) String added in v0.17.0 

func (e XpcSessionCreateFlags) String() string

String returns the XpcSessionCreateFlags constant's name, or its numeric form when the value is not a known constant.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.