Class

WKAudioFilePlayerItem

An object that manages the presentation state of an audio file while it is being played.

Declaration

@interface WKAudioFilePlayerItem : NSObject

Overview

Create a player item for each WKAudioFileAsset object you want to play and use the player item to observe the state of the audio during playback. You can then associate the player item with an audio queue or player object to control the playback.

The value of the player item’s presentation-related properties are not valid until the underlying asset is loaded. Use the value of the status property to determine when it is valid to get the values of other properties. Specifically, wait until the status changes to WKAudioFilePlayerItemStatusReadyToPlay to access relevant properties.

If you want to play an asset more than once within a queue of items, you must create separate player items for each placement in the queue.

Topics

Creating a Player Item

+ playerItemWithAsset:

Creates and returns a player item for the specified audio file asset.

Getting Information About the Item

asset

The audio file asset being managed.

status

The status of the player item.

error

An error that describes the cause of a failure.

Managing the Playback Position

currentTime

The current playback point, measured in seconds, from the beginning of the audio file.

- setCurrentTime:

Sets the playback point, measured in seconds, from the beginning of the audio file.

Accessing the Item’s Status

WKAudioFilePlayerItemStatus

Constants that represent the status of a player item.

Receiving Notifications

WKAudioFilePlayerItemTimeJumpedNotification

A notification that the item’s current time has changed discontinuously.

WKAudioFilePlayerItemDidPlayToEndTimeNotification

A notification that the item has played successfully to its end.

WKAudioFilePlayerItemFailedToPlayToEndTimeNotification

A notification that the item failed to play to its end.

Relationships

Inherits From

See Also

Audio

Playing Background Audio

Enable background audio in your app to provide a seamless playback experience.

Adding a Now Playing View

Provide a view that controls the currently playing audio from your app.

WKInterfaceVolumeControl

An interface element that lets users control the audio volume from the watch or a paired iPhone.

property list key PUICAutoLaunchAudioOptOut

A Boolean value indicating whether a watchOS app should opt out of automatically launching when its companion iOS app starts playing audio content.

Name: Opt out of Auto-launch Audio App (Watch)
WKAudioFilePlayer

An object that controls playback of a single audio item.

Deprecated
WKAudioFileQueuePlayer

An object that controls playback of one or more audio items.

Deprecated
WKAudioFileAsset

An object that stores a reference to an audio file and provides metadata information about that file.

Deprecated