iTunes.play()

Type function
Return value none
Revision Release 2024.3703
Keywords play, iTunes
See also iTunes
iTunes.pause()
iTunes.resume()
iTunes.stop()

Overview

Plays an item selected from the iTunes library.

Syntax

iTunes.play( songUrl )
iTunes.play( songUrl, onComplete )
songUrl (required)

String. The song URL to play, as retrieved from the callback function of iTunes.show().

onComplete (optional)

Listener. The callback function which is executed after dismissing the iTunes library picker.

Example

local iTunes = require( "plugin.iTunes" )

-- Table to store media items
local mediaItems = {}

-- Function that is executed when song playback is complete
local function onPlaybackEnded()
    print( "Playback completed!" )
end

-- Function that is executed after media item(s) have been chosen
local function onMediaChosen( event )

    if ( event.data ) then
        for i=1,#event.data do
            mediaItems[i] = event.data[i]
        end
        
        --play the first item chosen
        iTunes.play( mediaItems[1].url, onPlaybackEnded )

    end 
end

local iTunesOptions =
{
    allowsPickingMultipleItems = true,
    promptTitle = "Select some songs"
}
iTunes.show( iTunesOptions, onMediaChosen )