Contents

PlayMediaIntent

An object that describes the user’s request to play a media item.

Declaration

object PlayMediaIntent

Properties

NameTypeDescription
classstring

The specific type of intent.

mediaItems[MediaItem]

Particular pieces of media, such as songs, albums, or playlists, to play.

In a resolveMediaItems request, this value is generally empty. Your service responds with a PlayMediaIntentHandlingResolveMediaItemsInvocationResponse that contains an array of MediaItem results, with the most relevant one first. On subsequent requests to process this intent, this value contains that array.

mediaSearchMediaSearch

Search parameters that describe the media items the user wants to play.

playbackQueueLocationPlaybackQueueLocation

The position within the queue to play the requested media items.

playbackRepeatModePlaybackRepeatMode

A value that indicates whether to play one or all of the media items more than once.

If your service supports repeat modes, repeat the content within the queue you provide. The client doesn’t replay queue segments.

playbackSpeeddouble

The rate for the media items to play, relative to normal speed.

The default value of this property is 1.0. The user can request a different playback speed with several Siri utterances, such as “Play slower” or “Play double speed.” However, the client always plays content at the normal speed, as if this value is 1.0.

playShuffledboolean

A Boolean value that indicates whether to randomize the order of media items during playback.

resumePlaybackboolean

A Boolean that indicates whether to continue paused content, or to start at the beginning of the requested media item.

See Also

Processing a Play Media Intent