@soundhub/soundhub_vk v1.0.0

SoundHub AudioAPI

An unofficial Audio API for VK.COM. This npm module using as part in SoundHub project.

Installation

Install VK-IO via npm or yarn

yarn add vk-io
// or
npm install vk-io

Install SoundHub VK Audio API package

yarn add soundhub_vk
// or
npm install soundhub_vk

Getting Started

Do auth with VK-IO

const { VK } = require("vk-io");
const VKClient = new VK({ token: "xxxxxxxxxxx" });

Create an API

const credits = {
    username: "xxxxxxxxxxx",
    password: "xxxxxxxxxxx",
    user:     "xxxxxxxxxxx" // Your user_id
};

const AudioAPI = require("soundhub_vk");
const API = await new AudioHTTP(VKClient).login(credits);

You awesome!!

Full example

const credits = {
    username: "xxxxxxxxxxx",
    password: "xxxxxxxxxxx",
    token:    "xxxxxxxxxxx",
    user:     "xxxxxxxxxxx" // Your user_id
};

const { VK } = require("vk-io");
const AudioAPI = require("soundhub_vk");

const run = async () => {
    const VKClient = new VK({ token: credits.token });
    const API = await new AudioAPI(VKClient).login(credits);

    const { audios: my_audios, count } = await API.audio.getAll();
    console.log(my_audios);
    console.log(`Wow, I have ${count} audio!`);
};

run();

Usage

The API splitted into 5 parts: audio, playlists, search, artists, recommendations. To use each of this you must to specify part which you would to use. Example:

const { audios } = await API.audio.get();
const { playlists } = await API.playlists.get();
const search = await API.search.query("Queen");
const artsits = await API.artists.get("Queen");
const recommendations = await API.recoms.loadRecoms();
const explore = await API.recoms.loadExplore();

Recommendation for optimizing the requests

Each URL storing separately from audio object and needs to single request (10 audios per request). This is increased time of request and flooding to vk servers. To avoid this, read below.

I highly recomends you to set in parameters of each function fetching raw audio object. This returns audio full audio objects with "raw" array, but without URL's. Then you can use audio.fetch(raw) in any time. This method allows you to reduce the request time (1300ms -> 300ms average, you can check tests manually) and avoid flooding to vk servers. Here is another example:

const { audios } = await API.audio.get({ raw: true });
const [full] = await API.audio.parse([audio[0].raw]);

/*
    A certain scientific PlayMusicLogic(full)
*/

Play .m3u8 files with hls.js

VK uses .m3u8 file formats for music. So you can use hls.js package to play it.

Example:

const Hls = require("hls.js");

const sound = new Audio();
const hls = new Hls();

const { audios } = await API.audio.get({ raw: true });
const parsed = await API.audio.parse([audio[0].raw]);

hls.attachMedia(sound);
hls.on(hlsjs.Events.MEDIA_ATTACHED, hls.loadSource(parsed[0].url));

sound.addEventListener("canplaythrough", () => sound.play());

Downloading audio (Breaking Change from 1.2.0)

Also you can fetch .m3u8 links manually using ffmpeg. See example:

import AudioAPIHLS from "soundhub_vk/lib/hls";

const { audios } = await API.audio.get();

const instance = new AudioAPIHLS(params?);

// Events
instance.once("processing", () => console.log("Start processing..."));
instance.on("progress", progress => console.log(progress));

const output = await instance.download(audios[0].url, ffmpegPath, outputPath);

Params object:

params = {
    name: string, // name of output file (default: name of first chunk's file)
    chunksFolder: string, // folder to store downloaded chunks. Chunks deletes automatically after processing (default: "hls")
    delete: boolean, // resolve buffer and delete output file (default: false)
    concurrency: Number // number of parallel downloadings (default: 5)
};

Now let's see each part.

Audio

Playlists

Search

Pay your attention to more object!

more object is a object that contain information for continuing searching. You can't load more results without this object.

Artists

You can see how to get full list of audio or playlists of artist in jest testing file.

Recommendations

The explore and recoms sections caching and updating every hour itself for make loading faster.

Contribution

You can feel free to open issues tickets or PR to help me with this API.

Conclusion

You can check jest tests to check more functional or see examples.