Constructor
new vimeoTrack(rawResponse, __scrapperOptions, extraContents)
Parameters:
| Name | Type | Description |
|---|---|---|
rawResponse |
string | Response Body like in text or HTML Player's Source Code |
__scrapperOptions |
object | scrapping Options for raw Fetch Method |
extraContents |
object | Extra Contents for Merging for cache in "extra Cache" |
- Source:
Members
__playerUrl
Properties:
| Name | Type | Description |
|---|---|---|
__playerUrl |
string | "https://player.vimeo.com/video/" | Player URL for Extraction of Player Metada and Stream Metadata |
- Source:
__scrapperOptions
Properties:
| Name | Type | Description |
|---|---|---|
__scrapperOptions |
object | Default HTML Scrapping and Parsing Options Compilation |
- Source:
__vimeoPlayerRegex
Properties:
| Name | Type | Description |
|---|---|---|
__vimeoPlayerRegex |
Array.<Regexp> | Array of Vimeo Player URL Supported Regexes |
- Source:
__vimeoRegex
Properties:
| Name | Type | Description |
|---|---|---|
__vimeoRegex |
Array.<Regexp> | Array of Vimeo Video URL Supported Regexes |
- Source:
extraRaw :object
Raw Extra Data from HTML Fetches and <response.data> Body and Compiled
Type:
- object
- Source:
raw :object
Raw Data from HTML Fetches and <response.data> Body and Compiled
Type:
- object
- Source:
rawJSON :object
Raw JSON Data from HTML Fetches and <response.data> Body and Compiled
Type:
- object
- Source:
videoId :string
Vimeo Video's Id Parsed from fetched Url if present
Type:
- string
- Source:
Methods
(async, static) __htmlFetch(rawUrl, __scrapperOptions, extraContents) → {Promise.<vimeoTrack>}
Parameters:
| Name | Type | Description |
|---|---|---|
rawUrl |
string | raw Vimeo Video Url for the Extraction |
__scrapperOptions |
object | scrapping Options for raw Fetch Method |
extraContents |
object | Extra Contents to be Added if placed from Html file Parser |
- Source:
Returns:
Returns Instance of Vimeo with properties of Data
- Type: Promise.<vimeoTrack>
(static) __test(rawUrl, returnRegex) → {boolean|RegExpMatchArray}
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
rawUrl |
string | raw url for checking if its Vimeo Video URL |
|
returnRegex |
boolean | 'false' | false | Boolean Value for if return the residue or results |
- Source:
Returns:
returns Boolean on success and Regex match Array Data if its requested
- Type: boolean | RegExpMatchArray
embedHTMl(width, height, frameBorder) → {string|void}
embedHTMl() -> Embed Frame Method to make a single html code snippet to paste for Embeded HTML Player
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
width |
number | string | 640 | 640 | width length of the Player in Embeded HTML Player Frame |
height |
number | string | 360 | 360 | height length of the Player in Embeded HTML Player Frame |
frameBorder |
number | string | 0 | 0 | frameBorder data of the Player in Embeded HTML Player Frame |
- Source:
Returns:
Returns Embed Player for HTML pages
- Type: string | void
(async) getStream(fetchUrl) → {Promise.<Readable>}
method getStream() -> Fetch Stream Readable
Parameters:
| Name | Type | Description |
|---|---|---|
fetchUrl |
string | Fetch Stream Url or normal Vimeo Video Url |
- Source:
Returns:
Returns Stream for HTML5 Pages or Web Apps working on Stream Based or pipeing Stuff
- Type: Promise.<Readable>
parseRaw(rawObjects) → {object}
parseRaw() -> Parse Raw Object/Properties of teh Class or requested Object Variable
Parameters:
| Name | Type | Description |
|---|---|---|
rawObjects |
object | Raw Objects Value to be parsed into meaningfull and cleaned |
- Source:
Returns:
Return cleaned Object Variable
- Type: object