Skip to content

Music

Playback

#

stopAllDevices()

#

NOTICE

Only send this command to a single device and not all devices

Description

Stops audio playback on all echo devices

Required Paramaters

  • None Accepted

Example Usage

  • stopAllDevices()

togglePlayback()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control

Description

Used to toggle between playing and stopped state

Example Usage

  • togglePlayback()

Music Search

#

searchMusic()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control amd has access to a valid music streaming service.

Description

Used to play music from the desired music provider by using a specific search phrase.

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

  • ProviderId (String): [CLOUDPLAYER, AMAZON_MUSIC, APPLE_MUSIC, I_HEART_RADIO, PANDORA, SPOTIFY, TUNEIN]

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • sleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchMusic("thriller", "AMAZON_MUSIC")
  • searchMusic("thriller on the upstairs", "AMAZON_MUSIC", 40)
  • searchMusic("thriller on the upstairs", "AMAZON_MUSIC", 40, 300)

searchAmazonMusic()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control

Description

Used to play music from Amazon Music provider

Required Paramaters

  • SearchPhrase (String): String between 0-100 characters in length

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Between 0-100
  • sleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchAmazonMusic("thriller")
  • searchAmazonMusic("thriller on the upstairs", 40)
  • searchAmazonMusic("thriller on the upstairs", 40, 300)

searchAppleMusic()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control and connected to Apple Music Skill.

Description

Used to play music from Apple Music provider.
I have alse discovered that when trying to play songs I had to add the word song to the search phrase.

Required Paramaters

  • SearchPhrase (String): String between 0-100 characters in length.

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Between 0-100
  • sleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchAppleMusic("thriller")
  • searchAppleMusic("thriller on the upstairs", 40)
  • searchAppleMusic("thriller on the upstairs", 40, 300)

searchPandora()

#

NOTICE

Not available on all devices. Requires connection of Pandora skill.

Description

Used to play music from Pandora Radio provider

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length.

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • SleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchPandora("thriller")
  • searchPandora("thriller on the upstairs", 40)
  • searchPandora("thriller on the upstairs", 40, 300)

searchIheart()

#

NOTICE

Not available on all devices. Requires connection of iHeart Radio skill.

Description

Used to play music from iHeartRadio provider

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • SleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchIheart("thriller")
  • searchIheart("thriller on the upstairs", 40)
  • searchIheart("thriller on the upstairs", 40, 300)

searchSiriusXm()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control and Requires Sirius XM subscription.

Description

  • Used to play music from Sirius XM provider

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length.

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • SleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchSiriusXm("thriller")
  • searchSiriusXm("thriller on the upstairs", 40)
  • searchSiriusXm("thriller on the upstairs", 40, 300)

searchSpotify()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control and Requires Spotify subscription.

Description

  • Used to play music from Spotify provider

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length.

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • sleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchSpotify("thriller")
  • searchSpotify("thriller on the upstairs", 40)
  • searchSpotify("thriller on the upstairs", 40, 300)

searchTuneIn()

#

NOTICE

Not available on all devices. Only works on devices that support music playback control and connected to Tune-In Radio Skill.

Description

  • Used to play music from Tune-In Radio provider

Required Paramaters

  • SearchPhrase (String): Text between 0-100 characters in length.

    Tips

    This can be song name, playlist, artist.
    You can also add an audio group in the search to have it played under a group of alexa devices.
    I have discovered that when trying to play songs I had to add the word song to the search phrase.

Optional Paramaters

  • Volume (Integer): Number between 0-100
  • sleepSeconds (Integer): Number of seconds to play the music (Sleep timer)

Example Usage

  • searchTuneIn("thriller")
  • searchTuneIn("thriller on the upstairs", 40)
  • searchTuneIn("thriller on the upstairs", 40, 300)

Music Testing

#

I've recently added a Music Search Test section to the main page of the SmartThings/Hubitat app.

Last update: 2021-03-22