Class Util

Hierarchy

Base
- Util

Index

Constructors

Properties

Accessors

Methods

downloadLikes downloadPlaylist downloadSearch downloadSongCover downloadTrack downloadTracks streamLink streamTrack

Constructors

constructor

new Util(sc): Util
Parameters
- sc: Soundcloud
Returns Util
Inherited from Base.constructor
- Defined in entities/Base.ts:4

Properties

`Readonly` sc

Accessors

api

get api(): API
Returns API
Inherited from Base.api
- Defined in entities/Base.ts:5

Methods

downloadLikes

downloadLikes(userResolvable, dest?, limit?): Promise<string[]>
Download all liked tracks by a user.
Parameters
- userResolvable: string | number
- Optional dest: string
- Optional limit: number
Returns Promise<string[]>
- Defined in entities/Util.ts:275

downloadPlaylist

downloadPlaylist(playlistResolvable, dest?, limit?): Promise<string[]>
Downloads all the tracks in a playlist.
Parameters
- playlistResolvable: string
- Optional dest: string
- Optional limit: number
Returns Promise<string[]>
- Defined in entities/Util.ts:283

downloadSearch

downloadSearch(query, dest?, limit?): Promise<string[]>
Downloads all the tracks from the search query.
Parameters
- query: string
- Optional dest: string
- Optional limit: number
Returns Promise<string[]>
- Defined in entities/Util.ts:267

downloadSongCover

downloadSongCover(trackResolvable, dest?, noDL?): Promise<string>
Downloads a track's song cover.
Parameters
- trackResolvable: string | SoundcloudTrackV2
- Optional dest: string
- Optional noDL: boolean
Returns Promise<string>
- Defined in entities/Util.ts:301

downloadTrack

downloadTrack(trackResolvable, dest?): Promise<string>
Downloads a track on Soundcloud.
Parameters
- trackResolvable: string | SoundcloudTrackV2
- Optional dest: string
Returns Promise<string>
- Defined in entities/Util.ts:240

downloadTracks

downloadTracks(tracks, dest?, limit?): Promise<string[]>
Downloads an array of tracks.
Parameters
- tracks: string[] | SoundcloudTrackV2[]
- Optional dest: string
- Optional limit: number
Returns Promise<string[]>
- Defined in entities/Util.ts:250

streamLink

streamLink(trackResolvable, protocol?): Promise<string>
Gets the direct streaming link of a track.
Parameters
- trackResolvable: string | SoundcloudTrackV2
- Optional protocol: "progressive" | "hls"
Returns Promise<string>
- Defined in entities/Util.ts:66

streamTrack

streamTrack(trackResolvable): Promise<ReadableStream>
Returns a readable stream to the track.
Parameters
- trackResolvable: string | SoundcloudTrackV2
Returns Promise<ReadableStream>
- Defined in entities/Util.ts:291