@vonage/media-processor
Classes
Interfaces
Enumerations
Type Aliases
EventMetaData
Ƭ EventMetaData: Object
EventMetaData. Some metadata of the event.
Type declaration
| Name | Type | Description |
|---|---|---|
transformerIndex | number | The transformer index in the array of transformers. |
DropInfo
Ƭ DropInfo: Object
DropInfo gives info about the frame rate of the transformer
Type declaration
| Name | Type | Description |
|---|---|---|
requested | number | The rate predicted rate of the track |
current | number | The actual rate of the track |
WarnData
Ƭ WarnData: Object
WarnData - MediaProcessor warning event defintion
Type declaration
| Name | Type | Description |
|---|---|---|
eventMetaData | EventMetaData | Meta data of the event |
warningType | WarningType | The waring type |
dropInfo? | DropInfo | Optional - FPS drop info. |
ErrorData
Ƭ ErrorData: Object
ErrorData. MediaProcessor error data definition.
Type declaration
| Name | Type | Description |
|---|---|---|
eventMetaData | EventMetaData | Metadata of the event. |
function | ErrorFunction | The function in which the error occurred. |
error | unknown | Type of unknown but moslty will be string |
EventDataMap
Ƭ EventDataMap: Object
EventDataMap. A map type for all event options from MediaProcessor. Each event will include only one type.
Type declaration
| Name | Type | Description |
|---|---|---|
warn | WarnData | Warnings from the insertable streams pipeline. |
error | ErrorData | Errors from the insertable streams pipeline. |
pipelineInfo | PipelineInfoData | Info from the insertable streams pipeline life cycle. |
Functions
isSupported
▸ isSupported(): Promise<void>
Check if the current browser is officially supported by the library.
Returns
Promise<void>
The promise will resolve or reject depending whether the browser is supported or not.