Class BBBVideoScraper

The BBBVideoScraper class, that scrapes a video from a "BBB WebKonferenze" and saves it to a file.

Hierarchy

VideoScraperCore
Hierarchy
- BBBVideoScraper

Index

Constructors

Methods

afterPageLoaded close getFullScreenSelector getPlayButtonSelector getVideoDuration getVideoDurationSelector handleDurationText launch playVideo scrape setBrowserOptions setVideoToFullScreen

Constructors

constructor

new BBBVideoScraper(options?: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }): BBBVideoScraper
The constructor of the VideoScraperCore class.
Parameters
- Optional options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }
  
  The BrowserOptions to pass to the instance.
  - Optional browserExecutablePath?: string
    
    The path to the browser executable. (Default value: '/usr/bin/google-chrome')
  - Optional debug?: boolean
    
    If true, it will show debug log. (Default value: false)
  - Optional debugScope?: null | string
    
    The scope given to the euberlog debug logger. (Default value: 'VideoScraperCore')
  - Optional windowSize?: { width?: number | undefined; height?: number | undefined; }
    
    The object that says how big the window size will be. (Default value: { width: 1920, height: 1080 })
Returns BBBVideoScraper
Inherited from VideoScraperCore.constructor
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:50

Methods

`Protected` afterPageLoaded

afterPageLoaded(): Promise<void>
This method is called after the page, with the specified url, is loaded. It can be used for things such as logging in if it is requested before reaching the video page.

Returns Promise<void>
Overrides VideoScraperCore.afterPageLoaded
- Defined in source/utils/scraper.ts:18

close

close(): Promise<void>
Closes the browser window.

Returns Promise<void>
Inherited from VideoScraperCore.close
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:92

`Protected` getFullScreenSelector

getFullScreenSelector(): string
Returns the video full screen selector, which is used by the method setVideoToFullScreen to put the video in full screen.

Returns string
Overrides VideoScraperCore.getFullScreenSelector
- Defined in source/utils/scraper.ts:7

`Protected` getPlayButtonSelector

getPlayButtonSelector(): string
Returns the video play button selector, which is used by the method playVideo to play the video.

Returns string
Overrides VideoScraperCore.getPlayButtonSelector
- Defined in source/utils/scraper.ts:10

`Protected` getVideoDuration

getVideoDuration(page: Page, logger: Logger): Promise<number>
Gets the video duration by parsing the given page. This method can be overridden in case the page's way to display time is not compatible.

Returns
The extracted video duration
Parameters
- page: Page
  
  A browser page (of puppeteer)
- logger: Logger
  
  A logger instance to write log
Returns Promise<number>
Inherited from VideoScraperCore.getVideoDuration
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:65

`Protected` getVideoDurationSelector

getVideoDurationSelector(): string
Returns the video duration selector, which is used by the method getVideoDuration to extract the video duration text from the page.

Returns string
Overrides VideoScraperCore.getVideoDurationSelector
- Defined in source/utils/scraper.ts:13

`Protected` handleDurationText

handleDurationText(durationText: string): number
Given the duration text gotten from the page's HTML (e.g. 1:30:23), it returns the duration in milliseconds. This method can be overridden in case the page's time format is not compatible.

Returns
The duration in milliseconds.
Parameters
- durationText: string
  
  The duration text gotten from the page's HTML.
Returns number
Inherited from VideoScraperCore.handleDurationText
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:57

launch

launch(): Promise<void>
Launches the browser window.

Returns Promise<void>
Inherited from VideoScraperCore.launch
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:88

`Protected` playVideo

playVideo(page: Page, logger: Logger): Promise<void>
Plays the video by clicking the play button. This method can be overridden in case the page's way to start the video is not compatible.
Parameters
- page: Page
  
  A browser page (of puppeteer)
- logger: Logger
  
  A logger instance to write log
Returns Promise<void>
Inherited from VideoScraperCore.playVideo
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:79

scrape

scrape(url: string, destPath: string, options?: Omit<{ audio?: boolean; audioBitsPerSecond?: number; debug?: null | boolean; debugScope?: null | string; delayAfterVideoFinished?: number; delayAfterVideoStarted?: number; duration?: null | number; frameSize?: number; fullScreen?: boolean; mimeType?: BrowserMimeType; useGlobalDebug?: boolean; video?: boolean; videoBitsPerSecond?: number }, "fullScreen">): Promise<void>
Scrapes a video from a BBB conference.
Parameters
- url: string
  
  The url of the video to save
- destPath: string
  
  The path where the video will be saved. Note that the extension should be webm.
- options: Omit<{ audio?: boolean; audioBitsPerSecond?: number; debug?: null | boolean; debugScope?: null | string; delayAfterVideoFinished?: number; delayAfterVideoStarted?: number; duration?: null | number; frameSize?: number; fullScreen?: boolean; mimeType?: BrowserMimeType; useGlobalDebug?: boolean; video?: boolean; videoBitsPerSecond?: number }, "fullScreen"> = {}
  
  The ScrapingOptions to pass to this method.
Returns Promise<void>
Overrides VideoScraperCore.scrape
- Defined in source/utils/scraper.ts:26

setBrowserOptions

setBrowserOptions(options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }): void
Changes the BrowserOptions options.
Parameters
- options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }
  
  The new options.
  - Optional browserExecutablePath?: string
    
    The path to the browser executable. (Default value: '/usr/bin/google-chrome')
  - Optional debug?: boolean
    
    If true, it will show debug log. (Default value: false)
  - Optional debugScope?: null | string
    
    The scope given to the euberlog debug logger. (Default value: 'VideoScraperCore')
  - Optional windowSize?: { width?: number | undefined; height?: number | undefined; }
    
    The object that says how big the window size will be. (Default value: { width: 1920, height: 1080 })
Returns void
Inherited from VideoScraperCore.setBrowserOptions
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:84

`Protected` setVideoToFullScreen

setVideoToFullScreen(page: Page, logger: Logger): Promise<void>
Sets the video put the video in fullscreen. This method can be overridden in case the page's way to put the video in fullscreen is not compatible.
Parameters
- page: Page
  
  A browser page (of puppeteer)
- logger: Logger
  
  A logger instance to write log
Returns Promise<void>
Inherited from VideoScraperCore.setVideoToFullScreen
- Defined in node_modules/video-scraper-core/bundled/index.d.ts:72

Class BBBVideoScraper

Hierarchy

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }

Optional browserExecutablePath?: string

Optional debug?: boolean

Optional debugScope?: null | string

Optional windowSize?: { width?: number | undefined; height?: number | undefined; }

Returns BBBVideoScraper

Methods

Protected afterPageLoaded

Returns Promise<void>

close

Returns Promise<void>

Protected getFullScreenSelector

Returns string

Protected getPlayButtonSelector

Returns string

Protected getVideoDuration

Returns

Parameters

page: Page

logger: Logger

Returns Promise<number>

Protected getVideoDurationSelector

Returns string

Protected handleDurationText

Returns

Parameters

durationText: string

Returns number

launch

Returns Promise<void>

Protected playVideo

Parameters

page: Page

logger: Logger

Returns Promise<void>

scrape

Parameters

url: string

destPath: string

Returns Promise<void>

setBrowserOptions

Parameters

options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }

Optional browserExecutablePath?: string

Optional debug?: boolean

Optional debugScope?: null | string

Optional windowSize?: { width?: number | undefined; height?: number | undefined; }

Returns void

Protected setVideoToFullScreen

Parameters

page: Page

logger: Logger

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` options: { browserExecutablePath?: string; debug?: boolean; debugScope?: null | string; windowSize?: { width?: number | undefined; height?: number | undefined; } }

`Optional` browserExecutablePath?: string

`Optional` debug?: boolean

`Optional` debugScope?: null | string

`Optional` windowSize?: { width?: number | undefined; height?: number | undefined; }

`Protected` afterPageLoaded

`Protected` getFullScreenSelector

`Protected` getPlayButtonSelector

`Protected` getVideoDuration

`Protected` getVideoDurationSelector

`Protected` handleDurationText

`Protected` playVideo

`Optional` browserExecutablePath?: string

`Optional` debug?: boolean

`Optional` debugScope?: null | string

`Optional` windowSize?: { width?: number | undefined; height?: number | undefined; }

`Protected` setVideoToFullScreen