Playlists

(playlists)

Overview

Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017"). They can be organized in (optionally nesting) folders. Retrieving a playlist, or its items, will trigger a refresh of its metadata. This may cause the duration and number of items to change.

Available Operations

create_playlist - Create a Playlist
get_playlists - Get All Playlists
get_playlist - Retrieve Playlist
delete_playlist - Deletes a Playlist
update_playlist - Update a Playlist
get_playlist_contents - Retrieve Playlist Contents
clear_playlist_contents - Delete Playlist Contents
add_playlist_contents - Adding to a Playlist
upload_playlist - Upload Playlist

create_playlist

Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:

uri - The content URI for what we're playing (e.g. server://1234/com.plexapp.plugins.library/library/metadata/1).
playQueueID - To create a playlist from an existing play queue.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)


req = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(
  title: "<value>",
  type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,
  smart: ::PlexRubySDK::Operations::Smart::ONE,
  uri: "https://hoarse-testing.info/",
)
    
res = s.playlists.create_playlist(req)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::PlexRubySDK::Operations::CreatePlaylistRequest	✔️	The request object to use for the request.

Response

T.nilable(::PlexRubySDK::Operations::CreatePlaylistResponse)

get_playlists

Get All Playlists given the specified filters.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`playlist_type`	T.nilable(::PlexRubySDK::Operations::PlaylistType)	➖	limit to a type of playlist.
`smart`	T.nilable(::PlexRubySDK::Operations::QueryParamSmart)	➖	type of playlists to return (default is all).

Response

T.nilable(::PlexRubySDK::Operations::GetPlaylistsResponse)

get_playlist

Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item: Smart playlist details contain the content attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.get_playlist(playlist_id=4109.48)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`playlist_id`	::Float	✔️	the ID of the playlist

Response

T.nilable(::PlexRubySDK::Operations::GetPlaylistResponse)

delete_playlist

This endpoint will delete a playlist

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.delete_playlist(playlist_id=216.22)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`playlist_id`	::Float	✔️	the ID of the playlist

Response

T.nilable(::PlexRubySDK::Operations::DeletePlaylistResponse)

update_playlist

From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via PUT /library/metadata/{playlistID}

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.update_playlist(playlist_id=3915.00, title="<value>", summary="<value>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`playlist_id`	::Float	✔️	the ID of the playlist
`title`	T.nilable(::String)	➖	name of the playlist
`summary`	T.nilable(::String)	➖	summary description of the playlist

Response

T.nilable(::PlexRubySDK::Operations::UpdatePlaylistResponse)

get_playlist_contents

Gets the contents of a playlist. Should be paged by clients via standard mechanisms. By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the type parameter. For example, you could use this to display a list of recently added albums vis a smart playlist. Note that for dumb playlists, items have a playlistItemID attribute which is used for deleting or moving items.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`playlist_id`	::Float	✔️	the ID of the playlist
`type`	::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType	✔️	The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2

Response

T.nilable(::PlexRubySDK::Operations::GetPlaylistContentsResponse)

clear_playlist_contents

Clears a playlist, only works with dumb playlists. Returns the playlist.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.clear_playlist_contents(playlist_id=1893.18)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`playlist_id`	::Float	✔️	the ID of the playlist

Response

T.nilable(::PlexRubySDK::Operations::ClearPlaylistContentsResponse)

add_playlist_contents

Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new uri parameter replaces the rules for the playlist. Returns the playlist.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.add_playlist_contents(playlist_id=8502.00, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123.0)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`playlist_id`	::Float	✔️	the ID of the playlist
`uri`	::String	✔️	the content URI for the playlist	server://12345/com.plexapp.plugins.library/library/metadata/1
`play_queue_id`	T.nilable(::Float)	➖	the play queue to add to a playlist	123

Response

T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsResponse)

upload_playlist

Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=::PlexRubySDK::Operations::QueryParamForce::ZERO, section_id=1)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`path`	::String	✔️	absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. If the `path` argument is a directory, that path will be scanned for playlist files to be processed. Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. The GUID of each playlist is based on the filename. If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. The GUID of each playlist is based on the filename.	/home/barkley/playlist.m3u
`force`	::PlexRubySDK::Operations::QueryParamForce	✔️	Force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
`section_id`	::Integer	✔️	Possibly the section ID to upload the playlist to, we are not certain.	1

Response

T.nilable(::PlexRubySDK::Operations::UploadPlaylistResponse)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Playlists

Overview

Available Operations

create_playlist

Example Usage

Parameters

Response

get_playlists

Example Usage

Parameters

Response

get_playlist

Example Usage

Parameters

Response

delete_playlist

Example Usage

Parameters

Response

update_playlist

Example Usage

Parameters

Response

get_playlist_contents

Example Usage

Parameters

Response

clear_playlist_contents

Example Usage

Parameters

Response

add_playlist_contents

Example Usage

Parameters

Response

upload_playlist

Example Usage

Parameters

Response