@klettelars/soundcloud-downloader/dist/info.d.ts

Download Soundcloud audio with Node.js

import { AxiosInstance } from 'axios';
import STREAMING_PROTOCOLS from './protocols';
import FORMATS from './formats';
/**
 * A Soundcloud user
 */
export interface User {
    kind: string;
    avatar_url: string;
    city: string;
    comments_count: number;
    country_code: string;
    created_at: string;
    description: string;
    followers_count: number;
    followings_count: number;
    first_name: string;
    full_name: string;
    groups_count: number;
    id: number;
    last_name: string;
    permalink_url: string;
    uri: string;
    username: string;
}
/**
 * Details about the track
 */
export interface TrackInfo {
    kind: string;
    monetization_model: string;
    id: number;
    policy: string;
    comment_count?: number;
    full_duration?: number;
    downloadable?: false;
    created_at?: string;
    description?: string;
    media?: {
        transcodings: Transcoding[];
    };
    title?: string;
    publisher_metadata?: any;
    duration?: number;
    has_downloads_left?: boolean;
    artwork_url?: string;
    public?: boolean;
    streamable?: true;
    tag_list?: string;
    genre?: string;
    reposts_count?: number;
    label_name?: string;
    state?: string;
    last_modified?: string;
    commentable?: boolean;
    uri?: string;
    download_count?: number;
    likes_count?: number;
    display_date?: string;
    user_id?: number;
    waveform_url?: string;
    permalink?: string;
    permalink_url?: string;
    user?: User;
    playback_count?: number;
}
/**
 * Details about a Set
 */
export interface SetInfo {
    duration: number;
    permalink_url: string;
    reposts_count: number;
    genre: string;
    permalink: string;
    purchase_url?: string;
    description?: string;
    uri: string;
    label_name?: string;
    tag_list: string;
    set_type: string;
    public: boolean;
    track_count: number;
    user_id: number;
    last_modified: string;
    license: string;
    tracks: TrackInfo[];
    id: number;
    release_date?: string;
    display_date: string;
    sharing: string;
    secret_token?: string;
    created_at: string;
    likes_count: number;
    kind: string;
    purchase_title?: string;
    managed_by_feeds: boolean;
    artwork_url?: string;
    is_album: boolean;
    user: User;
    published_at: string;
    embeddable_by: string;
}
/**
 * Represents an audio link to a Soundcloud Track
 */
export interface Transcoding {
    url: string;
    preset: string;
    snipped: boolean;
    format: {
        protocol: STREAMING_PROTOCOLS;
        mime_type: FORMATS;
    };
}
/** @internal */
export declare const getInfoBase: <T extends TrackInfo | SetInfo>(url: string, clientID: string, axiosRef: AxiosInstance) => Promise<T>;
/** @internal */
declare const getInfo: (url: string, clientID: string, axiosInstance: AxiosInstance) => Promise<TrackInfo>;
/** @internal */
export declare const getSetInfo: (url: string, clientID: string, axiosInstance: AxiosInstance) => Promise<SetInfo>;
/** @intenral */
export declare const getTrackInfoByID: (clientID: string, axiosInstance: AxiosInstance, ids: number[], playlistID?: number, playlistSecretToken?: string) => Promise<TrackInfo[]>;
export default getInfo;