Type Alias JSONAPIXtreamEpisode

JSONAPIXtreamEpisode: {
    type: "episode";
    id: string;
    attributes: {
        number: number;
        title: string;
        plot: string | null;
        releaseDate: Date | null;
        duration: number;
        durationFormatted: string;
        poster: string;
        cover: string;
        tmdbId: string;
        createdAt: Date;
        voteAverage: number;
        url?: string;
        video?: Partial<CamelCaseKeys<XtreamVideoInfo, true>>;
        audio?: Partial<CamelCaseKeys<XtreamAudioInfo, true>>;
        bitrate?: number;
        subtitles: string[];
    };
    relationships: {
        season?: { data: { type: "season"; id: string } };
        show: { data: { type: "show"; id: string } };
    };
}

JSON:API Xtream episode information

This type represents an episode in a show in the Xtream system in JSON:API format

Type declaration

  • type: "episode"

    The resource type (episode)

  • id: string

    The unique identifier for the episode

  • attributes: {
        number: number;
        title: string;
        plot: string | null;
        releaseDate: Date | null;
        duration: number;
        durationFormatted: string;
        poster: string;
        cover: string;
        tmdbId: string;
        createdAt: Date;
        voteAverage: number;
        url?: string;
        video?: Partial<CamelCaseKeys<XtreamVideoInfo, true>>;
        audio?: Partial<CamelCaseKeys<XtreamAudioInfo, true>>;
        bitrate?: number;
        subtitles: string[];
    }

    The episode attributes

    • number: number

      The episode number within the season

    • title: string

      The title of the episode

    • plot: string | null

      The synopsis/description of the episode

    • releaseDate: Date | null

      The release date of the episode

    • duration: number

      The duration of the episode in seconds

    • durationFormatted: string

      The formatted duration of the episode

    • poster: string

      The URL for the episode's poster image

    • cover: string

      The URL for the episode's cover image

    • tmdbId: string

      The id of the episode in The Movie Database

    • createdAt: Date

      The date when the episode was added to the system

    • voteAverage: number

      The vote average of ratings

    • Optionalurl?: string

      URL to access the stream

    • Optionalvideo?: Partial<CamelCaseKeys<XtreamVideoInfo, true>>

      Video stream information

    • Optionalaudio?: Partial<CamelCaseKeys<XtreamAudioInfo, true>>

      Audio stream information

    • Optionalbitrate?: number

      Bitrate of the stream

    • subtitles: string[]

      Array of available subtitles

  • relationships: {
        season?: { data: { type: "season"; id: string } };
        show: { data: { type: "show"; id: string } };
    }

    The episode relationships

    • Optionalseason?: { data: { type: "season"; id: string } }

      The season relationship

      • data: { type: "season"; id: string }
        • type: "season"

          The season type

        • id: string

          The season ID

    • show: { data: { type: "show"; id: string } }

      The show relationship

      • data: { type: "show"; id: string }
        • type: "show"

          The show type

        • id: string

          The show ID

Settings

Member Visibility