One Logo Pool Ball
X
Github
Discord

System

AVFAudio · IOS API REFERENCE

AVAudioPlayer

class · iOS 2.2+ · SDK 27.1

class AVAudioPlayer

Members (39)

method · iOS 2.2+

averagePower

TypeScript
averagePower(channelNumber: number): number
Swift declaration
func averagePower(forChannel channelNumber: Int) -> Float
init · iOS 2.2+

init

TypeScript
static initContentsOf(url: string): AVAudioPlayer
Swift declaration
init(contentsOf url: URL) throws
init · iOS 7.0+

init

TypeScript
static initContentsOfFileTypeHint(url: string, utiString?: (string) | null): AVAudioPlayer
Swift declaration
init(contentsOf url: URL, fileTypeHint utiString: String?) throws
init · iOS 2.2+

init

TypeScript
static initData(data: ArrayBuffer): AVAudioPlayer
Swift declaration
init(data: Data) throws
init · iOS 7.0+

init

TypeScript
static initDataFileTypeHint(data: ArrayBuffer, utiString?: (string) | null): AVAudioPlayer
Swift declaration
init(data: Data, fileTypeHint utiString: String?) throws
method · iOS 2.2+

pause

TypeScript
pause(): void
Swift declaration
func pause()
method · iOS 2.2+

peakPower

TypeScript
peakPower(channelNumber: number): number
Swift declaration
func peakPower(forChannel channelNumber: Int) -> Float
method · iOS 2.2+

play

TypeScript
play(): boolean
Swift declaration
func play() -> Bool
method · iOS 4.0+

play

TypeScript
playAtTime(time: number): boolean
Swift declaration
func play(atTime time: TimeInterval) -> Bool
method · iOS 2.2+

prepareToPlay

TypeScript
prepareToPlay(): boolean
Swift declaration
func prepareToPlay() -> Bool
method · iOS 10.0+

setVolume

TypeScript
setVolume(volume: number, duration: number): void
Swift declaration
func setVolume(_ volume: Float, fadeDuration duration: TimeInterval)
method · iOS 2.2+

stop

TypeScript
stop(): void
Swift declaration
func stop()
method · iOS 2.2+

updateMeters

TypeScript
updateMeters(): void
Swift declaration
func updateMeters()
get · iOS 7.0+

channelAssignments

TypeScript
get channelAssignments(): (Array<AVAudioSessionChannelDescription>) | null
Swift declaration
var channelAssignments: [AVAudioSessionChannelDescription]? { get set }
set · iOS 7.0+

channelAssignments

TypeScript
set channelAssignments(value: (Array<AVAudioSessionChannelDescription>) | null)
Swift declaration
var channelAssignments: [AVAudioSessionChannelDescription]? { get set }
get · iOS 2.2+

currentTime

TypeScript
get currentTime(): number
Swift declaration
var currentTime: TimeInterval { get set }
set · iOS 2.2+

currentTime

TypeScript
set currentTime(value: number)
Swift declaration
var currentTime: TimeInterval { get set }
get · iOS 2.2+

data

TypeScript
get data(): (ArrayBuffer) | null
Swift declaration
var data: Data? { get }
get · iOS 2.2+

delegate

TypeScript
get delegate(): (SDKHandle) | null
Swift declaration
weak var delegate: (any AVAudioPlayerDelegate)? { get set }
set · iOS 2.2+

delegate

TypeScript
set delegate(value: (Implements<AVAudioPlayerDelegate> | SDKHandle) | null)
Swift declaration
weak var delegate: (any AVAudioPlayerDelegate)? { get set }
get · iOS 4.0+

deviceCurrentTime

TypeScript
get deviceCurrentTime(): number
Swift declaration
var deviceCurrentTime: TimeInterval { get }
get · iOS 2.2+

duration

TypeScript
get duration(): number
Swift declaration
var duration: TimeInterval { get }
get · iOS 5.0+

enableRate

TypeScript
get enableRate(): boolean
Swift declaration
var enableRate: Bool { get set }
set · iOS 5.0+

enableRate

TypeScript
set enableRate(value: boolean)
Swift declaration
var enableRate: Bool { get set }
get · iOS 10.0+

format

TypeScript
get format(): AVAudioFormat
Swift declaration
var format: AVAudioFormat { get }
get · iOS 2.2+

isMeteringEnabled

TypeScript
get isMeteringEnabled(): boolean
Swift declaration
var isMeteringEnabled: Bool { get set }
set · iOS 2.2+

isMeteringEnabled

TypeScript
set isMeteringEnabled(value: boolean)
Swift declaration
var isMeteringEnabled: Bool { get set }
get · iOS 2.2+

numberOfChannels

TypeScript
get numberOfChannels(): number
Swift declaration
var numberOfChannels: Int { get }
get · iOS 2.2+

numberOfLoops

TypeScript
get numberOfLoops(): number
Swift declaration
var numberOfLoops: Int { get set }
set · iOS 2.2+

numberOfLoops

TypeScript
set numberOfLoops(value: number)
Swift declaration
var numberOfLoops: Int { get set }
get · iOS 4.0+

pan

TypeScript
get pan(): number
Swift declaration
var pan: Float { get set }
set · iOS 4.0+

pan

TypeScript
set pan(value: number)
Swift declaration
var pan: Float { get set }
get · iOS 2.2+

isPlaying

TypeScript
get isPlaying(): boolean
Swift declaration
var isPlaying: Bool { get }
get · iOS 5.0+

rate

TypeScript
get rate(): number
Swift declaration
var rate: Float { get set }
set · iOS 5.0+

rate

TypeScript
set rate(value: number)
Swift declaration
var rate: Float { get set }
get · iOS 4.0+

settings

TypeScript
get settings(): Record<string, unknown>
Swift declaration
var settings: [String : Any] { get }
get · iOS 2.2+

url

TypeScript
get url(): (string) | null
Swift declaration
var url: URL? { get }
get · iOS 2.2+

volume

TypeScript
get volume(): number
Swift declaration
var volume: Float { get set }
set · iOS 2.2+

volume

TypeScript
set volume(value: number)
Swift declaration
var volume: Float { get set }

Skipped declarations

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

AVAudioPlayer.init()

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

All AVFAudio types →