VideoSearchOptions

popyt

---

popyt / Library Exports / VideoSearchOptions

Type Alias: VideoSearchOptions

VideoSearchOptions = object

Defined in: types/RetrievalService.ts:189

Filters to be used with YouTube#search() or YouTube#searchVideos()

Properties

channel?

optional channel?: ChannelResolvable

Defined in: types/RetrievalService.ts:193

Search for videos uploaded by a channel.

---

eventType?

optional eventType?: "completed" | "live" | "upcoming"

Defined in: types/RetrievalService.ts:208

Search for ended, live, or upcoming livestreams.

---

location?

optional location?: string

Defined in: types/RetrievalService.ts:219

Search by latitude and longitude coordinates in the format (37.42307,-122.08427).

---

locationRadius?

optional locationRadius?: string

Defined in: types/RetrievalService.ts:226

See Location

Units are 'm', 'km', 'ft', and 'mi'. e.g. '5km'. No larger than 1000km.

---

videoCaption?

optional videoCaption?: "any" | "closedCaption" | "none"

Defined in: types/RetrievalService.ts:214

---

videoCategory?

optional videoCategory?: VideoCategoryResolvable

Defined in: types/RetrievalService.ts:198

Search for videos in a certain category (Film & Animation, Comedy, Drama, etc.) (must be an object or ID from the API, not a title of a category).

---

videoEmbeddable?

optional videoEmbeddable?: boolean

Defined in: types/RetrievalService.ts:203

Search for videos that are embeddable into external websites.

---

videoType?

optional videoType?: "any" | "episode" | "movie"

Defined in: types/RetrievalService.ts:213

Search specifically for TV shows or movies.