javascript-ampache/dist/videos/index.d.ts

A JS library for the Ampache API

import { VideoResponse, VideosResponse, DeletedVideosResponse } from "./types";
import { Base, BinaryBoolean, Pagination, UID } from "../base";
export declare class Videos extends Base {
    /**
     * Get videos
     * @remarks MINIMUM_API_VERSION=380001
     * @param [params.filter] Filter results to match this string
     * @param [params.exact] 0, 1 (if true filter is exact = rather than fuzzy LIKE)
     * @param [params.offset]
     * @param [params.limit]
     * @see {@link https://ampache.org/api/api-json-methods#videos}
     */
    videos(params?: {
        filter?: string;
        exact?: BinaryBoolean;
    } & Pagination): Promise<VideosResponse>;
    /**
     * This returns a single video
     * @remarks MINIMUM_API_VERSION=380001
     * @param params.filter UID to find
     * @see {@link https://ampache.org/api/api-json-methods#video}
     */
    video(params: {
        filter: UID;
    }): Promise<VideoResponse>;
    /**
     * This returns video objects that have been deleted
     * @param [params.offset]
     * @param [params.limit]
     * @see {@link https://ampache.org/api/api-json-methods#deleted_videos}
     */
    deletedVideos(params?: {} & Pagination): Promise<DeletedVideosResponse>;
}