Home Reference Source

Function

Static Public Summary
public

Compare 2 version number strings.
public

getRecorderMode(image: *, audio: *, video: *, animation: *, screen: *): *

public

isChrome(): *

public

isEdge(): *

public

isFirefox(): *

public

isOpera(): *

public

isSafari(): *

public

setSrcObject(stream: *, element: *)

since 2.0.0
Static Private Summary
private

addFileInfo(fileObj: Blob | File, dateObj: date, fileExtension: string)

Add filename and modification date to recorded file object.
private

blobToArrayBuffer(fileObj: Blob | File): void

Read Blob as ArrayBuffer.
private

defaultKeyHandler(event: object): void

Default keyhandler.
private

Browser detector.
private

downloadBlob(fileName: string, data: blob): void

Download Blob object in browser.
private

formatTime(seconds: number, guide: number, displayMilliseconds: boolean): string

Format seconds as a duration string.
private

getAudioEngine(audioEngine: String): Object

Get audio plugin engine class.
private

getConvertEngine(convertEngine: String): Object

Get converter plugin engine class.
private

getExtension(mimeType: string): string

Get file extension for mime-type.
private

getVideoEngine(videoEngine: String): Object

Get video plugin engine class.
private

Check whether any audio record plugins are enabled.

Static Public

public compareVersion(v1: string, v2: string): number source 

import compareVersion from 'videojs-record/js/utils/compare-version.js'

Compare 2 version number strings.

Params:

NameTypeAttributeDescription
v1 string

First version number to compare.
v2 string

Second version number to compare.

Return:

number

Returns 0 if versions are equal, 1 if v1 is greater, and -1 if v2 is smaller.

public getRecorderMode(image: *, audio: *, video: *, animation: *, screen: *): * source 

import {getRecorderMode} from 'videojs-record/js/engine/record-mode.js'

Params:

NameTypeAttributeDescription
image *
audio *
video *
animation *
screen *

Return:

*

public isChrome(): * source 

import {isChrome} from 'videojs-record/js/utils/detect-browser.js'

Return:

*

public isEdge(): * source 

import {isEdge} from 'videojs-record/js/utils/detect-browser.js'

Return:

*

public isFirefox(): * source 

import {isFirefox} from 'videojs-record/js/utils/detect-browser.js'

Return:

*

public isOpera(): * source 

import {isOpera} from 'videojs-record/js/utils/detect-browser.js'

Return:

*

public isSafari(): * source 

import {isSafari} from 'videojs-record/js/utils/detect-browser.js'

Return:

*

public setSrcObject(stream: *, element: *) since 2.0.0 source 

import setSrcObject from 'videojs-record/js/utils/browser-shim.js'

Params:

NameTypeAttributeDescription
stream *
element *

Static Private

private addFileInfo(fileObj: Blob | File, dateObj: date, fileExtension: string) source 

import {addFileInfo} from 'videojs-record/js/utils/file-util.js'

Add filename and modification date to recorded file object.

Params:

NameTypeAttributeDescription
fileObj Blob | File

Blob or File object to modify.
dateObj date
  • optional

Optional modification date information. Default is new Date().
fileExtension string
  • optional

Optional file extension to use. By default the file extension is automatically determined using the mime-type.

private blobToArrayBuffer(fileObj: Blob | File): void source 

import {blobToArrayBuffer} from 'videojs-record/js/utils/file-util.js'

Read Blob as ArrayBuffer.

Params:

NameTypeAttributeDescription
fileObj Blob | File

Blob or File object to read.

Return:

void

private defaultKeyHandler(event: object): void source 

import defaultKeyHandler from 'videojs-record/js/hot-keys.js'

Default keyhandler.

Params:

NameTypeAttributeDescription
event object

Event containing key info.

Return:

void

private detectBrowser(): object source 

import {detectBrowser} from 'videojs-record/js/utils/detect-browser.js'

Browser detector.

Return:

object

result containing browser, version and minVersion properties.

private downloadBlob(fileName: string, data: blob): void source 

import {downloadBlob} from 'videojs-record/js/utils/file-util.js'

Download Blob object in browser.

Params:

NameTypeAttributeDescription
fileName string

Name for the file to download.
data blob

File data.

Return:

void

private formatTime(seconds: number, guide: number, displayMilliseconds: boolean): string source 

import formatTime from 'videojs-record/js/utils/format-time.js'

Format seconds as a duration string.

Either formatted as:

  • DD:HH:MM:SS (> 24 hours)
  • HH:MM:SS (> 1 hour)
  • MM:SS:MSS (displayMilliseconds = true)
  • MM:SS (displayMilliseconds = false)

Supplying a guide (in seconds) will force a number of leading zeros to cover the length of the guide.

Params:

NameTypeAttributeDescription
seconds number

Number of seconds to be turned into a string.
guide number

Number (in seconds) to model the string after.
displayMilliseconds boolean

Display milliseconds or not.

Return:

string

Formatted duration time, e.g '00:12:653'.

private getAudioEngine(audioEngine: String): Object source 

import {getAudioEngine} from 'videojs-record/js/engine/engine-loader.js'

Get audio plugin engine class.

Params:

NameTypeAttributeDescription
audioEngine String

Name of the audio engine.

Return:

Object

Audio engine class.

private getConvertEngine(convertEngine: String): Object source 

import {getConvertEngine} from 'videojs-record/js/engine/engine-loader.js'

Get converter plugin engine class.

Params:

NameTypeAttributeDescription
convertEngine String

Name of the convert engine.

Return:

Object

Convert engine class.

private getExtension(mimeType: string): string source 

import getExtension from 'videojs-record/js/utils/mime.js'

Get file extension for mime-type.

Params:

NameTypeAttributeDescription
mimeType string

Mime-type to match against.

Return:

string

File extension.

private getVideoEngine(videoEngine: String): Object source 

import {getVideoEngine} from 'videojs-record/js/engine/engine-loader.js'

Get video plugin engine class.

Params:

NameTypeAttributeDescription
videoEngine String

Name of the video engine.

Return:

Object

Video engine class.

private isAudioPluginActive(audioEngine: String): Boolean source 

import {isAudioPluginActive} from 'videojs-record/js/engine/engine-loader.js'

Check whether any audio record plugins are enabled.

Params:

NameTypeAttributeDescription
audioEngine String

Name of the audio engine.

Return:

Boolean

Whether any audio plugins are enabled or not.