Referencia de @styx/api-contracts generada de su TSDoc.
packages/api-contracts/package.jsonPágina generada desde
el TSDoc de @styx/api-contracts. No se edita a mano:bun run docs:genla regenera ybun run docs:checkfalla si difiere.
Información de entrega de la sesión (cómo el cliente llega a los bytes).
readonlyoptionalcertHash?:string
Hash del certificado del daemon Zig (para WebTransport/HTTP3 con cert self-signed, verificado por el cliente en lugar de CA). Opcional: solo aplica a transports que lo requieran. Cableado en convergencia sesión 2.
readonlyendpoint:string
URL/endpoint de delivery.
STUB en F0.A.2a (r24 §5.3): placeholder string. Aún no hay daemon Zig
en esta rama. En la convergencia sesión 2, playback-svc emite IPC
CreateSession {assetPath} al daemon Zig y usa el endpoint del evento
TransportEndpoint para rellenar este campo con la URL/WebTransport
real (bytes nunca cruzan JavaScript). Hasta entonces, el valor es
informativo/no utilizable por el cliente.
readonlyoptionalpackaging?:object
Sesión de empaquetado del daemon (transport hls): el daemon transmuxa el
asset a HLS/CMAF (dec-0110 §3) y endpoint es su master playlist. Ausente
en los demás transportes.
readonlycapability:string
SCT de lectura (base64url) firmado para este pkg_* (dec-0117 §4.1): el
reproductor lo manda como Authorization: Bearer en cada petición de
playlist, init y segmento; sin él el daemon responde 403. Vida en
tokenTtlMs.
readonlycodecs:string
Atributo CODECS del master playlist (RFC 6381), p.ej. vp09.00.30.08,opus.
readonlyengine:MediaEngineKind
Motor que empaqueta — el daemon lo valida contra sus capabilities.
readonlypackagingId:string
Handle pkg_* del daemon (lo que cierra ClosePackaging).
readonlysegments:number
Número de segmentos CMAF del plan (corte en keyframes).
readonlytargetDurationS:number
EXT-X-TARGETDURATION del media playlist, en segundos.
readonlyoptionaltcpEndpoint?:string
El mismo recurso por el origen TCP del daemon (dec-0134): HTTPS HTTP/1.1 sobre TLS 1.3 con
Alt-Svc hacia h3, para un navegador normal, que sólo prueba HTTP/3 con un origen que ya
conoce por TCP. Es la URL que el reproductor pide con un certificado de confianza (no hace
falta certHash); suele coincidir con endpoint (mismo host y puerto, TCP además de UDP).
Ausente si el daemon no tiene origen TCP.
readonlyoptionaltokenTtlMs?:number
TTL del token firmado de la sesión en ms. Opcional: 0 o ausente = sin token (auth diferida). En F0.A.2a no hay auth real (guardrail r24 §3).
readonlytransport:string
Protocolo de transporte de la entrega (hls, http-range, moqt,
webtransport). En F0.A.2a el Planner fija el valor planificado (típicamente
http-range como vara de medir); el daemon real se asigna en convergencia.