Shared

These are shared exports

Prepare

local response = exports['mx-surround']:Prepare(url)

For Youtube, Spotify and Soundcloud this must be used once. If not, the song will not play.

It only needs to be called 1 time, which makes the link ready. Calling it more than once will result in an error

It's not necessary to prepare for custom audio links or local sounds

Parameters

• url: string

Returns

Success

• success: true

Error

• error: string;
  errorCode: number;

---

Create Sound Id

local soundId = exports['mx-surround']:createUniqueId()

Returns

• string

Get Info From Url

You can get information such as thumbnail, avatar and song url with this export.

local info = exports['mx-surround']:getInfoFromUrl(url)

Parameters

• url: string

Returns

Success

• title: string; 
  artist: string; 
  thumbnail: string

Error

• false

---

Search Track

With this export you can search for tracks by song name. This will also return information as with getInfoFromUrl

local response = exports['mx-surround']:searchTrack(query)

Parameters

• query: string

Returns

Success

• artists: { artistId: string, name: string }[];
  artist?: { artistId: string, name: string };
  videoId?: string;
  name: string;
  album?: { albumId: string, name: string }[];
  thumbnails: { url: string, width: number, height: number }[];

Error

• error: string;
  code: number;

---

Search Tracks (Playlist, album)

With this export you can get album and playlist information. It returns exactly the same information as searchTrack. However it's an array. Its not supports the soundcloud

local response = exports['mx-surround']:searchTracks(query)

Parameters

• query: string

Returns

• Same as searchTrack