soundcloud-api-ts - v1.9.0
    Preparing search index...

    Interface SoundCloudPlaylist

    Represents a SoundCloud playlist (also known as a "set").

    interface SoundCloudPlaylist {
        artwork_url: string;
        created_at: string;
        description: string;
        downloadable: boolean;
        duration: number;
        ean: string;
        embeddable_by: string;
        genre: string;
        id: number;
        kind: string;
        label: SoundCloudUser | null;
        label_id: number | null;
        label_name: string;
        last_modified: string;
        license: string;
        likes_count: number;
        permalink: string;
        permalink_url: string;
        playlist_type: string;
        purchase_title: string;
        purchase_url: string;
        release: string;
        release_day: number;
        release_month: number;
        release_year: number;
        sharing: string;
        streamable: boolean;
        tag_list: string;
        tags: string | null;
        title: string;
        track_count: number;
        tracks: SoundCloudTrack[];
        tracks_uri: string | null;
        type: string;
        uri: string;
        urn: string;
        user: SoundCloudUser;
        user_id: number;
        user_urn: string;
    }
    Index

    Properties

    artwork_url: string

    URL to the playlist's artwork image

    created_at: string

    ISO 8601 timestamp of when the playlist was created

    description: string

    The playlist's description text

    downloadable: boolean

    Whether tracks in the playlist are downloadable

    duration: number

    Total duration of all tracks in the playlist in milliseconds

    ean: string

    European Article Number (barcode) for the release

    embeddable_by: string

    Who can embed this playlist (e.g. "all", "me", "none")

    genre: string

    Music genre of the playlist

    id: number

    The playlist's unique numeric ID on SoundCloud

    kind: string

    Resource type, always "playlist"

    label: SoundCloudUser | null

    Label user object, or null if no label is associated

    label_id: number | null

    Numeric ID of the associated label, or null

    label_name: string

    Name of the associated record label

    last_modified: string

    ISO 8601 timestamp of the last modification

    license: string

    Creative Commons license type

    likes_count: number

    Total number of likes on this playlist

    permalink: string

    URL-friendly slug for the playlist

    permalink_url: string

    Full URL to the playlist's SoundCloud page

    playlist_type: string

    Type of playlist (e.g. "album", "ep", "compilation")

    purchase_title: string

    Label for the purchase/buy button

    purchase_url: string

    External purchase URL

    release: string

    Release identifier string

    release_day: number

    Day of the release date (1-31)

    release_month: number

    Month of the release date (1-12)

    release_year: number

    Year of the release date

    sharing: string

    Sharing setting: "public" or "private"

    streamable: boolean

    Whether the playlist contains streamable tracks

    tag_list: string

    Space-separated list of tags

    tags: string | null

    Comma-separated tags string, or null

    title: string

    The playlist's title

    track_count: number

    Total number of tracks in the playlist

    tracks: SoundCloudTrack[]

    Array of tracks in the playlist (may be empty if not fetched)

    tracks_uri: string | null

    API URI to fetch the playlist's tracks, or null

    type: string

    Playlist set type (e.g. "album", "playlist")

    uri: string

    API resource URI for this playlist

    urn: string

    URN identifier (e.g. "soundcloud:playlists:123")

    The user who created this playlist

    user_id: number

    Numeric ID of the playlist creator

    user_urn: string

    URN of the playlist creator