Class VideoRecorder

Player output to video

⚠️ The VideoRecorder works only on the platforms which supports MediaRecorder API.

Hierarchy

MediaRecorder
MediaRecorderSSR
- VideoRecorder

Index

Constructors

Properties

audioBitsPerSecond mimeType ondataavailable onerror onpause onresume onstart onstop state stream videoBitsPerSecond

Methods

addEventListener dispatchEvent pause removeEventListener requestData resume start stop isTypeSupported

Constructors

constructor

new VideoRecorder(player, options): VideoRecorder
Parameters
- player: Player
- options: MediaRecorderOptions
Returns VideoRecorder

Inherited from MediaRecorder.constructor

Properties

`Readonly` audioBitsPerSecond

audioBitsPerSecond: number

`Readonly` mimeType

mimeType: string

ondataavailable

ondataavailable: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: BlobEvent
  Returns any

onerror

onerror: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: MediaRecorderErrorEvent
  Returns any

onpause

onpause: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: Event
  Returns any

onresume

onresume: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: Event
  Returns any

onstart

onstart: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: Event
  Returns any

onstop

onstop: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaRecorder
  - ev: Event
  Returns any

`Readonly` state

state: RecordingState

`Readonly` stream

stream: MediaStream

`Readonly` videoBitsPerSecond

videoBitsPerSecond: number

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof MediaRecorderEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: MediaRecorder
      
      ev: MediaRecorderEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from MediaRecorder.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from MediaRecorder.addEventListener

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
- event: Event
Returns boolean

Inherited from MediaRecorder.dispatchEvent

pause

pause(): void
Pauses video recording

Returns void

Overrides MediaRecorder.pause

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof MediaRecorderEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: MediaRecorder
      
      ev: MediaRecorderEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from MediaRecorder.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from MediaRecorder.removeEventListener

requestData

requestData(): void
Returns void

Inherited from MediaRecorder.requestData

resume

resume(): void
Resumes video recording after a pause

Returns void

Overrides MediaRecorder.resume

start

start(): void
Start video recording

Returns void

Overrides MediaRecorder.start

stop

stop(): Promise<Blob>
Stops video recording

Returns Promise<Blob>
The recorder video

Inherited from MediaRecorder.stop

`Static` isTypeSupported

isTypeSupported(type): boolean
Parameters
- type: string
Returns boolean