PufferPrime API

PufferPrime är den OSC-baserade API:n för att styra globen från externa applikationer – t.ex. egna appar, show-control eller sensorer. Referensdokumentationen är v1.28 (januari 2024); sedan v1.5 stöds även WebSockets-kommunikation utöver OSC.

Grundbegrepp

• Kommandon riktas till lunes (Lune 0, Lune 1 eller Lune 2).
• OSC har ingen bool-typ – booleska värden skickas som strängarna "true" / "false".
• Fönster (windows) måste vara unika inom en lune.

Lager (Layers)

Ett lager är en helsfär-bild eller -video.

CreateLayer

Skapar ett nytt lager i den adresserade lunen.

Parameter	Typ	Område	Kommentar
name	string	–	Unikt namn inom lunen; skapas inte om namnet inte är unikt. Får inte vara numeriskt ("one" går, "1" gör det inte).
X/Y/Z Rotation	float	–	Rotation kring respektive axel. Ignoreras vid rotate=true men måste finnas med.
filename	string	–	Bild, video eller playlist som visas (se Assets i referensen).
depth	float	1–10	Mindre depth = framför större depth.
opacity	float	0–1	0.0 helt transparent till 1.0 helt opaker.
rotate	[bool]	–	true: lagret roterar med sfären; false: det står stilla.
fadeIn	float	–	Sekunder för in-fade; 0 = direkt.

DeleteLayer

Tar bort angivet lager i den adresserade lunen, eller alla lager (och alla barnfönster).

• Delete All tar inte bort lager som skapats via XML-element i configuration.xml.
• Vid Delete All tas barnfönster bort direkt och ignorerar stängövergångar; annars övergår fönstren enligt sina inställningar.

Parameter	Typ	Område	Kommentar
name	string	–	Namnet vid skapandet. Ignoreras om Delete All är true.
fadeOut	float	–	Sekunder för ut-fade; 0 = direkt.
Delete All	[bool]	–	true: ta bort alla skapade lager; false: bara angivet.

Sfärfysik (SetSpherePhysics)

Egenskaper som kan uppdateras live:

Egenskap	Betydelse
maxOffAngleAxis	Hur långt från lodlinjen globen får vridas – annars blir platser svåra att känna igen. Standard 35.0.
maxOffVerticalAngle	Hur långt globen får vridas horisontellt; används i multi-lune-situationer för att begränsa vänster/höger-rotation. Standard 180 (ingen gräns).
rightingRate	Hur starkt globen rätar upp sig själv. Standard 0.02.
appAudioVolume	Hela appens ljudnivå, kan ändras live. 0.0 (löst) till 1.0 (max, standard).
longTapTime	Tid i sekunder för att ett tryck på fönster ska räknas som long tap (då används ActionsAndMessagesOnLongTap). 0.0–10.0, standard 1.0.

Kommandot Still stoppar vinkelmomentet i den adresserade lunen – rotation orsakad av tröghet från manuell touch stannar omedelbart.

Övriga kommandogrupper

Referensen (v1.28) dokumenterar även:

• Rotation – RotateAbsolute, RotateRelative, ShowSection m.fl.
• Windows – CreateWindow, UpdateWindow* (bredd, typ, anchor, keep upright, timer, close button), video-kontroller (PauseVideo, StopVideo, chapters).
• Lines – DrawLinePointToPoint (med valfritt namn) och DeleteLine.
• Idle – SetIdleTimeout, start/end-idle actioner och meddelanden per lune.
• Assets & cache – SetImageCacheSize, SetVideoCacheSize.

Referens

Denna sida är en sammanfattning av PufferPrime API Reference v1.28 (4 000+ rader) – se originaldokumentet för fullständiga parametrar och exempel på varje kommando.