Server

AttachSongToEntity#

Allows you to attach songs to entities.

exports["wais-speaker"]:AttachSongToEntity(netId, url, volume, loop, rate, maxDistance)

• netId: number
  • The NetworkId belonging to the entity to which the song will be attached.
• url: string
  • This is the URL of the song to be used from YouTube. The song must be longer than 05:00 minutes. Example: _{https://www.youtube.com/watch?v=nmnjL26OBcY}
• volume?: float
  • The volume level of the song.
  • Min: 0.0
  • Max: 1.0
  • Default: 0.50
• loop?: boolean
  • Should the song be played again and again?
  • Default: false
• rate?: float
  • The playback speed of the song.
  • Default: 1.0
• maxDistance?: float
  • The distance value at which users will interact to hear the song.
  • Default: Config.InteractionDistances.speakers (10.0)

Return:

• success: boolean
• message: string
• data: table
  • videoId: string
  • title: string
  • author: string
  • duration: number (max duration of video)
  • thumbnail: url

DestroySpeaker#

It allows you to completely delete the song

exports["wais-speaker"]:DestroySpeaker(netId)

• netId: number
  • NetworkId belonging to the entity to which the song will be deleted

Return:

• success: boolean
• message: string

GetSpeaker#

It allows you to access the speaker and its methods.

local speaker = exports["wais-speaker"]:GetSpeaker(netId)

• netId: number
  • The NetworkId of the speaker you want to access.

Return:

• destroy()
  • Deletes the song completely.
• pause()
  • It stops the song.
• resume()
  • Continues the song.
• setVolume(volume)
  • Adjusts the volume of the song.
  • volume: number
• setDistance(distance)
  • It changes the distance the song can be heard.
  • distance: float
• seek(duration)
  • You can skip to any second in the song.
  • duration: float

InstallCarplay#

If the option to use CarPlay by installing it is active, it will allow you to install CarPlay in your vehicle.

exports["wais-speaker"]:InstallCarplay(plate, netId)

• plate: string
  • The license plate of the vehicle where CarPlay will be installed.
• netId: number
  • The NetworkId of the vehicle where Carplay will be installed.

Return:

• success: boolean
• message: string
  • invalid_arguments, carplay_installed

RemoveCarplay#

If the option to use CarPlay as an item is enabled, it will remove CarPlay from the vehicle.

exports["wais-speaker"]:RemoveCarplay(plate, netId)

• plate: string
  • The license plate of the vehicle where CarPlay will be removed.
• netId: number
  • The NetworkId of the vehicle where Carplay will be removed.

Return:

• success: boolean
• message: string
  • invalid_arguments, failed_to_remove_carplay, carplay_removed