PHASE · IOS API REFERENCE

PHASESoundEvent

class · iOS 15.0+ · SDK 27.1

class PHASESoundEvent

Members (18)

init · iOS 15.0+

init

TypeScript

static initEngineAssetIdentifier(engine: PHASEEngine, assetIdentifier: string): PHASESoundEvent

Swift declaration

init(engine: PHASEEngine, assetIdentifier: String) throws

init · iOS 15.0+

init

TypeScript

static initEngineAssetIdentifierMixerParameters(engine: PHASEEngine, assetIdentifier: string, mixerParameters: PHASEMixerParameters): PHASESoundEvent

Swift declaration

init(engine: PHASEEngine, assetIdentifier: String, mixerParameters: PHASEMixerParameters) throws

method · iOS 15.0+

pause

TypeScript

pause(): void

Swift declaration

func pause()

method · iOS 15.0+

prepare

TypeScript

prepare(handler?: (((arg0: PHASESoundEvent_PrepareHandlerReason) => void)) | null): void

Swift declaration

func prepare() async -> PHASESoundEvent.PrepareHandlerReason

method · iOS 15.0+

resume

TypeScript

resume(): void

Swift declaration

func resume()

method · iOS 26.0+

resume

TypeScript

resumeAt(time?: (_AVFAudio_AVAudioTime) | null): void

Swift declaration

func resume(at time: AVAudioTime?)

method · iOS 15.0+

seek

TypeScript

seekToCompletion(time: number, handler?: (((arg0: PHASESoundEvent_SeekHandlerReason) => void)) | null): void

Swift declaration

func seek(to time: Double) async -> PHASESoundEvent.SeekHandlerReason

method · iOS 26.0+

seek

TypeScript

seekToResumeAtCompletion(time: number, engineTime: _AVFAudio_AVAudioTime, handler?: (((arg0: PHASESoundEvent_SeekHandlerReason) => void)) | null): void

Swift declaration

func seek(to time: Double, resumeAt engineTime: AVAudioTime) async -> PHASESoundEvent.SeekHandlerReason

method · iOS 26.0+

start

TypeScript

startAtCompletion(when?: (_AVFAudio_AVAudioTime) | null, handler?: (((arg0: PHASESoundEvent_StartHandlerReason) => void)) | null): void

Swift declaration

func start(at when: AVAudioTime?) async -> PHASESoundEvent.StartHandlerReason

method · iOS 15.0+

start

TypeScript

startCompletion(handler?: (((arg0: PHASESoundEvent_StartHandlerReason) => void)) | null): void

Swift declaration

func start() async -> PHASESoundEvent.StartHandlerReason

method · iOS 15.0+

stopAndInvalidate

TypeScript

stopAndInvalidate(): void

Swift declaration

func stopAndInvalidate()

get · iOS 15.0+

isIndefinite

TypeScript

get isIndefinite(): boolean

Swift declaration

var isIndefinite: Bool { get }

get · iOS 15.0+

metaParameters

TypeScript

get metaParameters(): Record<string, PHASEMetaParameter>

Swift declaration

var metaParameters: [String : PHASEMetaParameter] { get }

get · iOS 15.0+

mixers

TypeScript

get mixers(): Record<string, PHASEMixer>

Swift declaration

var mixers: [String : PHASEMixer] { get }

get · iOS 15.0+

prepareState

TypeScript

get prepareState(): PHASESoundEvent_PrepareState

Swift declaration

var prepareState: PHASESoundEvent.PrepareState { get }

get · iOS 18.0+

pullStreamNodes

TypeScript

get pullStreamNodes(): Record<string, PHASEPullStreamNode>

Swift declaration

var pullStreamNodes: [String : PHASEPullStreamNode] { get }

get · iOS 15.0+

pushStreamNodes

TypeScript

get pushStreamNodes(): Record<string, PHASEPushStreamNode>

Swift declaration

var pushStreamNodes: [String : PHASEPushStreamNode] { get }

get · iOS 15.0+

renderingState

TypeScript

get renderingState(): PHASESoundEvent_RenderingState

Swift declaration

var renderingState: PHASESoundEvent.RenderingState { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

PHASESoundEvent.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All PHASE types →