One Logo Pool Ball
CarPlay · IOS API REFERENCE

CPNowPlayingTemplate

class · iOS 14.0+ · SDK 27.1

@MainActor class CPNowPlayingTemplate

Members (15)

get · iOS 14.0+

shared

TypeScript
static get shared(): Promise<CPNowPlayingTemplate>
Swift declaration
class var shared: CPNowPlayingTemplate { get }
method · iOS 14.0+

add

TypeScript
add(observer: Implements<CPNowPlayingTemplateObserver> | SDKHandle): Promise<void>
Swift declaration
func add(_ observer: any CPNowPlayingTemplateObserver)
method · iOS 14.0+

remove

TypeScript
remove(observer: Implements<CPNowPlayingTemplateObserver> | SDKHandle): Promise<void>
Swift declaration
func remove(_ observer: any CPNowPlayingTemplateObserver)
method · iOS 14.0+

updateNowPlayingButtons

TypeScript
updateNowPlayingButtons(nowPlayingButtons: Array<CPNowPlayingButton>): Promise<void>
Swift declaration
func updateNowPlayingButtons(_ nowPlayingButtons: [CPNowPlayingButton])
get · iOS 14.0+

isAlbumArtistButtonEnabled

TypeScript
get isAlbumArtistButtonEnabled(): Promise<boolean>
Swift declaration
var isAlbumArtistButtonEnabled: Bool { get set }
set · iOS 14.0+

isAlbumArtistButtonEnabled

TypeScript
setIsAlbumArtistButtonEnabled(value: boolean): Promise<void>
Swift declaration
var isAlbumArtistButtonEnabled: Bool { get set }
get · iOS 27.0+

allowsMiniPlayer

TypeScript
get allowsMiniPlayer(): Promise<boolean>
Swift declaration
var allowsMiniPlayer: Bool { get set }
set · iOS 27.0+

allowsMiniPlayer

TypeScript
setAllowsMiniPlayer(value: boolean): Promise<void>
Swift declaration
var allowsMiniPlayer: Bool { get set }
get · iOS 14.0+

nowPlayingButtons

TypeScript
get nowPlayingButtons(): Promise<Array<CPNowPlayingButton>>
Swift declaration
var nowPlayingButtons: [CPNowPlayingButton] { get }
get · iOS 18.4+

nowPlayingMode

TypeScript
get nowPlayingMode(): Promise<(CPNowPlayingMode) | null>
Swift declaration
var nowPlayingMode: CPNowPlayingMode? { get set }
set · iOS 18.4+

nowPlayingMode

TypeScript
setNowPlayingMode(value?: (CPNowPlayingMode) | null): Promise<void>
Swift declaration
var nowPlayingMode: CPNowPlayingMode? { get set }
get · iOS 14.0+

isUpNextButtonEnabled

TypeScript
get isUpNextButtonEnabled(): Promise<boolean>
Swift declaration
var isUpNextButtonEnabled: Bool { get set }
set · iOS 14.0+

isUpNextButtonEnabled

TypeScript
setIsUpNextButtonEnabled(value: boolean): Promise<void>
Swift declaration
var isUpNextButtonEnabled: Bool { get set }
get · iOS 14.0+

upNextTitle

TypeScript
get upNextTitle(): Promise<string>
Swift declaration
var upNextTitle: String { get set }
set · iOS 14.0+

upNextTitle

TypeScript
setUpNextTitle(value: string): Promise<void>
Swift declaration
var upNextTitle: String { get set }

Skipped declarations

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

CPNowPlayingTemplate.init()

inherited init: clang: 'init' is unavailable

All CarPlay types →