Plugin iTunes

From VoxCommando
Revision as of 16:07, 7 February 2017 by Jitterjames (talk) (Installation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Go to the main Plugins page.

Go to the complete Plugin List.

Installation

Click here for instructions on setting up iTunes with the iTunes plugin for VC.

Plugin Description

Commands to control iTunes and to retrieve information about currently playing media. Various playback events are generated

Actions for the iTunes plugin

Play

iTunes.Play
Same as clicking Play in iTunes. Begins playback.

Pause

iTunes.Pause
Same as clicking Pause in iTunes. Toggles playback.

Stop

iTunes.Stop
Same as clicking Stop in iTunes. Stops playback.

Previous

iTunes.Previous
Same as clicking Previous Track in iTunes

Next

iTunes.Next
Same as clicking NextTrack in iTunes

SetVolume

iTunes.SetVolume
Sets iTunes to the desired volume level. Expects an integer from 0 to 100

  • Parameters: 1
  1. Volume : Desired volume: 0-100 [integer]

GetVolume

iTunes.GetVolume
Returns the current iTunes volume level (0-100)

SoftMute

iTunes.SoftMute
Partially mutes iTunes. Generally used when performing TTS to make the voice easier to hear.

SoftUnmute

iTunes.SoftUnmute
Returns volume to the level it was at before calling SoftMute.

SetRating

iTunes.SetRating
Rates the current song. Parameter indicates the number of stars. Use 0 for unrated.

  • Parameters: 1
  1. Rating : Star rating: 0-5 [integer]

OpenURL

iTunes.OpenURL
Start streaming audio from a web URL (internet radio)

  • Parameters: 1
  1. URL : URL of stream to open [string]

RequestMusic

Either load an exisiting playlist (Request Playlist) or create a new temporary playlist and populate it based on search criteria.

SetShuffleLoad

iTunes.SetShuffleLoad
If parameter is True then all future RequestMusic commands will shuffle the new playlist on load.

  • Parameters: 1
  1. Shuffle : If true, music is shuffled when requested [boolean]

RequestPlaylist

iTunes.rqPlaylist


  • Parameters: 1
  1. Playlist : Name of playlist to load and play [string]

RequestArtist

iTunes.rqArtist
Loads and plays songs by <Artist>

  • Parameters: 1
  1. Artist : Play songs by this artist [string]

RequestAlbum

iTunes.rqAlbum
Loads and plays songs in <Album>

  • Parameters: 1
  1. Album : Play this album [string]

RequestSong

iTunes.rqSong
Plays song <Song>

  • Parameters: 1
  1. Song : Song title to play [string]

RequestAll

iTunes.rqAll
Searches for and plays song. A fields are searched.

For example, if <Text> is blues you will get songs from the genre blues, but also songs with blues in the title or albums with blues in the album name.

  • Parameters: 1
  1. Text : plays all songs containing the search text [string]

RequestVisible

iTunes.rqVisible
Same as Request.All but only searches columns that are visible in the iTunes browser window. Needs testing...

  • Parameters: 1
  1. SearchText : plays all songs containing the search text [string]

Get Info on current track

Retreive information (stored in tags and/or the iTunes database) about the currently playing track. As with other commands, the results are stored in {LastResult}. These commands will only work if you music is properly tagged.

GetArtist

iTunes.GetArtist
Retreive the artist name of the currently playing track.

GetAlbum

iTunes.GetAlbum
Retreive the album name of the currently playing track.

GetSongTitle

iTunes.GetSongTitle
Retreive the song title of the currently playing track.

GetRating

iTunes.GetRating
Retreive the user rating of the currently playing track.

GetGenre

iTunes.GetGenre
Retreive the genre of the currently playing track.

GetYear

iTunes.GetYear
Retreive the year of the currently playing track.