Class SCDL

Hierarchy

SCDL

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SCDL(options?: SCDLOptions): SCDL

- Defined in index.ts:61
Parameters
- Optional options: SCDLOptions
Returns SCDL

Properties

FORMATS

FORMATS: {}

Type declaration

[key: string]: default

STREAMING_PROTOCOLS

STREAMING_PROTOCOLS: {}

Type declaration

[key: string]: default

Private Optional _clientID

_clientID: string

Private Optional _filePath

_filePath: string

axios

axios: AxiosInstance

convertFirebaseLinks

convertFirebaseLinks: boolean

saveClientID

saveClientID: boolean = ...

stripMobilePrefix

stripMobilePrefix: boolean

Methods

download

download(url: string, useDirectLink?: boolean): Promise<any>

- Defined in index.ts:104
Get the audio of a given track. It returns the first format found.

Parameters
- url: string
  
  The URL of the Soundcloud track
- useDirectLink: boolean = true
  
  Whether or not to use the download link if the artist has set the track to be downloadable. This has erratic behaviour on some environments.
Returns Promise<any>

A ReadableStream containing the audio data

downloadFormat

downloadFormat(url: string, format: default): Promise<any>

- Defined in index.ts:113
Get the audio of a given track with the specified format

Parameters
- url: string
  
  The URL of the Soundcloud track
- format: default
  
  The desired format
Returns Promise<any>

downloadPlaylist

downloadPlaylist(url: string): Promise<[ReadableStream<any>[], String[]]>

- Defined in index.ts:167
Returns the audio streams and titles of the tracks in the given playlist.

Parameters
- url: string
  
  The url of the playlist
Returns Promise<[ReadableStream<any>[], String[]]>

filterMedia

filterMedia(media: Transcoding[], predicateObj: FilterPredicateObject): Transcoding[]

- Defined in index.ts:93
Returns a media Transcoding that matches the given predicate object

Parameters
- media: Transcoding[]
  
  The Transcodings to filter
- predicateObj: FilterPredicateObject
  
  The desired Transcoding object to match
Returns Transcoding[]

An array of Transcodings that match the predicate object

getClientID

getClientID(): Promise<string>

- Defined in index.ts:242
Returns Promise<string>

getInfo

getInfo(url: string): Promise<TrackInfo>

- Defined in index.ts:122
Returns info about a given track.

Parameters
- url: string
  
  URL of the Soundcloud track
Returns Promise<TrackInfo>

Info about the track

getLikes

getLikes(options: GetLikesOptions): Promise<PaginatedQuery<Like>>

- Defined in index.ts:176
Returns track information for a user's likes

Parameters
- options: GetLikesOptions
  
  Can either be the profile URL of the user, or their ID
Returns Promise<PaginatedQuery<Like>>
- An array of tracks

getSetInfo

getSetInfo(url: string): Promise<SetInfo>

- Defined in index.ts:140
Returns info about the given set

Parameters
- url: string
  
  URL of the Soundcloud set
Returns Promise<SetInfo>

Info about the set

getTrackInfoByID

getTrackInfoByID(ids: number[], playlistID?: number, playlistSecretToken?: string): Promise<TrackInfo[]>

- Defined in index.ts:131
Returns info about the given track(s) specified by ID.

Parameters
- ids: number[]
  
  The ID(s) of the tracks
- Optional playlistID: number
- Optional playlistSecretToken: string
Returns Promise<TrackInfo[]>

Info about the track

getUser

getUser(url: string): Promise<User>

- Defined in index.ts:198
Returns information about a user

Parameters
- url: string
  
  The profile URL of the user
Returns Promise<User>

isFirebaseURL

isFirebaseURL(url: string): boolean

- Defined in index.ts:238
Returns true if the given URL is a Firebase URL (of the form https://soundcloud.app.goo.gl/XXXXXXXX)

Parameters
- url: string
  
  The URL to check
Returns boolean

isPersonalizedTrackURL

isPersonalizedTrackURL(url: string): boolean

- Defined in index.ts:230
Returns true if the given URL is a personalized track URL. (of the form https://soundcloud.com/discover/sets/personalized-tracks::user-sdlkfjsldfljs:847104873)

Parameters
- url: string
  
  The URL to check
Returns boolean

isPlaylistURL

isPlaylistURL(url: string): boolean

- Defined in index.ts:222
Returns whether or not the given URL is a valid playlist SoundCloud URL

Parameters
- url: string
  
  The URL to check
Returns boolean

isValidUrl

isValidUrl(url: string): boolean

- Defined in index.ts:214
Returns whether or not the given URL is a valid Soundcloud URL

Parameters
- url: string
  
  URL of the Soundcloud track
Returns boolean

prepareURL

prepareURL(url: string): Promise<string>

- Defined in index.ts:319
Prepares the given URL by stripping its mobile prefix (if this.stripMobilePrefix is true) and converting it to a regular URL (if this.convertFireBaseLinks is true.)

Parameters
- url: string
Returns Promise<string>

related

related(id: number, limit: number, offset?: number): Promise<RelatedResponse<TrackInfo>>

- Defined in index.ts:159
Finds related tracks to the given track specified by ID

Parameters
- id: number
  
  The ID of the track
- limit: number
  
  The number of results to return
- offset: number = 0
  
  Used for pagination, set to 0 if you will not use this feature.
Returns Promise<RelatedResponse<TrackInfo>>

search

search(options: SearchOptions): Promise<SearchResponseAll>

- Defined in index.ts:149
Searches for tracks/playlists for the given query

Parameters
- options: SearchOptions
  
  The search option
Returns Promise<SearchResponseAll>

SearchResponse

setAxiosInstance

setAxiosInstance(instance: AxiosInstance): void

- Defined in index.ts:206
Sets the instance of Axios to use to make requests to SoundCloud API

Parameters
- instance: AxiosInstance
  
  An instance of Axios
Returns void

Generated using TypeDoc