vlc-client/dist/Types.d.ts

Node HTTP client/remote implementation to control VLC with simple function calls using VLC's own HTTP interface

/// <reference types="node" />
export interface ClientOptions {
    ip: string;
    port: number;
    username?: string;
    password: string;
    log?: boolean;
}
export interface VlcStatus {
    fullscreen: boolean;
    aspectratio: string;
    audiodelay: number;
    apiversion: number;
    currentplid: number;
    time: number;
    volume: number;
    length: number;
    random: boolean;
    rate: number;
    state: string;
    loop: boolean;
    version: string;
    position: number;
    repeat: boolean;
    subtitledelay: number;
    equalizer: any[];
    information: {
        chapter: number;
        chapters: number[];
        title?: any;
        category: {
            meta: VlcMeta;
            [key: string]: VlcStream | VlcMeta;
        };
        titles: any[];
    };
}
export interface VlcMeta {
    showName?: string;
    seasonNumber?: string;
    episodeNumber?: string;
    filename: string;
    [key: string]: string;
}
export interface PlaylistEntry {
    name: string;
    id: number;
    duration: number;
    uri: string;
    isCurrent: boolean;
}
export declare enum AspectRatio {
    _1_1 = "1:1",
    _4_3 = "4:3",
    _5_4 = "5:4",
    _16_9 = "16:9",
    _16_10 = "16:10",
    _221_100 = "221:100",
    _235_100 = "235:100",
    _239_100 = "239:100"
}
export interface Tracks {
    video: VideoTrack[];
    audio: AudioTrack[];
    subtitle: SubtitleTrack[];
}
export interface VlcStream {
    Type: "Audio" | "Video" | "Subtitle";
    Language?: string;
    Codec?: string;
}
export interface Track extends VlcStream {
    streamIndex: number;
}
export interface VideoTrack extends Track {
    Frame_rate: string;
    Decoded_format: string;
    Video_resolution: string;
    Buffer_dimensions: string;
    Orientation: string;
}
export interface AudioTrack extends Track {
    Channels: string;
    Bits_per_sample: string;
    Sample_rate: string;
}
export interface SubtitleTrack extends Track {
}
export interface AlbumArtResult {
    contentType: string;
    buffer: Buffer;
}
export interface PlayFileOptions {
    noaudio?: boolean;
    novideo?: boolean;
    wait?: boolean;
    timeout?: number;
}
export declare enum VlcFileType {
    FILE = "file",
    DIR = "dir"
}
export interface VlcFile {
    type: VlcFileType;
    path: string;
    name: string;
    access_time: number;
    uid: number;
    creation_time: number;
    gid: number;
    modification_time: number;
    mode: number;
    uri: string;
    size: number;
}
export interface BrowseResponse {
    element: VlcFile[];
}