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

Interface: ISeekableMediaSourceCopiar enlace

Interfaz central de todo source de media (r04).

Implementaciones: LocalFileSource, HttpRangeSource (este package), S3Source, WebDavSource, TorrentSource, JellyfinSource, XtreamSource, CompositeSource (F3+).

Thread-safety: las implementaciones deben soportar reads concurrentes con distintos requestId. El cancel(requestId) es granular.

PropertiesCopiar enlace

kindCopiar enlace

readonly kind: string

Tipo de source (local, http, s3, webdav, torrent, etc.).

---

sizeBytesCopiar enlace

readonly sizeBytes: number

Tamaño total en bytes (0 si desconocido, ej: streams live).

---

uriCopiar enlace

readonly uri: string

URI canónica del source (file://, https://, s3://, etc.).

MethodsCopiar enlace

availability()Copiar enlace

availability(): SourceAvailability

Consulta la disponibilidad actual del source.

ReturnsCopiar enlace

SourceAvailability

Estado de disponibilidad.

---

cancel()Copiar enlace

cancel(requestId): Promise<void>

Cancela una read individual por su requestId (r20 §3.6). No afecta a otros requests en curso.

ParametersCopiar enlace

requestIdCopiar enlace

string

ID del request a cancelar.

ReturnsCopiar enlace

Promise<void>

---

cancelOutside()Copiar enlace

cancelOutside(window): Promise<void>

Cancela todos los requests fuera de la ventana dada (r20 §3.6). Útil tras un seek: cancela reads del offset antiguo. Impl real deferida a F3; este SDK declara la firma.

ParametersCopiar enlace

windowCopiar enlace

IReadWindow

Ventana de offsets a preservar.

ReturnsCopiar enlace

Promise<void>

---

metrics()Copiar enlace

metrics(): ISourceMetrics | null

Métricas observadas del source (para SourceMetrics aggregate). NO scoring — eso va en playback-policy o source-selection-policy.

ReturnsCopiar enlace

ISourceMetrics | null

Métricas actuales o null si no hay datos todavía.

---

prefetch()Copiar enlace

prefetch(ranges): Promise<void>

Hint de prefetch: el source debería precargar estos rangos en cache. No bloquea; el source puede ignorar si su cache está lleno.

ParametersCopiar enlace

rangesCopiar enlace

readonly IPrefetchRange[]

Rangos a prefetchar.

ReturnsCopiar enlace

Promise<void>

---

readAt()Copiar enlace

readAt(request): Promise<Result<IReadResult, ResultError<SourceErrorCode>>>

Lee length bytes desde offset.

ParametersCopiar enlace

requestCopiar enlace

IReadRequest

Request de lectura con purpose + deadline + requestId.

ReturnsCopiar enlace

Promise<Result<IReadResult, ResultError<SourceErrorCode>>>

Result con el resultado (puede ser parcial) o ResultError<SourceErrorCode>. El código viaja dentro de ResultError (ver error-handling.md).