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.

Class: LocalFileSourceCopiar enlace

Source para un fichero local. En Bun runtime usa Bun.file() (handle persistente) para evitar abrir/cerrar el FD por llamada. En Node/vitest cae a node:fs/promises.open().

Sin cache propio (el SO page cache basta para F0.A.1). prefetch es no-op (el SO lo hace al leer).

ExampleCopiar enlace

const src = await LocalFileSource.create('/movies/blade.mkv');
const result = await src.readAt({ offset: 0, length: 1024, purpose: 'probe' });

ImplementsCopiar enlace

• ISeekableMediaSource

PropertiesCopiar enlace

kindCopiar enlace

readonly kind: "local" = 'local'

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

Implementation ofCopiar enlace

ISeekableMediaSource.kind

sizeBytesCopiar enlace

readonly sizeBytes: number

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

Implementation ofCopiar enlace

ISeekableMediaSource.sizeBytes

uriCopiar enlace

readonly uri: string

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

Implementation ofCopiar enlace

ISeekableMediaSource.uri

MethodsCopiar enlace

availability()Copiar enlace

availability(): SourceAvailability

Consulta la disponibilidad actual del source.

ReturnsCopiar enlace

SourceAvailability

Estado de disponibilidad.

Implementation ofCopiar enlace

ISeekableMediaSource.availability

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>

Implementation ofCopiar enlace

ISeekableMediaSource.cancel

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

ReturnsCopiar enlace

Promise<void>

Implementation ofCopiar enlace

ISeekableMediaSource.cancelOutside

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.

Implementation ofCopiar enlace

ISeekableMediaSource.metrics

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[]

ReturnsCopiar enlace

Promise<void>

Implementation ofCopiar enlace

ISeekableMediaSource.prefetch

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).

Implementation ofCopiar enlace

ISeekableMediaSource.readAt

create()Copiar enlace

static create(path): Promise<Result<LocalFileSource, ResultError<SourceErrorCode>>>

Crea un LocalFileSource validando que el fichero existe y es legible.

ParametersCopiar enlace

pathCopiar enlace

string

Path absoluto del fichero.

ReturnsCopiar enlace

Promise<Result<LocalFileSource, ResultError<SourceErrorCode>>>

Result con el source listo para leer o un error.