mythtv-services-api/dist/VideoService.d.ts

Mythtv Service Api Bindings

import { AbstractService } from './Communication';
import ApiTypes from './ApiTypes';
export declare namespace VideoService {
    namespace Request {
        interface GetVideoList extends Partial<ApiTypes.SortedListRequest<'added' | 'released' | 'title' | 'director' | 'studio' | 'plot' | 'rating' | 'year' | 'releasedate' | 'userrating' | 'length' | 'playcount' | 'filename' | 'hash' | 'showlevel' | 'coverfile' | 'inetref' | 'collectionref' | 'homepage' | 'childid' | 'browse' | 'watched' | 'playcommand' | 'category' | 'intid' | 'trailer' | 'screenshot' | 'banner' | 'fanart' | 'subtitle' | 'tagline' | 'season' | 'episode' | 'host' | 'insertdate' | 'processed' | 'contenttype'>> {
            Folder?: string;
        }
        interface AddVideo {
            FileName: string;
            HostName: string;
        }
        interface GetBluray {
            Path: string;
        }
        interface GetVideo {
            Id: number;
        }
        interface GetVideoByFileName {
            FileName: string;
        }
        interface LookupVideo {
            Title: string;
            Subtitle?: string;
            Inetref?: string;
            Season?: number;
            Episode?: number;
            GrabberType?: string;
            AllowGeneric?: boolean;
        }
        interface RemoveVideoFromDB {
            Id: number;
        }
        interface UpdateVideoMetadata {
            Id: number;
            Title?: string;
            SubTitle?: string;
            TagLine?: string;
            Director?: string;
            Studio?: string;
            Plot?: string;
            Rating?: string;
            Inetref?: string;
            CollectionRef?: number;
            HomePage?: string;
            Year?: number;
            ReleaseDate?: Date;
            UserRating?: number;
            Length?: number;
            PlayCount?: number;
            Season?: number;
            Episode?: number;
            ShowLevel?: number;
            FileName?: string;
            Hash?: string;
            CoverFile?: string;
            ChildID?: number;
            Browse?: boolean;
            Watched?: boolean;
            Processed?: boolean;
            PlayCommand?: string;
            Category?: number;
            Trailer?: string;
            Host?: string;
            Screenshot?: string;
            Banner?: string;
            Fanart?: string;
            InsertDate?: Date;
            ContentType?: string;
            Genres?: string;
            Cast?: string;
            Countries?: string;
        }
        interface UpdateVideoWatchedStatus {
            Id: number;
            Watched: boolean;
        }
    }
    class Service extends AbstractService {
        constructor(baseUrl: URL);
        GetVideoList(req: Request.GetVideoList): Promise<ApiTypes.VideoMetadataInfoList>;
        AddVideo(req: Request.AddVideo): Promise<void>;
        GetBluray(req: Request.GetBluray): Promise<ApiTypes.BlurayInfo>;
        GetVideo(req: Request.GetVideo): Promise<ApiTypes.VideoMetadataInfo>;
        GetVideoByFileName(req: Request.GetVideoByFileName): Promise<ApiTypes.VideoMetadataInfo>;
        LookupVideo(req: Request.LookupVideo): Promise<ApiTypes.VideoLookupList>;
        RemoveVideoFromDB(req: Request.RemoveVideoFromDB): Promise<void>;
        UpdateVideoMetadata(req: Request.UpdateVideoMetadata): Promise<void>;
        UpdateVideoWatchedStatus(req: Request.UpdateVideoWatchedStatus): Promise<void>;
    }
}