VoiceEnable

From GT-MP
Jump to: navigation, search
VoiceEnable
Client-Side Function
System-users.png Client-Side Javascript.png JavaScript

Enables the built-in voice support.

Dialog-warning.png Note: This feature is currently not in the API, or is currently not accurate on the wiki due to upcoming API changes. New API functions and changes will be released with the next update.

Syntax

In Javascript
Client-Side Function

API.voiceEnable(string serverIP, int serverPort, string serverSecret, string clientGUID, string requiredClientVersion = "0.0.0.0", int clientPort = 4239);

Required Arguments

  • serverIP parameter input should be in string type.
    • IP of the voice server.
  • serverPort parameter input should be in int type.
    • Port of the voice server.
  • serverSecret parameter input should be in string type.
    • Server secret.
  • clientGUID parameter input should be in string type.
    • GUID to identify this client. Must be known by the GT-MP server.

Optional Arguments

  • requiredClientVersion parameter input should be in string type.
    • The minimum voice client version required.
  • clientPort parameter input should be in int type.
    • Port the voice client on 127.0.0.1 will listen on for connection information.


NOTE: This function returns data in bool type.

Usage example

In Javascript
Client-Side Function

API.voiceEnable(string serverIP, int serverPort, string serverSecret, string clientGUID, string requiredClientVersion = "0.0.0.0", int clientPort = 4239);

References