DOCUMENTATION
  • 🌐INTRODUCTION
  • â„šī¸INFORMATION
  • 💲PAID SCRIPTS
    • 🎧Surround (Spatial Audio)
      • Introduction
      • Installation
      • API
        • Client
          • Set
          • Get
          • Handlers
        • Server
          • Set
          • Get
        • Shared
      • Examples
    • 🏨Motels
      • Introduction
        • Motel Manager
        • Customer
        • Rent Cycle
        • Share Key
        • Auto System
        • Admin
        • Logs
        • Configurable Codes
        • Optimization
      • Installation
  • 🆓FREE SCRIPTS
    • FiveM Manager Bot
      • INSTALLATION
Powered by GitBook
On this page
  • Create Sound Id
  • Get Info From Url
  • Search Track
  • Search Tracks (Playlist, album)

Was this helpful?

  1. PAID SCRIPTS
  2. Surround (Spatial Audio)
  3. API

Shared

These are shared exports

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

PreviousGetNextExamples

Last updated 2 months ago

Was this helpful?

💲
🎧