Load and play a sound file
curl --request POST \
--url http://localhost:3917/audio/play \
--header 'Content-Type: application/json' \
--data '
{
"loop": false,
"max_distance": 50,
"path": "assets/audio/explosion.wav",
"position": [
3,
0,
1
],
"volume": 0.8
}
'import requests
url = "http://localhost:3917/audio/play"
payload = {
"loop": False,
"max_distance": 50,
"path": "assets/audio/explosion.wav",
"position": [3, 0, 1],
"volume": 0.8
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
loop: false,
max_distance: 50,
path: 'assets/audio/explosion.wav',
position: [3, 0, 1],
volume: 0.8
})
};
fetch('http://localhost:3917/audio/play', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3917",
CURLOPT_URL => "http://localhost:3917/audio/play",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'loop' => false,
'max_distance' => 50,
'path' => 'assets/audio/explosion.wav',
'position' => [
3,
0,
1
],
'volume' => 0.8
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3917/audio/play"
payload := strings.NewReader("{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3917/audio/play")
.header("Content-Type", "application/json")
.body("{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3917/audio/play")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}"
response = http.request(request)
puts response.read_body{
"clip": 0,
"entity_id": 7,
"ok": true,
"spatial": true
}Audio
Load and play a sound file
POST
/
audio
/
play
Load and play a sound file
curl --request POST \
--url http://localhost:3917/audio/play \
--header 'Content-Type: application/json' \
--data '
{
"loop": false,
"max_distance": 50,
"path": "assets/audio/explosion.wav",
"position": [
3,
0,
1
],
"volume": 0.8
}
'import requests
url = "http://localhost:3917/audio/play"
payload = {
"loop": False,
"max_distance": 50,
"path": "assets/audio/explosion.wav",
"position": [3, 0, 1],
"volume": 0.8
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
loop: false,
max_distance: 50,
path: 'assets/audio/explosion.wav',
position: [3, 0, 1],
volume: 0.8
})
};
fetch('http://localhost:3917/audio/play', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3917",
CURLOPT_URL => "http://localhost:3917/audio/play",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'loop' => false,
'max_distance' => 50,
'path' => 'assets/audio/explosion.wav',
'position' => [
3,
0,
1
],
'volume' => 0.8
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3917/audio/play"
payload := strings.NewReader("{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3917/audio/play")
.header("Content-Type", "application/json")
.body("{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3917/audio/play")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"loop\": false,\n \"max_distance\": 50,\n \"path\": \"assets/audio/explosion.wav\",\n \"position\": [\n 3,\n 0,\n 1\n ],\n \"volume\": 0.8\n}"
response = http.request(request)
puts response.read_body{
"clip": 0,
"entity_id": 7,
"ok": true,
"spatial": true
}Body
application/json
Load and play a clip: path to the audio file, volume (default 1.0), loop (default false), optional position [x,y,z] (makes it spatial), and max_distance (default 50.0).
The body is of type any.
Response
200 - application/json
Spawned audio-source entity id, the clip handle, and whether it is spatial; returns an error field on a missing path or load failure.
⌘I