Skip to content

sok.media.music.playlist

Playlist class for music playlists.

Playlist

class Playlist(
name: str,
language: str,
media_manager: UniversalMediaManager,
owner: str = '',
)

Bases: BaseMedia

Class for managing music playlists.

Represents a collection of tracks organized in a playlist.

Initialize a Playlist instance.

Parameters

NameTypeDefaultDescription
namestrPlaylist name.
languagestrLanguage code.
media_managerUniversalMediaManagerThe API manager.
ownerstr''Playlist owner name.
Source

Attributes

NameTypeDescription
created_atOptional[datetime]

Playlist creation date.

duration_totalint

Total duration in seconds.

is_publicbool

Whether the playlist is public.

owner

Playlist owner/creator.

track_countint

Total number of tracks.

tracksList[Dict[str, Any]]

List of tracks in the playlist.

updated_atOptional[datetime]

Last update date.

add_track

def add_track(track: Dict[str, Any]) -> None:

Add a track to the playlist.

Parameters

NameTypeDescription
trackDict[str, Any]Track data dictionary.
Source

from_dictclassmethod

def from_dict(
data: Dict[str, Any],
media_manager: UniversalMediaManager,
) -> Playlist:

Create a Playlist instance from a dictionary.

Parameters

NameTypeDescription
dataDict[str, Any]Playlist data.
media_managerUniversalMediaManagerThe API manager.

Returns

Source

get_detailsasync

async def get_details() -> None:

Retrieve detailed playlist information.

Fills attributes: tracks, owner, dates, etc.

Source

get_duration_formatted

def get_duration_formatted() -> str:

Return formatted total duration (HH:MM:SS).

Returns

  • strFormatted duration string.
Source

get_formatted_name

def get_formatted_name() -> str:

Return the formatted playlist name.

Returns

  • strFormatted playlist name with track count.
Source

remove_track

def remove_track(track_id: str) -> bool:

Remove a track from the playlist.

Parameters

NameTypeDescription
track_idstrID of the track to remove.

Returns

  • boolTrue if track was removed, False otherwise.
Source

to_dict

def to_dict() -> Dict[str, Any]:

Convert the playlist to a dictionary.

Returns

  • Dict[str, Any]Playlist data as dictionary.
Source
Built with Kiln