@kentcdodds/spotify

Spotify playback, playlist, search, library, and device helpers.

src/exports/play-context.ts

22 lines · 967 B · TypeScript

import { playContext } from '../lib/spotify-api.ts'
import type { PlayContextParams } from '../lib/export-types.ts'

/**
 * Start playback of a Spotify album, playlist, or artist context URI.
 * Omit device selectors to use the active Connect device. To target a device,
 * prefer `deviceName` (optional `deviceType`) over opaque `deviceId`.
 * All params accept an optional `account` ('personal' | 'family', default 'personal').
 * @returns Confirmation with ok, contextUri, deviceId, offsetIndex, shuffled, and status.
 * @example
 * import playContext from 'kody:@kentcdodds/spotify/play-context'
 * const result = await playContext({
 *   contextUri: 'spotify:playlist:37i9dQZF1DX0XUsuxWHRQd',
 *   deviceName: 'Living Room',
 * })
 * // => { ok: true, contextUri: 'spotify:playlist:...', deviceId: '...', status: 204 }
 */
async function spotifyPlayContext(params: PlayContextParams = {}) {
	return await playContext(params)
}

export default spotifyPlayContext