Interface VideoSearchParams

interface VideoSearchParams {
    adult?: number | boolean;
    count?: number;
    extended?: number | boolean;
    fields?: string | string[];
    filters?: "long" | "short" | "vimeo" | "youtube" | ("long" | "short" | "vimeo" | "youtube")[];
    hd?: number;
    live?: number | boolean;
    longer?: number;
    offset?: number;
    owner_id?: number;
    q?: string;
    search_own?: number | boolean;
    shorter?: number;
    sort?: 0 | 2 | 1;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

adult? count? extended? fields? filters? hd? live? longer? offset? owner_id? q? search_own? shorter? sort?

Properties

Optional adult

adult?: number | boolean

'1' - to disable the Safe Search filter, '0' - to enable the Safe Search filter

Optional count

count?: number

Number of videos to return.

Optional extended

extended?: number | boolean

Optional fields

fields?: string | string[]

Optional filters

filters?: "long" | "short" | "vimeo" | "youtube" | ("long" | "short" | "vimeo" | "youtube")[]

Optional hd

hd?: number

If not null, only searches for high-definition videos.

Optional live

live?: number | boolean

Optional longer

longer?: number

Optional offset

offset?: number

Offset needed to return a specific subset of videos.

Optional owner_id

owner_id?: number

Optional q

q?: string

Search query string (e.g., 'The Beatles').

Optional search_own

search_own?: number | boolean

Optional shorter

shorter?: number

Optional sort

sort?: 0 | 2 | 1

Sort order: '1' - by duration, '2' - by relevance, '0' - by date added

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc