Skip to main content

Type Alias: EndFileOutcome

type EndFileOutcome = 
  | {
  type: "ended";
}
  | {
  quit: boolean;
  type: "stopped";
}
  | {
  type: "redirect";
}
  | {
  error: PlayerError;
  type: "failed";
};

Defined in: packages/player/src/errors.ts:511

How a playlist entry stopped, as classified from mpv's end-file event.

ended and failed are deliberately distinct: a natural end of stream is a trackEnded event, a premature/failed one is an error event.

Union Members​

Type Literal​

{
  type: "ended";
}

type​

readonly type: "ended";

The entry played to its natural end (MPV_END_FILE_REASON_EOF).

Type Literal​

{
  quit: boolean;
  type: "stopped";
}

quit​

readonly quit: boolean;

true when the whole core is going away (quit).

type​

readonly type: "stopped";

Playback was stopped by us or by the user (stop, quit).

Type Literal​

{
  type: "redirect";
}

type​

readonly type: "redirect";

The entry was a playlist and was expanded in place (redirect).

Type Literal​

{
  error: PlayerError;
  type: "failed";
}

error​

readonly error: PlayerError;

The typed error.

type​

readonly type: "failed";

Playback aborted with an error.