diff --git a/docs/classes/_index_.scdl.html b/docs/classes/_index_.scdl.html index 9d03d2a..b8f5787 100644 --- a/docs/classes/_index_.scdl.html +++ b/docs/classes/_index_.scdl.html @@ -114,7 +114,7 @@

FORMATS

FORMATS: {}
@@ -132,7 +132,7 @@

STREAMING_PROTOCOLS

STREAMING_PROTOCOLS: {}
@@ -150,7 +150,7 @@

Private _clientID: string

@@ -167,7 +167,7 @@

download

  • @@ -205,7 +205,7 @@

    downloadFormat

  • @@ -248,7 +248,7 @@

    filterMedia

  • @@ -286,7 +286,7 @@

    getInfo

  • @@ -324,7 +324,7 @@

    getSetInfo

  • @@ -362,7 +362,7 @@

    getTrackInfoByID

  • @@ -400,7 +400,7 @@

    isValidUrl

  • @@ -425,32 +425,26 @@

    Returns string

    related

      -
    • related(type: SoundcloudResource, id: number, limit: number, offset?: number, clientID?: string): Promise<{ collection: T[]; next_href: string; query_urn: string; variant: string }>
      • +
    • related(id: number, limit: number, offset?: number, clientID?: string): Promise<{ collection: T[]; next_href: string; query_urn: string; variant: string }>
    • -

      Finds related tracks/playlists/albums to the given track/playlist/album specified by ID

      +

      Finds related tracks to the given track specified by ID

      Parameters

        -
      • -
        type: SoundcloudResource
        -
        -

        'tracks', 'people', 'albums', 'playlists'

        -
        -
      • id: number
        -

        The ID of the resource

        +

        The ID of the track

      • @@ -486,7 +480,7 @@

        search

      • @@ -499,7 +493,7 @@

        Parameters

      • type: SoundcloudResource | "all"
        -

        The type of resource, one of: 'tracks', 'people', 'albums', 'playlists', 'all'

        +

        The type of resource, one of: 'tracks', 'users', 'albums', 'playlists', 'all'

      • diff --git a/docs/enums/_formats_.formats.html b/docs/enums/_formats_.formats.html index 578e9ac..0e339d8 100644 --- a/docs/enums/_formats_.formats.html +++ b/docs/enums/_formats_.formats.html @@ -98,7 +98,7 @@

        MP3

        MP3: = "audio/mpeg"
        @@ -108,7 +108,7 @@

        OPUS

        OPUS: = "audio/ogg; codecs="opus""
        diff --git a/docs/enums/_protocols_.streaming_protocols.html b/docs/enums/_protocols_.streaming_protocols.html index f51db5e..9c5862e 100644 --- a/docs/enums/_protocols_.streaming_protocols.html +++ b/docs/enums/_protocols_.streaming_protocols.html @@ -98,7 +98,7 @@

        HLS

        HLS: = "hls"
        @@ -108,7 +108,7 @@

        PROGRESSIVE

        PROGRESSIVE: = "progressive"
        diff --git a/docs/interfaces/_filter_media_.filterpredicateobject.html b/docs/interfaces/_filter_media_.filterpredicateobject.html index ea384fb..43f4ca6 100644 --- a/docs/interfaces/_filter_media_.filterpredicateobject.html +++ b/docs/interfaces/_filter_media_.filterpredicateobject.html @@ -99,7 +99,7 @@

        Optional format

        format: FORMATS
        @@ -109,7 +109,7 @@

        Optional protocol

        protocol: STREAMING_PROTOCOLS
        diff --git a/docs/interfaces/_info_.setinfo.html b/docs/interfaces/_info_.setinfo.html index 2700a2d..abb0d90 100644 --- a/docs/interfaces/_info_.setinfo.html +++ b/docs/interfaces/_info_.setinfo.html @@ -136,7 +136,7 @@

        Optional artwork_url

        artwork_url: string
        @@ -146,7 +146,7 @@

        created_at

        created_at: string
        @@ -156,7 +156,7 @@

        Optional description

        description: string
        @@ -166,7 +166,7 @@

        display_date

        display_date: string
        @@ -176,7 +176,7 @@

        duration

        duration: number
        @@ -186,7 +186,7 @@

        embeddable_by

        embeddable_by: string
        @@ -196,7 +196,7 @@

        genre

        genre: string
        @@ -206,7 +206,7 @@

        id

        id: number
        @@ -216,7 +216,7 @@

        is_album

        is_album: boolean
        @@ -226,7 +226,7 @@

        kind

        kind: string
        @@ -236,7 +236,7 @@

        Optional label_name

        label_name: string
        @@ -246,7 +246,7 @@

        last_modified

        last_modified: string
        @@ -256,7 +256,7 @@

        license

        license: string
        @@ -266,7 +266,7 @@

        likes_count

        likes_count: number
        @@ -276,7 +276,7 @@

        managed_by_feeds

        managed_by_feeds: boolean
        @@ -286,7 +286,7 @@

        permalink

        permalink: string
        @@ -296,7 +296,7 @@

        permalink_url

        permalink_url: string
        @@ -306,7 +306,7 @@

        public

        public: boolean
        @@ -316,7 +316,7 @@

        published_at

        published_at: string
        @@ -326,7 +326,7 @@

        Optional purchase_titlepurchase_title: string

    @@ -336,7 +336,7 @@

    Optional purchase_url

    purchase_url: string
    • @@ -346,7 +346,7 @@

    Optional release_date

    release_date: string @@ -356,7 +356,7 @@

    reposts_count

    reposts_count: number
    @@ -366,7 +366,7 @@

    Optional secret_token

    secret_token: string @@ -376,7 +376,7 @@

    set_type

    set_type: string
    @@ -386,7 +386,7 @@

    sharing

    sharing: string
    @@ -396,7 +396,7 @@

    tag_list

    tag_list: string
    @@ -406,7 +406,7 @@

    track_count

    track_count: number
    @@ -416,7 +416,7 @@

    tracks

    tracks: TrackInfo[]
    @@ -426,7 +426,7 @@

    uri

    uri: string
    @@ -436,7 +436,7 @@

    user

    user: User
    @@ -446,7 +446,7 @@

    user_id

    user_id: number
    diff --git a/docs/interfaces/_info_.trackinfo.html b/docs/interfaces/_info_.trackinfo.html index 32dca34..0a0356b 100644 --- a/docs/interfaces/_info_.trackinfo.html +++ b/docs/interfaces/_info_.trackinfo.html @@ -138,7 +138,7 @@

    Optional artwork_url

    artwork_url: string
    @@ -148,7 +148,7 @@

    Optional comment_countcomment_count: number @@ -158,7 +158,7 @@

    Optional commentable

    commentable: boolean
    @@ -168,7 +168,7 @@

    Optional created_at

    created_at: string
    @@ -178,7 +178,7 @@

    Optional description

    description: string
    @@ -188,7 +188,7 @@

    Optional display_date

    display_date: string @@ -198,7 +198,7 @@

    Optional download_countdownload_count: number @@ -208,7 +208,7 @@

    Optional downloadable

    downloadable: false
    @@ -218,7 +218,7 @@

    Optional duration

    duration: number
    @@ -228,7 +228,7 @@

    Optional full_durationfull_duration: number @@ -238,7 +238,7 @@

    Optional genre

    genre: string
    @@ -248,7 +248,7 @@

    Optional has_downloads_has_downloads_left: boolean @@ -258,7 +258,7 @@

    id

    id: number
    @@ -268,7 +268,7 @@

    kind

    kind: string
    @@ -278,7 +278,7 @@

    Optional label_name

    label_name: string
    @@ -288,7 +288,7 @@

    Optional last_modifiedlast_modified: string @@ -298,7 +298,7 @@

    Optional likes_count

    likes_count: number
    @@ -308,7 +308,7 @@

    Optional media

    media: { transcodings: Transcoding[] }
    @@ -326,7 +326,7 @@

    monetization_model

    monetization_model: string
    @@ -336,7 +336,7 @@

    Optional permalink

    permalink: string
    @@ -346,7 +346,7 @@

    Optional permalink_urlpermalink_url: string

    @@ -356,7 +356,7 @@

    Optional playback_countplayback_count: number @@ -366,7 +366,7 @@

    policy

    policy: string
    @@ -376,7 +376,7 @@

    Optional public

    public: boolean
    @@ -386,7 +386,7 @@

    Optional publisher_metada
    publisher_metadata: any
    @@ -396,7 +396,7 @@

    Optional reposts_countreposts_count: number @@ -406,7 +406,7 @@

    Optional state

    state: string
    @@ -416,7 +416,7 @@

    Optional streamable

    streamable: true
    @@ -426,7 +426,7 @@

    Optional tag_list

    tag_list: string
    @@ -436,7 +436,7 @@

    Optional title

    title: string
    @@ -446,7 +446,7 @@

    Optional uri

    uri: string
    @@ -456,7 +456,7 @@

    Optional user

    user: User
    @@ -466,7 +466,7 @@

    Optional user_id

    user_id: number
    @@ -476,7 +476,7 @@

    Optional waveform_url

    waveform_url: string diff --git a/docs/interfaces/_info_.transcoding.html b/docs/interfaces/_info_.transcoding.html index f0031ad..e04d841 100644 --- a/docs/interfaces/_info_.transcoding.html +++ b/docs/interfaces/_info_.transcoding.html @@ -108,7 +108,7 @@

    format

    format: { mime_type: FORMATS; protocol: STREAMING_PROTOCOLS }
    @@ -129,7 +129,7 @@

    preset

    preset: string
    @@ -139,7 +139,7 @@

    snipped

    snipped: boolean
    @@ -149,7 +149,7 @@

    url

    url: string
    diff --git a/docs/interfaces/_info_.user.html b/docs/interfaces/_info_.user.html index 1573708..5e3df86 100644 --- a/docs/interfaces/_info_.user.html +++ b/docs/interfaces/_info_.user.html @@ -120,7 +120,7 @@

    avatar_url

    avatar_url: string
    @@ -130,7 +130,7 @@

    city

    city: string
    @@ -140,7 +140,7 @@

    comments_count

    comments_count: number
    @@ -150,7 +150,7 @@

    country_code

    country_code: string
    @@ -160,7 +160,7 @@

    created_at

    created_at: string
    @@ -170,7 +170,7 @@

    description

    description: string
    @@ -180,7 +180,7 @@

    first_name

    first_name: string
    @@ -190,7 +190,7 @@

    followers_count

    followers_count: number
    @@ -200,7 +200,7 @@

    followings_count

    followings_count: number
    @@ -210,7 +210,7 @@

    full_name

    full_name: string
    @@ -220,7 +220,7 @@

    groups_count

    groups_count: number
    @@ -230,7 +230,7 @@

    id

    id: number
    @@ -240,7 +240,7 @@

    last_name

    last_name: string
    @@ -250,7 +250,7 @@

    permalink_url

    permalink_url: string
    @@ -260,7 +260,7 @@

    uri

    uri: string
    @@ -270,7 +270,7 @@

    username

    username: string
    diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html index 90c3526..6865334 100644 --- a/docs/modules/_index_.html +++ b/docs/modules/_index_.html @@ -93,7 +93,7 @@

    Const scdl

    scdl: SCDL = new SCDL()
    diff --git a/docs/modules/_info_.html b/docs/modules/_info_.html index e9fb1f4..da8a76e 100644 --- a/docs/modules/_info_.html +++ b/docs/modules/_info_.html @@ -100,7 +100,7 @@

    Const getTrackInfo
  • diff --git a/docs/modules/_search_.html b/docs/modules/_search_.html index 0ed7241..9ac6c53 100644 --- a/docs/modules/_search_.html +++ b/docs/modules/_search_.html @@ -90,7 +90,7 @@

    RelatedResponse

    RelatedResponse<T>: { collection: T[]; next_href: string; query_urn: string; variant: string }

    Type parameters

    @@ -123,7 +123,7 @@

    SearchResponse

    SearchResponse<T>: { collection: T[]; next_href: string; query_urn: string; total_results: number }

    Type parameters

    @@ -156,17 +156,17 @@

    SearchResponseAll

    SearchResponseAll: SearchResponse<User | SetInfo | TrackInfo>

    SoundcloudResource

    -
    SoundcloudResource: "tracks" | "people" | "albums" | "playlists"
    +
    SoundcloudResource: "tracks" | "users" | "albums" | "playlists"