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

CreatePlaylist - Create a Playlist
GetPlaylists - Get All Playlists
GetPlaylist - Retrieve Playlist
DeletePlaylist - Deletes a Playlist
UpdatePlaylist - Update a Playlist
GetPlaylistContents - Retrieve Playlist Contents
ClearPlaylistContents - Delete Playlist Contents
AddPlaylistContents - Adding to a Playlist
UploadPlaylist - Upload Playlist

CreatePlaylist

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"github.com/trevorstarick/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{
        Title: "<value>",
        Type: operations.CreatePlaylistQueryParamTypePhoto,
        Smart: operations.SmartOne,
        URI: "https://inborn-brochure.biz",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.CreatePlaylistRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreatePlaylistResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.CreatePlaylistBadRequest	400	application/json
sdkerrors.CreatePlaylistUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetPlaylists

Get All Playlists given the specified filters.

Example Usage

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.GetPlaylists(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`playlistType`	*operations.PlaylistType	➖	limit to a type of playlist.
`smart`	*operations.QueryParamSmart	➖	type of playlists to return (default is all).
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPlaylistsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.GetPlaylistsBadRequest	400	application/json
sdkerrors.GetPlaylistsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetPlaylist

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.GetPlaylist(ctx, 4109.48)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPlaylistResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.GetPlaylistBadRequest	400	application/json
sdkerrors.GetPlaylistUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

DeletePlaylist

This endpoint will delete a playlist

Example Usage

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.DeletePlaylist(ctx, 216.22)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DeletePlaylistResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.DeletePlaylistBadRequest	400	application/json
sdkerrors.DeletePlaylistUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

UpdatePlaylist

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.UpdatePlaylist(ctx, 3915, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`title`	*string	➖	name of the playlist
`summary`	*string	➖	summary description of the playlist
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UpdatePlaylistResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.UpdatePlaylistBadRequest	400	application/json
sdkerrors.UpdatePlaylistUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetPlaylistContents

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"github.com/trevorstarick/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.GetPlaylistContents(ctx, 5004.46, operations.GetPlaylistContentsQueryParamTypeTvShow)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`type_`	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
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPlaylistContentsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.GetPlaylistContentsBadRequest	400	application/json
sdkerrors.GetPlaylistContentsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

ClearPlaylistContents

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

Example Usage

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.ClearPlaylistContents(ctx, 1893.18)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ClearPlaylistContentsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ClearPlaylistContentsBadRequest	400	application/json
sdkerrors.ClearPlaylistContentsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

AddPlaylistContents

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.AddPlaylistContents(ctx, 8502.01, "server://12345/com.plexapp.plugins.library/library/metadata/1", plexgo.Float64(123))
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`playlistID`	float64	✔️	the ID of the playlist
`uri`	string	✔️	the content URI for the playlist	server://12345/com.plexapp.plugins.library/library/metadata/1
`playQueueID`	*float64	➖	the play queue to add to a playlist	123
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AddPlaylistContentsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.AddPlaylistContentsBadRequest	400	application/json
sdkerrors.AddPlaylistContentsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

UploadPlaylist

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

package main

import(
	"context"
	"github.com/trevorstarick/plexgo"
	"github.com/trevorstarick/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Playlists.UploadPlaylist(ctx, "/home/barkley/playlist.m3u", operations.QueryParamForceZero, 1)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`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`	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.
`sectionID`	int64	✔️	Possibly the section ID to upload the playlist to, we are not certain.	1
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UploadPlaylistResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.UploadPlaylistBadRequest	400	application/json
sdkerrors.UploadPlaylistUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Playlists

Overview

Available Operations

CreatePlaylist

Example Usage

Parameters

Response

Errors

GetPlaylists

Example Usage

Parameters

Response

Errors

GetPlaylist

Example Usage

Parameters

Response

Errors

DeletePlaylist

Example Usage

Parameters

Response

Errors

UpdatePlaylist

Example Usage

Parameters

Response

Errors

GetPlaylistContents

Example Usage

Parameters

Response

Errors

ClearPlaylistContents

Example Usage

Parameters

Response

Errors

AddPlaylistContents

Example Usage

Parameters

Response

Errors

UploadPlaylist

Example Usage

Parameters

Response

Errors