Get a project's active settings
curl --request GET \
--url https://api.youka.io/api/v1/projects/{projectId}/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.youka.io/api/v1/projects/{projectId}/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.youka.io/api/v1/projects/{projectId}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youka.io/api/v1/projects/{projectId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.youka.io/api/v1/projects/{projectId}/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.youka.io/api/v1/projects/{projectId}/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youka.io/api/v1/projects/{projectId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"presetId": "<string>",
"preset": {
"aspectRatio": "16:9",
"layout": {
"type": "karaoke",
"autoSplitLongLines": true,
"linesPerScreen": 2,
"alignment": "bottom",
"paddingHorizontal": 0,
"paddingVertical": 5,
"languageSpacing": 5,
"containerHeight": 100,
"scrollingFadeStrength": 0.5,
"lineTransition": "fade",
"anticipationBuffer": 3
},
"background": {
"type": "auto"
},
"singerTextStyles": {},
"overlays": {
"branding": {
"logo": {
"enabled": false,
"position": "bottom-right",
"paddingX": 20,
"paddingY": 20,
"scale": 0.1,
"opacity": 1
},
"intro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
},
"outro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
}
},
"titleCard": {
"enabled": true,
"duration": 5,
"autoHideBeforeLyrics": true,
"titleStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 200,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 30
},
"artistStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 150,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 30
}
},
"leadIn": {
"enabled": true,
"appearance": "classic",
"beats": 4,
"minGap": 3,
"useNextSingerStyle": true,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 3
},
"width": 0.2,
"fadeTailWidth": 0.6,
"height": 1,
"offsetX": -2,
"offsetY": 0
},
"instrumentalBreak": {
"hideLyrics": true,
"minGap": 5,
"displayDuration": 3
},
"breakCountdown": {
"enabled": true,
"maxDuration": 3,
"animation": "fade",
"useNextSingerStyle": false,
"style": {
"color": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 14.5
},
"textSize": 80,
"hideBeforeEnd": 0
},
"breakProgressBar": {
"enabled": true,
"maxDuration": 10,
"useNextSingerStyle": false,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 5,
"backgroundColor": "#FFFFFF",
"fillColor": "#2185D0"
},
"width": 47,
"height": 7.5,
"position": "center",
"cornerRadius": 0,
"hideBeforeEnd": 0
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"languageTextStyles": {},
"chordTextStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 20,
"textEffect": "karaoke",
"activeLineColor": "#fff09a",
"effectColor": "#2185D0",
"backgroundColor": "transparent",
"letterSpacing": 0,
"lineSpacing": 1.2,
"textCase": "none",
"textDirection": "auto",
"shadowColor": "rgba(0,0,0,0.5)",
"shadowBlur": 4,
"shadowOffsetX": 0,
"shadowOffsetY": 0,
"duetPosition": "center",
"shadowOpacity": 123
}
},
"settings": {
"style": {
"aspectRatio": "16:9",
"layout": {
"type": "karaoke",
"autoSplitLongLines": true,
"linesPerScreen": 2,
"alignment": "bottom",
"paddingHorizontal": 0,
"paddingVertical": 5,
"languageSpacing": 5,
"containerHeight": 100,
"scrollingFadeStrength": 0.5,
"lineTransition": "fade",
"anticipationBuffer": 3
},
"background": {
"type": "auto"
},
"singerTextStyles": {},
"overlays": {
"branding": {
"logo": {
"enabled": false,
"position": "bottom-right",
"paddingX": 20,
"paddingY": 20,
"scale": 0.1,
"opacity": 1
},
"intro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
},
"outro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
}
},
"titleCard": {
"enabled": true,
"duration": 5,
"autoHideBeforeLyrics": true,
"titleStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 200,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 30
},
"artistStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 150,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 30
}
},
"leadIn": {
"enabled": true,
"appearance": "classic",
"beats": 4,
"minGap": 3,
"useNextSingerStyle": true,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 3
},
"width": 0.2,
"fadeTailWidth": 0.6,
"height": 1,
"offsetX": -2,
"offsetY": 0
},
"instrumentalBreak": {
"hideLyrics": true,
"minGap": 5,
"displayDuration": 3
},
"breakCountdown": {
"enabled": true,
"maxDuration": 3,
"animation": "fade",
"useNextSingerStyle": false,
"style": {
"color": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 14.5
},
"textSize": 80,
"hideBeforeEnd": 0
},
"breakProgressBar": {
"enabled": true,
"maxDuration": 10,
"useNextSingerStyle": false,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 5,
"backgroundColor": "#FFFFFF",
"fillColor": "#2185D0"
},
"width": 47,
"height": 7.5,
"position": "center",
"cornerRadius": 0,
"hideBeforeEnd": 0
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"languageTextStyles": {},
"chordTextStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 20,
"textEffect": "karaoke",
"activeLineColor": "#fff09a",
"effectColor": "#2185D0",
"backgroundColor": "transparent",
"letterSpacing": 0,
"lineSpacing": 1.2,
"textCase": "none",
"textDirection": "auto",
"shadowColor": "rgba(0,0,0,0.5)",
"shadowBlur": 4,
"shadowOffsetX": 0,
"shadowOffsetY": 0,
"duetPosition": "center",
"shadowOpacity": 123
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"displayLanguages": [
"<string>"
],
"chordSettings": {
"displayMode": "inline",
"notation": "chord_simple_pop",
"transpose": 0,
"capo": 0,
"showLayer": true
},
"duetSingerFilter": {
"enabled": false,
"selectedSingerIds": [],
"includeSharedLines": true
},
"customTimeline": {
"version": 1,
"fps": 60,
"karaokeStartFrame": 0,
"tracks": [
{
"id": "<string>",
"name": "<string>",
"items": [
{
"id": "<string>",
"from": 4503599627370495,
"durationInFrames": 123,
"enterEffect": "none",
"exitEffect": "none",
"type": "text",
"text": "<string>",
"placement": {
"x": 0.5,
"y": 0.5,
"width": 0.5,
"opacity": 1,
"rotation": 0
},
"style": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 8,
"backgroundColor": "transparent"
},
"sourceTemplateId": "<string>"
}
]
}
]
}
}
}Project Settings
Get a project's active settings
GET
/
projects
/
{projectId}
/
settings
Get a project's active settings
curl --request GET \
--url https://api.youka.io/api/v1/projects/{projectId}/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.youka.io/api/v1/projects/{projectId}/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.youka.io/api/v1/projects/{projectId}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youka.io/api/v1/projects/{projectId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.youka.io/api/v1/projects/{projectId}/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.youka.io/api/v1/projects/{projectId}/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youka.io/api/v1/projects/{projectId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"presetId": "<string>",
"preset": {
"aspectRatio": "16:9",
"layout": {
"type": "karaoke",
"autoSplitLongLines": true,
"linesPerScreen": 2,
"alignment": "bottom",
"paddingHorizontal": 0,
"paddingVertical": 5,
"languageSpacing": 5,
"containerHeight": 100,
"scrollingFadeStrength": 0.5,
"lineTransition": "fade",
"anticipationBuffer": 3
},
"background": {
"type": "auto"
},
"singerTextStyles": {},
"overlays": {
"branding": {
"logo": {
"enabled": false,
"position": "bottom-right",
"paddingX": 20,
"paddingY": 20,
"scale": 0.1,
"opacity": 1
},
"intro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
},
"outro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
}
},
"titleCard": {
"enabled": true,
"duration": 5,
"autoHideBeforeLyrics": true,
"titleStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 200,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 30
},
"artistStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 150,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 30
}
},
"leadIn": {
"enabled": true,
"appearance": "classic",
"beats": 4,
"minGap": 3,
"useNextSingerStyle": true,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 3
},
"width": 0.2,
"fadeTailWidth": 0.6,
"height": 1,
"offsetX": -2,
"offsetY": 0
},
"instrumentalBreak": {
"hideLyrics": true,
"minGap": 5,
"displayDuration": 3
},
"breakCountdown": {
"enabled": true,
"maxDuration": 3,
"animation": "fade",
"useNextSingerStyle": false,
"style": {
"color": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 14.5
},
"textSize": 80,
"hideBeforeEnd": 0
},
"breakProgressBar": {
"enabled": true,
"maxDuration": 10,
"useNextSingerStyle": false,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 5,
"backgroundColor": "#FFFFFF",
"fillColor": "#2185D0"
},
"width": 47,
"height": 7.5,
"position": "center",
"cornerRadius": 0,
"hideBeforeEnd": 0
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"languageTextStyles": {},
"chordTextStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 20,
"textEffect": "karaoke",
"activeLineColor": "#fff09a",
"effectColor": "#2185D0",
"backgroundColor": "transparent",
"letterSpacing": 0,
"lineSpacing": 1.2,
"textCase": "none",
"textDirection": "auto",
"shadowColor": "rgba(0,0,0,0.5)",
"shadowBlur": 4,
"shadowOffsetX": 0,
"shadowOffsetY": 0,
"duetPosition": "center",
"shadowOpacity": 123
}
},
"settings": {
"style": {
"aspectRatio": "16:9",
"layout": {
"type": "karaoke",
"autoSplitLongLines": true,
"linesPerScreen": 2,
"alignment": "bottom",
"paddingHorizontal": 0,
"paddingVertical": 5,
"languageSpacing": 5,
"containerHeight": 100,
"scrollingFadeStrength": 0.5,
"lineTransition": "fade",
"anticipationBuffer": 3
},
"background": {
"type": "auto"
},
"singerTextStyles": {},
"overlays": {
"branding": {
"logo": {
"enabled": false,
"position": "bottom-right",
"paddingX": 20,
"paddingY": 20,
"scale": 0.1,
"opacity": 1
},
"intro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
},
"outro": {
"enabled": false,
"durationSeconds": 0,
"effect": "fade",
"effectDuration": 0.5
}
},
"titleCard": {
"enabled": true,
"duration": 5,
"autoHideBeforeLyrics": true,
"titleStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 200,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 30
},
"artistStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 150,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 30
}
},
"leadIn": {
"enabled": true,
"appearance": "classic",
"beats": 4,
"minGap": 3,
"useNextSingerStyle": true,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 3
},
"width": 0.2,
"fadeTailWidth": 0.6,
"height": 1,
"offsetX": -2,
"offsetY": 0
},
"instrumentalBreak": {
"hideLyrics": true,
"minGap": 5,
"displayDuration": 3
},
"breakCountdown": {
"enabled": true,
"maxDuration": 3,
"animation": "fade",
"useNextSingerStyle": false,
"style": {
"color": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 14.5
},
"textSize": 80,
"hideBeforeEnd": 0
},
"breakProgressBar": {
"enabled": true,
"maxDuration": 10,
"useNextSingerStyle": false,
"style": {
"color": "#2185D0",
"outlineColor": "#000000",
"outlineWidth": 5,
"backgroundColor": "#FFFFFF",
"fillColor": "#2185D0"
},
"width": 47,
"height": 7.5,
"position": "center",
"cornerRadius": 0,
"hideBeforeEnd": 0
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"languageTextStyles": {},
"chordTextStyle": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 20,
"textEffect": "karaoke",
"activeLineColor": "#fff09a",
"effectColor": "#2185D0",
"backgroundColor": "transparent",
"letterSpacing": 0,
"lineSpacing": 1.2,
"textCase": "none",
"textDirection": "auto",
"shadowColor": "rgba(0,0,0,0.5)",
"shadowBlur": 4,
"shadowOffsetX": 0,
"shadowOffsetY": 0,
"duetPosition": "center",
"shadowOpacity": 123
}
},
"trim": {
"startSeconds": 0,
"endSeconds": 0
},
"displayLanguages": [
"<string>"
],
"chordSettings": {
"displayMode": "inline",
"notation": "chord_simple_pop",
"transpose": 0,
"capo": 0,
"showLayer": true
},
"duetSingerFilter": {
"enabled": false,
"selectedSingerIds": [],
"includeSharedLines": true
},
"customTimeline": {
"version": 1,
"fps": 60,
"karaokeStartFrame": 0,
"tracks": [
{
"id": "<string>",
"name": "<string>",
"items": [
{
"id": "<string>",
"from": 4503599627370495,
"durationInFrames": 123,
"enterEffect": "none",
"exitEffect": "none",
"type": "text",
"text": "<string>",
"placement": {
"x": 0.5,
"y": 0.5,
"width": 0.5,
"opacity": 1,
"rotation": 0
},
"style": {
"fontFamily": "Arimo",
"fontSource": {
"type": "catalog"
},
"fontSize": 96,
"fontWeight": 700,
"fontStyle": "normal",
"textColor": "#FFFFFF",
"outlineColor": "#000000",
"outlineWidth": 8,
"backgroundColor": "transparent"
},
"sourceTemplateId": "<string>"
}
]
}
]
}
}
}Autorisierungen
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Pfadparameter
War diese Seite hilfreich?
⌘I