@iptv/xtream-api

/** * CamelCase serializers for the Xtream API * * These serializers transform the API response into a camelCase format only, * no other transformations are applied */ export declare const camelCaseSerializer: { type: string; serializers: { profile: (input: XtreamUserProfile) => { username: string; password: string; message: string; auth: number; status: string; expDate: string; isTrial: string; activeCons: number; createdAt: string; maxConnections: string; allowedOutputFormats: string[]; }; serverInfo: (input: XtreamServerInfo) => { xui: boolean; version: string; revision: string | null; url: string; port: string; httpsPort: string; serverProtocol: string; rtmpPort: string; timezone: string; timestampNow: number; timeNow: string; }; channelCategories: (input: XtreamCategory[]) => { categoryId: string; categoryName: string; parentId: number; }[]; movieCategories: (input: XtreamCategory[]) => { categoryId: string; categoryName: string; parentId: number; }[]; showCategories: (input: XtreamCategory[]) => { categoryId: string; categoryName: string; parentId: number; }[]; channels: (input: XtreamChannel[]) => { num: number; name: string; streamType: string; streamId: number; streamIcon: string; thumbnail: string; epgChannelId: string; added: string; categoryId: string; categoryIds: number[]; customSid: string; tvArchive: number; directSource: string; tvArchiveDuration: number; url?: string | undefined; }[]; movies: (input: XtreamMoviesListing[]) => { num: number; name: string; year: string | null; title: string; streamType: string; streamId: number; streamIcon: string; rating: number; rating5Based: number; genre: string | null; added: string; episodeRunTime: number | null; categoryId: string; categoryIds: number[]; containerExtension: string; customSid: any; directSource: string; releaseDate: string | null; cast: string | null; director: string | null; plot: string | null; youtubeTrailer: string | null; url?: string | undefined; }[]; movie: (input: XtreamMovie) => { info: { kinopoiskUrl: string; tmdbId: number; name: string; oName: string; coverBig: string; movieImage: string; releaseDate: string | null; episodeRunTime: number | null; youtubeTrailer: string | null; director: string | null; actors: string | null; cast: string | null; description: string | null; plot: string | null; age: string; mpaaRating: string; ratingCountKinopoisk: number; country: string; genre: string | null; backdropPath: string[]; durationSecs: number; duration: string; bitrate: number; releasedate: string | null; subtitles: string[]; rating: number; }; movieData: { streamId: number; name: string; title: string; year: string | null; added: string; categoryId: string; categoryIds: number[]; containerExtension: string; customSid: string; directSource: string; }; url?: string | undefined; }; shows: (input: XtreamShowListing[]) => { num: number; name: string; title: string; year: string | null; seriesId: number; streamType: string; cover: string; plot: string | null; cast: string | null; director: string | null; genre: string | null; releaseDate: string | null; lastModified: string; rating: string; rating5Based: number; backdropPath: string[]; youtubeTrailer: string | null; episodeRunTime: string | null; categoryId: string; categoryIds: number[]; }[]; show: (input: XtreamShow) => { seasons: { id: number; name: string; episodeCount: number; overview: string; airDate: string | null; cover: string; seasonNumber: number; coverBig: string; voteAverage: number; }[]; info: { name: string; title: string; year: string | null; seriesId?: number | undefined; cover: string; plot: string | null; cast: string | null; director: string | null; genre: string | null; releaseDate: string | null; lastModified: string; rating: string; rating5Based: number; backdropPath: string[]; youtubeTrailer: string | null; episodeRunTime: string | null; categoryId: string; categoryIds: number[]; }; episodes: { [x: string]: { id: string; episodeNum: string; title: string; containerExtension: string; info: { airDate?: string | undefined; releaseDate: string | null; plot: string | null; rating: number; movieImage: string; coverBig: string; durationSecs: number; duration: string; tmdbId: number; video?: { index: number; codecName: string; codecLongName: string; profile: string; codecType: string; codecTagString: string; codecTag: string; width: number; height: number; codedWidth: number; codedHeight: number; closedCaptions: number; filmGrain: number; hasBFrames: number; sampleAspectRatio: string; displayAspectRatio: string; pixFmt: string; level: number; colorRange: string; colorSpace: string; colorTransfer: string; colorPrimaries: string; chromaLocation: string; fieldOrder: string; refs: number; isAvc: string; nalLengthSize: string; rFrameRate: string; avgFrameRate: string; timeBase: string; startPts: number; startTime: string; bitsPerRawSample: string; extradataSize: number; disposition: { default: number; dub: number; original: number; comment: number; lyrics: number; karaoke: number; forced: number; hearingImpaired: number; visualImpaired: number; cleanEffects: number; attachedPic: number; timedThumbnails: number; captions: number; descriptions: number; metadata: number; dependent: number; stillImage: number; }; tags: { [x: string]: string; }; } | undefined; audio?: { index: number; codecName: string; codecLongName: string; codecType: string; codecTagString: string; codecTag: string; sampleFmt: string; sampleRate: string; channels: number; channelLayout: string; bitsPerSample: number; rFrameRate: string; avgFrameRate: string; timeBase: string; startPts: number; startTime: string; bitRate: string; disposition: { default: number; dub: number; original: number; comment: number; lyrics: number; karaoke: number; forced: number; hearingImpaired: number; visualImpaired: number; cleanEffects: number; attachedPic: number; timedThumbnails: number; captions: number; descriptions: number; metadata: number; dependent: number; stillImage: number; }; tags: { [x: string]: string; }; } | undefined; bitrate: number; season: number; }; customSid: string; added: string; season: number; directSource: string; subtitles: string[]; url?: string | undefined; }[]; }; }; shortEPG: (input: XtreamShortEPG) => { epgListings: { id: string; epgId: string; title: string; lang: string; start: string; end: string; description: string; channelId: string; startTimestamp: string; stopTimestamp: string; stop: string; }[]; }; fullEPG: (input: XtreamFullEPG) => { epgListings: { id: string; epgId: string; title: string; lang: string; start: string; end: string; description: string; channelId: string; startTimestamp: string; stopTimestamp: string; nowPlaying: number; hasArchive: number; }[]; }; }; }; declare type Prettify<T> = { [K in keyof T]: T[K]; } & {}; /** * Xtream audio information * * This type represents the technical details of an audio stream */ declare type XtreamAudioInfo = { /** The stream index in the container */ index: number; /** The short name of the codec */ codec_name: string; /** The full name of the codec */ codec_long_name: string; /** The type of the codec (e.g., "audio") */ codec_type: string; /** The codec tag as a string */ codec_tag_string: string; /** The codec tag */ codec_tag: string; /** The sample format */ sample_fmt: string; /** The sample rate in Hz */ sample_rate: string; /** The number of audio channels */ channels: number; /** The channel layout (e.g., "stereo") */ channel_layout: string; /** The bits per sample */ bits_per_sample: number; /** The real frame rate */ r_frame_rate: string; /** The average frame rate */ avg_frame_rate: string; /** The time base */ time_base: string; /** The starting presentation timestamp */ start_pts: number; /** The starting time */ start_time: string; /** The bitrate in bits per second */ bit_rate: string; /** The stream disposition flags */ disposition: { /** Default flag */ default: number; /** Dub flag */ dub: number; /** Original flag */ original: number; /** Comment flag */ comment: number; /** Lyrics flag */ lyrics: number; /** Karaoke flag */ karaoke: number; /** Forced flag */ forced: number; /** Hearing impaired flag */ hearing_impaired: number; /** Visual impaired flag */ visual_impaired: number; /** Clean effects flag */ clean_effects: number; /** Attached picture flag */ attached_pic: number; /** Timed thumbnails flag */ timed_thumbnails: number; /** Captions flag */ captions: number; /** Descriptions flag */ descriptions: number; /** Metadata flag */ metadata: number; /** Dependent flag */ dependent: number; /** Still image flag */ still_image: number; }; /** The metadata tags */ tags: { [key: string]: string; }; }; /** * Xtream category information * * This type represents a content category in the Xtream system */ declare type XtreamCategory = { /** The unique identifier for the category */ category_id: string; /** The display name of the category */ category_name: string; /** The ID of the parent category, if applicable */ parent_id: number; }; /** * Xtream channel information * * This type represents a live TV channel in the Xtream system */ declare type XtreamChannel = { /** The position/order number of the channel */ num: number; /** The name of the channel */ name: string; /** The type of stream (e.g., "live") */ stream_type: string; /** The unique identifier for the stream */ stream_id: number; /** The URL for the channel's logo */ stream_icon: string; /** The URL for the channel's cover image */ thumbnail: string; /** The Electronic Program Guide channel ID */ epg_channel_id: string; /** The date when the channel was added to the system */ added: string; /** The primary category ID of the channel */ category_id: string; /** All category IDs the channel belongs to */ category_ids: number[]; /** Custom stream identifier */ custom_sid: string; /** Flag indicating if TV archive is available (0/1) */ tv_archive: number; /** The direct URL to the channel's source */ direct_source: string; /** The duration of available archive in days */ tv_archive_duration: number; /** The URL to access the channel */ url?: string; }; /** * Xtream EPG listing information * * This type represents a single EPG listing for a channel */ declare type XtreamEPGListing = { /** The unique identifier for the listing */ id: string; /** The EPG ID of the listing */ epg_id: string; /** The title of the listing */ title: string; /** The language of the listing */ lang: string; /** The start time of the listing */ start: string; /** The end time of the listing */ end: string; /** The description of the listing */ description: string; /** The channel ID of the listing */ channel_id: string; /** The start timestamp of the listing */ start_timestamp: string; /** The stop timestamp of the listing */ stop_timestamp: string; /** The stop time of the listing */ stop: string; }; /** * Xtream episode information * * This type represents an episode in a show in the Xtream system */ declare type XtreamEpisode = { /** The unique identifier for the episode */ id: string; /** The episode number within the season */ episode_num: string; /** The title of the episode */ title: string; /** The file format extension */ container_extension: string; /** Detailed information about the episode */ info: XtreamEpisodeInfo; /** Custom stream identifier */ custom_sid: string; /** The date when the episode was added to the system */ added: string; /** The season number the episode belongs to */ season: number; /** The direct URL to the episode's source */ direct_source: string; /** URLs to subtitle files */ subtitles: string[]; /** The URL to access the episode */ url?: string; }; /** * Xtream episode information * * This type represents the information about an episode in a show */ declare type XtreamEpisodeInfo = { /** The air date of the episode */ air_date?: string; /** The release date of the episode */ release_date: string | null; /** The plot of the episdoe */ plot: string | null; /** The rating of the episode */ rating: number; /** The image of the episode */ movie_image: string; /** The big cover of the episode */ cover_big: string; /** The duration of the episode in seconds */ duration_secs: number; /** The formatted duration of the episode */ duration: string; /** The id of the episode in The Movie Database */ tmdb_id: number; /** The video information of the episode */ video?: XtreamVideoInfo; /** The audio information of the episode */ audio?: XtreamAudioInfo; /** The bitrate of the episode */ bitrate: number; /** The season number of the episode */ season: number; }; /** * Xtream EPG information * * This type represents all EPG information for a channel stored in the Xtream system */ declare type XtreamFullEPG = { /** The list of EPG listings */ epg_listings: XtreamFullEPGListing[]; }; /** * Xtream full EPG listing information * * This type represents a single EPG listing for a channel with additional information */ declare type XtreamFullEPGListing = Prettify<Omit<XtreamEPGListing, 'stop'> & { /** Flag indicating if the listing is currently playing */ now_playing: number; /** Flag indicating if the listing has an archive available */ has_archive: number; }>; /** * Xtream movie information * * This type represents the detailed information about a movie */ declare type XtreamMovie = { /** The information about the movie */ info: XtreamMovieInfo; /** Extra details of the movie */ movie_data: XtreamMovieData; url?: string; }; /** * Xtream movie data * * This type represents the extra details of a movie stream */ declare type XtreamMovieData = { /** The unique identifier for the stream */ stream_id: number; /** The title of the movie */ name: string; /** The title of the movie */ title: string; /** The year the movie was released */ year: string | null; /** The date when the movie was added to the system */ added: string; /** The primary category ID of the movie */ category_id: string; /** All category IDs the movie belongs to */ category_ids: number[]; /** The file format extension */ container_extension: string; /** Custom stream identifier */ custom_sid: string; /** The direct URL to the movie's source */ direct_source: string; }; /** * Xtream movie information * * This type represents the technical details of a movie stream */ declare type XtreamMovieInfo = { /** The URL to the movie's Kinopoisk page */ kinopoisk_url: string; /** The ID of the movie in The Movie Database (TMDB) */ tmdb_id: number; /** The title of the movie */ name: string; /** The original title of the movie */ o_name: string; /** The URL for the movie's cover image */ cover_big: string; /** The URL for the movie's image */ movie_image: string; /** The release date of the movie */ release_date: string | null; /** The runtime of the movie in minutes */ episode_run_time: number | null; /** The YouTube ID or URL for the trailer */ youtube_trailer: string | null; /** The director(s) of the movie */ director: string | null; /** The actors in the movie */ actors: string | null; /** The cast of the movie */ cast: string | null; /** The synopsis/description of the movie */ description: string | null; /** The plot of the movie */ plot: string | null; /** The age rating of the movie */ age: string; /** The MPAA rating of the movie */ mpaa_rating: string; /** The number of ratings on Kinopoisk */ rating_count_kinopoisk: number; /** The country of origin for the movie */ country: string; /** The genre(s) of the movie */ genre: string | null; /** Array of backdrop image URLs */ backdrop_path: string[]; /** The duration of the movie in seconds */ duration_secs: number; /** The formatted duration of the movie */ duration: string; /** The bitrate of the movie */ bitrate: number; /** The release date of the movie */ releasedate: string | null; /** Array of available subtitles */ subtitles: string[]; /** The rating of the movie */ rating: number; }; /** * Xtream movie information * * This type represents a movie in the Xtream system */ declare type XtreamMoviesListing = { /** The position/order number of the movie */ num: number; /** The title of the movie */ name: string; /** Year released */ year: string | null; /** The title of the movie */ title: string; /** The type of stream (e.g., "movie") */ stream_type: string; /** The unique identifier for the stream */ stream_id: number; /** The URL for the movie's icon/poster */ stream_icon: string; /** The movie's rating as a string */ rating: number; /** The movie's rating on a 5-point scale */ rating_5based: number; /** The genres of the movie */ genre: string | null; /** The date when the movie was added to the system */ added: string; /** The runtime of the movie in minutes */ episode_run_time: number | null; /** The primary category ID of the movie */ category_id: string; /** All category IDs the movie belongs to */ category_ids: number[]; /** The file format extension */ container_extension: string; /** Custom stream identifier */ custom_sid: any; /** The direct URL to the movie's source */ direct_source: string; /** The release date of the movie */ release_date: string | null; /** The cast of the movie */ cast: string | null; /** The director(s) of the movie */ director: string | null; /** The synopsis/description of the movie */ plot: string | null; /** Youtube ID of the trailer */ youtube_trailer: string | null; /** The URL to access the movie */ url?: string; }; /** * Xtream season information * * This type represents a season of a show in the Xtream system */ declare type XtreamSeason = { /** The unique identifier for the season */ id: number; /** The name of the season */ name: string; /** The number of episodes in the season as a string */ episode_count: number; /** The synopsis/description of the season */ overview: string; /** The date when the season first aired */ air_date: string | null; /** The URL for the season's cover image */ cover: string; /** The season number */ season_number: number; /** The URL for a larger version of the season's cover */ cover_big: string; /** The average rating vote for the season */ vote_average: number; }; /** * Xtream server information * * This type represents the server-specific part of the profile */ declare type XtreamServerInfo = { /** Flag to indicate if it is a XUI instance */ xui: boolean; /** Software version */ version: string; /** Software revision */ revision: string | null; /** The base URL of the Xtream server */ url: string; /** The HTTP port number */ port: string; /** The HTTPS port number */ https_port: string; /** The protocol used by the server */ server_protocol: string; /** The RTMP port number for streaming */ rtmp_port: string; /** The timezone setting of the server */ timezone: string; /** The current server timestamp */ timestamp_now: number; /** The current server time as a formatted string */ time_now: string; }; /** * Xtream short EPG information * * This type represents the short EPG information for a channel */ declare type XtreamShortEPG = { /** The list of EPG listings */ epg_listings: XtreamEPGListing[]; }; /** * Xtream show detailed information * * This type represents the complete information about a show including seasons and episodes */ declare type XtreamShow = { /** Array of seasons in the show */ seasons: XtreamSeason[]; /** Basic information about the show */ info: XtreamShowInfo; /** Object containing episodes grouped by season number */ episodes: { [key: string]: XtreamEpisode[]; }; }; declare type XtreamShowInfo = { /** The title of the show */ name: string; /** The title of the show */ title: string; /** The year of release */ year: string | null; /** The unique identifier for the series, added by this library */ series_id?: number; /** The URL for the show's cover image */ cover: string; /** The synopsis/description of the show */ plot: string | null; /** The cast members of the show */ cast: string | null; /** The director(s) of the show */ director: string | null; /** The genre(s) of the show */ genre: string | null; /** The release date of the show (alternate format) */ releaseDate: string | null; /** The release date of the show */ release_date: string | null; /** The date when the show was last updated */ last_modified: string; /** The show's rating as a string */ rating: string; /** The show's rating on a 5-point scale as a string */ rating_5based: number; /** Array of backdrop image URLs */ backdrop_path: string[]; /** The YouTube ID or URL for the trailer */ youtube_trailer: string | null; /** The average runtime of episodes as a string */ episode_run_time: string | null; /** The primary category ID of the show */ category_id: string; /** All category IDs the show belongs to */ category_ids: number[]; }; /** * Xtream show information * * This type represents a show listing in the Xtream system */ declare type XtreamShowListing = { /** The position/order number of the show */ num: number; /** The title of the show */ name: string; /** The title of the show */ title: string; /** The year of release */ year: string | null; /** The unique identifier for the series */ series_id: number; /** The type of stream (e.g., "series") */ stream_type: string; /** The URL for the show's cover image */ cover: string; /** The synopsis/description of the show */ plot: string | null; /** The cast members of the show */ cast: string | null; /** The director(s) of the show */ director: string | null; /** The genre(s) of the show */ genre: string | null; /** The release date of the show (alternate format) */ releaseDate: string | null; /** The release date of the show */ release_date: string | null; /** The date when the show was last updated */ last_modified: string; /** The show's rating as a string */ rating: string; /** The show's rating on a 5-point scale as a string */ rating_5based: number; /** Array of backdrop image URLs */ backdrop_path: string[]; /** The YouTube ID or URL for the trailer */ youtube_trailer: string | null; /** The average runtime of episodes as a string */ episode_run_time: string | null; /** The primary category ID of the show */ category_id: string; /** All category IDs the show belongs to */ category_ids: number[]; }; /** * Xtream user profile information * * This type represents the user-specific part of the profile */ declare type XtreamUserProfile = { /** The username of the account */ username: string; /** The password of the account */ password: string; /** Any message from the server about the account */ message: string; /** Authentication status (1 for authenticated) */ auth: number; /** Account status (e.g., "Active") */ status: string; /** The expiration date of the account */ exp_date: string; /** Flag indicating if the account is a trial */ is_trial: string; /** Number of active connections currently used */ active_cons: number; /** The date when the account was created */ created_at: string; /** Maximum allowed concurrent connections */ max_connections: string; /** Formats the user is allowed to access */ allowed_output_formats: string[]; }; /** * Xtream video information * * This type represents the technical details of a video stream */ declare type XtreamVideoInfo = { /** The stream index in the container */ index: number; /** The short name of the codec */ codec_name: string; /** The full name of the codec */ codec_long_name: string; /** The codec profile */ profile: string; /** The type of the codec (e.g., "video") */ codec_type: string; /** The codec tag as a string */ codec_tag_string: string; /** The codec tag */ codec_tag: string; /** The width of the video in pixels */ width: number; /** The height of the video in pixels */ height: number; /** The coded width of the video */ coded_width: number; /** The coded height of the video */ coded_height: number; /** Flag indicating if closed captions are available */ closed_captions: number; /** Flag indicating if film grain is present */ film_grain: number; /** Flag indicating if B-frames are used */ has_b_frames: number; /** The sample aspect ratio */ sample_aspect_ratio: string; /** The display aspect ratio */ display_aspect_ratio: string; /** The pixel format */ pix_fmt: string; /** The codec level */ level: number; /** The color range */ color_range: string; /** The color space */ color_space: string; /** The color transfer characteristics */ color_transfer: string; /** The color primaries */ color_primaries: string; /** The chroma sample location */ chroma_location: string; /** The field order */ field_order: string; /** The number of reference frames */ refs: number; /** Flag indicating if AVC format is used */ is_avc: string; /** The NAL unit length size */ nal_length_size: string; /** The real frame rate */ r_frame_rate: string; /** The average frame rate */ avg_frame_rate: string; /** The time base */ time_base: string; /** The starting presentation timestamp */ start_pts: number; /** The starting time */ start_time: string; /** The bits per raw sample */ bits_per_raw_sample: string; /** The size of extra data */ extradata_size: number; /** The stream disposition flags */ disposition: { /** Default flag */ default: number; /** Dub flag */ dub: number; /** Original flag */ original: number; /** Comment flag */ comment: number; /** Lyrics flag */ lyrics: number; /** Karaoke flag */ karaoke: number; /** Forced flag */ forced: number; /** Hearing impaired flag */ hearing_impaired: number; /** Visual impaired flag */ visual_impaired: number; /** Clean effects flag */ clean_effects: number; /** Attached picture flag */ attached_pic: number; /** Timed thumbnails flag */ timed_thumbnails: number; /** Captions flag */ captions: number; /** Descriptions flag */ descriptions: number; /** Metadata flag */ metadata: number; /** Dependent flag */ dependent: number; /** Still image flag */ still_image: number; }; /** The metadata tags */ tags: { [key: string]: string; }; }; export { }