SDK y paquetes@styx/api-contractsindexinterfaces

Interface: ISessionDelivery

Referencia de @styx/api-contracts generada de su TSDoc.

ImplementadoSin versión del tren todavía· generada desde packages/api-contracts/package.json

Página generada desde el TSDoc de @styx/api-contracts. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Interface: ISessionDelivery

Información de entrega de la sesión (cómo el cliente llega a los bytes).

Properties

certHash?

readonly optional certHash?: 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.


endpoint

readonly endpoint: 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.


packaging?

readonly optional packaging?: 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.

capability

readonly capability: 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.

codecs

readonly codecs: string

Atributo CODECS del master playlist (RFC 6381), p.ej. vp09.00.30.08,opus.

engine

readonly engine: MediaEngineKind

Motor que empaqueta — el daemon lo valida contra sus capabilities.

packagingId

readonly packagingId: string

Handle pkg_* del daemon (lo que cierra ClosePackaging).

segments

readonly segments: number

Número de segmentos CMAF del plan (corte en keyframes).

targetDurationS

readonly targetDurationS: number

EXT-X-TARGETDURATION del media playlist, en segundos.


tcpEndpoint?

readonly optional tcpEndpoint?: 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.


tokenTtlMs?

readonly optional tokenTtlMs?: 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).


transport

readonly transport: 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.