tsvb | Effects SDK

Hierarchy

tsvb

Constructors

constructor

new tsvb(customer_id: string, inference?: any): tsvb

- Defined in tsvb.ts:51
Initiation of main SDK instance.

Parameters
- customer_id: string
  
  the unique customer identifier provided by SDK vendor.
- inference: any = null
Returns tsvb

Properties

components

components: {} = ...

Type declaration

[key: string]: Component

customer_id

customer_id: string

Unique customer identifier provided by SDK vendor.

Optional onReady

onReady?: (() => void)

Type declaration

- (): void
- Returns void

Static HEIGHT

HEIGHT: number = 480

Static WIDTH

WIDTH: number = 640

Static Optional onAuthRequested

onAuthRequested?: ((url: string, payload: Object) => Promise<string>)

Type declaration

- (url: string, payload: Object): Promise<string>
- Parameters
  - url: string
  - payload: Object
  Returns Promise<string>

Methods

addComponent

addComponent<K>(c: ClassType<K>, id: string): void

- Defined in tsvb.ts:827
Type Parameters
- K extends "overlay_screen" | "watermark" | "lower_third_1"
Parameters
- c: ClassType<K>
- id: string
Returns void

clear

clear(): boolean

- Defined in tsvb.ts:746
Clear output stream.

Returns boolean

clearBackground

clearBackground(): boolean

- Defined in tsvb.ts:483
Disable background effect. As a background will be shown original video.

Returns boolean

clearBlur

clearBlur(): boolean

- Defined in tsvb.ts:458
Disable blur of the background.

Returns boolean

config

config(config: any): void

Ability to configure sdk execution environment

example

General configuration options

config = {
   api_url: 'url', // custom url for sdk authentication, applicable for on-premises solutions
   model_url: 'url', // custom url for segmentation model, in the most cases this parameter is not required to configure
   sdk_url: 'url',  // this parameter specify the url to SDK folder in case when you host model files by yourself
   preset: 'balanced', // you can specify default segmentation preset (quality, balanced, speed, lightning)
   proxy: true/false, // configuration specify if segmentation should be working in separate worker thread (not in main UI thread), default value is true
   stats: true/false, // enabling/disabling statistics sending
   models: {
       'colorcorrector': 'url', // ability to provide custom name of model, if it's empty feature will be disabled
       'facedetector': 'url', // ability to provide custom name of model, if it's empty feature will be disabled
   },
   wasmPaths: { // currently wasm files are loading from the same directory where SDK is placed, but custom urls also supported (for example you can load it from CDNs)
       'ort-wasm.wasm': 'url',
       'ort-wasm-simd.wasm': 'url',
       'ort-wasm-threaded.wasm': 'url',
       'ort-wasm-simd-threaded.wasm': 'url'
   }
}

example

Example of how to change default segmentation preset

config = {
   preset: 'lightning'
}

example

Example of how to disable colorcorrection and facedetection

config = {
   models: {
       'colorcorrector': '',
       'facedetector': '',
   }
}

@example Example of how to hot models on custom domain

config = {
   sdk_url: 'https://domain.com/sdk/'  // in this derectory should be subfolder models with all required models
}

Parameters

config: any

configuration object

Returns void

createComponent

createComponent<K>(arg: K extends keyof OptionsMap ? ComponentArguments<K> : Omit<ComponentArguments<K>, "options">): ClassType<K>

- Defined in tsvb.ts:822
Type Parameters
- K extends "overlay_screen" | "watermark" | "lower_third_1"
Parameters
- arg: K extends keyof OptionsMap ? ComponentArguments<K> : Omit<ComponentArguments<K>, "options">
Returns ClassType<K>

disableBeautification

disableBeautification(): boolean

- Defined in tsvb.ts:378
Disable beautification effect.

Returns boolean

disableColorCorrector

disableColorCorrector(): boolean

- Defined in tsvb.ts:685
Disable color-corrector effect.

Returns boolean

disableFrameSkipping

disableFrameSkipping(): boolean

- Defined in tsvb.ts:507
Disable Frame Skipping - segmentation will be running on every video frame. FrameSkipping disabled by default.

Returns boolean

disablePipelineSkipping

disablePipelineSkipping(): void

- Defined in tsvb.ts:813
Returns void

disableSmartZoom

disableSmartZoom(): boolean

- Defined in tsvb.ts:661
Disable smart-zoom effect.

Returns boolean

enableBeautification

enableBeautification(): boolean

- Defined in tsvb.ts:366
Enable beautification effect.

Returns boolean

enableColorCorrector

enableColorCorrector(): boolean

- Defined in tsvb.ts:673
Enable color-correction effect.

Returns boolean

enableFrameSkipping

enableFrameSkipping(): boolean

- Defined in tsvb.ts:495
Enable Frame Skipping - segmentation will be running on every second frame, this will increase FPS but brings some motion trail

Returns boolean

enablePipelineSkipping

enablePipelineSkipping(): void

- Defined in tsvb.ts:809
Returns void

enableSmartZoom

enableSmartZoom(): boolean

- Defined in tsvb.ts:649
Enable smart-zoom effect.

Returns boolean

getCustomerId

getCustomerId(): string

- Defined in tsvb.ts:216
Get Customer ID provided by vendor.

Returns string

getEffectProcessor

getEffectProcessor(): EffectProcessor

- Defined in tsvb.ts:817
Returns EffectProcessor

getSegmentationPreset

getSegmentationPreset(): string

- Defined in tsvb.ts:284
Return current active segmentation mode.

Returns string

getStream

getStream(): null | MediaStream

- Defined in tsvb.ts:313
Get the output MediaStream object for further processing.

Returns null | MediaStream

hideFps

hideFps(): boolean

- Defined in tsvb.ts:354
Hide fps on the stream.

Returns boolean

run

run(): boolean

- Defined in tsvb.ts:765
Run the processing of frames.

Returns boolean

setAuthRequest

setAuthRequest(func: ((url: string, payload: Object) => Promise<string>)): void

- Defined in tsvb.ts:42
Parameters
- func: ((url: string, payload: Object) => Promise<string>)
  - - (url: string, payload: Object): Promise<string>
    - Parameters
      - url: string
      - payload: Object
      Returns Promise<string>
Returns void

setBackground

setBackground(url: string | MediaStream | MediaStreamTrack | HTMLVideoElement): boolean

- Defined in tsvb.ts:471
Set media source of the background. Video sources will be played automatically from the beginning.

Parameters
- url: string | MediaStream | MediaStreamTrack | HTMLVideoElement
  
  the link to image/video of the server or one of the following objects: MediaStream, MediaStreamTrack, HTMLVideoElement.
Returns boolean

setBackgroundColor

setBackgroundColor(color: number): void

- Defined in tsvb.ts:305
Set the background color for background 'color' mode.

Parameters
- color: number
  
  in hexadecimal format.
Returns void

setBackgroundFitMode

setBackgroundFitMode(mode: string): boolean

- Defined in tsvb.ts:406
Control background fit/fill mode. Default value is fill mode.

Parameters
- mode: string
  
  the background fit mode, can be fit of fill
Returns boolean

setBeautificationLevel

setBeautificationLevel(level: number): boolean

- Defined in tsvb.ts:432
Control face beautification level.

Parameters
- level: number
  
  could be from 0 to 1. Higher number -> more visible effect of beautification.
Returns boolean

setBlur

setBlur(power: number): boolean

- Defined in tsvb.ts:446
Enable blur of the background and set the power of blur.

Parameters
- power: number
  
  of the blur, can be a number from 0 to 1. Higher number -> better blur. This value could affect the performance (CPU/GPU, FPS)
Returns boolean

setBoundaryLevel

setBoundaryLevel(level: number): boolean

- Defined in tsvb.ts:419
Control segmentation boundaries area.

Parameters
- level: number
  
  of area, could be from -5 to 5. Higher number -> bigger area outside the segmentation object.
Returns boolean

setBoundaryMode

setBoundaryMode(mode: string): boolean

- Defined in tsvb.ts:392
Control boundary mode smooth or strong. Default value is strong mode.

Parameters
- mode: string
  
  the boundary mode, can be smooth or strong
Returns boolean

setColorCorrectorPeriod

setColorCorrectorPeriod(value: number): boolean

- Defined in tsvb.ts:713
Set period in ms for cc-model working.

Parameters
- value: number
  
  can be a number from 0 to 5000 (default 1000)
Returns boolean

setColorCorrectorPower

setColorCorrectorPower(value: number): boolean

- Defined in tsvb.ts:730
Set power of color correction.

Parameters
- value: number
  
  can be a number from 0 to 1 (default 1)
Returns boolean

setCustomLayout

setCustomLayout(persent: { size?: number; xOffset?: number; yOffset?: number }): boolean

- Defined in tsvb.ts:784
Parameters
- persent: { size?: number; xOffset?: number; yOffset?: number }
  - Optional size?: number
  - Optional xOffset?: number
  - Optional yOffset?: number
Returns boolean

setFaceArea

setFaceArea(value: number): boolean

- Defined in tsvb.ts:535
Set the face-area proportion. Used by the smart-zoom effect to calculate frame scale value

Parameters
- value: number
  
  can be a number from 0.01 to 1 (default = 0.1)
Returns boolean

setFaceDetectorAccuracy

setFaceDetectorAccuracy(value: number): boolean

- Defined in tsvb.ts:552
Set the face detector accuracy.

Parameters
- value: number
  
  can be a number from 0.2 to 1 (default 0.75)
Returns boolean

setFilterPart

setFilterPart(value: number): boolean

- Defined in tsvb.ts:699
Set filter part for the color correction (dev feature).

Parameters
- value: number
  
  can be a number from 0 to 1 (default 1)
Returns boolean

setFpsLimit

setFpsLimit(limit: number): boolean

- Defined in tsvb.ts:330
Show fps on the stream.

Parameters
- limit: number
Returns boolean

setLayout

setLayout(mode: string): boolean

- Defined in tsvb.ts:520
Set the layout mode. Useful for presentations.

Parameters
- mode: string
  
  could be the one of the following: center, left-bottom, right-bottom
Returns boolean

setSegmentationPreset

setSegmentationPreset(preset: string): Promise<boolean>

- Defined in tsvb.ts:261
Set the segmentation mode. Segmentation mode allow to choose combination of quality and speed of segmentation. Balanced mode is enabled by default.

Parameters
- preset: string
  
  in string format. The values could be quality, balanced, speed, lightning.
Returns Promise<boolean>

setSmartZoomPerod

setSmartZoomPerod(value: number): boolean

- Defined in tsvb.ts:605
Set period in ms for face detector reaction.

Parameters
- value: number
  
  can be a number from 0 to 1000 (default 100)
Returns boolean

setSmartZoomSensitivity

setSmartZoomSensitivity(value: number): boolean

- Defined in tsvb.ts:588
Set sensitivity for the smart-zoom rection. The set value means the difference between the new and old face-params for the smartzoom reaction

Parameters
- value: number
  
  can be a number from 0 to 1 (default 0.05)
Returns boolean

setSmartZoomSmoothing

setSmartZoomSmoothing(steps: number): boolean

- Defined in tsvb.ts:570
Set count of the smart-zoom smoothing. The more steps, the higher the smoothing

Parameters
- steps: number
  
  can be a number from 0.01 to 1 (default 0.2)
Returns boolean

showFps

showFps(): boolean

- Defined in tsvb.ts:342
Show fps on the stream.

Returns boolean

stop

stop(): boolean

- Defined in tsvb.ts:776
Stop the processing of frames.

Returns boolean

switchDrawFaceSquare

switchDrawFaceSquare(isOn: boolean): boolean

- Defined in tsvb.ts:622
Switch face-square-drawing mode.

Parameters
- isOn: boolean
  
  is a boolean argument (default false)
Returns boolean

switchDrawPreFaceSquare

switchDrawPreFaceSquare(isOn: boolean): boolean

- Defined in tsvb.ts:637
Switch preface-square-drawing mode. Draw face square before processing

Parameters
- isOn: boolean
  
  is a boolean argument (default false)
Returns boolean

toCanvas

toCanvas(canvas: HTMLCanvasElement): void

- Defined in tsvb.ts:322
Set the canvas where will be rendered the processed frames.

Parameters
- canvas: HTMLCanvasElement
  
  the HTMLCanvasElement object.
Returns void

useStream

useStream(stream: MediaStream): void

- Defined in tsvb.ts:226
Set the MediaStream object which will be the source of the video frames for processing.

Parameters
- stream: MediaStream
  
  the source MediaStream object.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

customer_id: string

inference: any = null

Returns tsvb

Properties

components

Type declaration

[key: string]: Component

customer_id

Optional onReady

Type declaration

Returns void

Static HEIGHT

Static WIDTH

Static Optional onAuthRequested

Type declaration

Parameters

url: string

payload: Object

Returns Promise<string>

Methods

addComponent

Type Parameters

K extends "overlay_screen" | "watermark" | "lower_third_1"

Parameters

c: ClassType<K>

id: string

Returns void

clear

Returns boolean

clearBackground

Returns boolean

clearBlur

Returns boolean

config

Parameters

config: any

Returns void

createComponent

Type Parameters

K extends "overlay_screen" | "watermark" | "lower_third_1"

Parameters

arg: K extends keyof OptionsMap ? ComponentArguments<K> : Omit<ComponentArguments<K>, "options">

Returns ClassType<K>

disableBeautification

Returns boolean

disableColorCorrector

Returns boolean

disableFrameSkipping

Returns boolean

disablePipelineSkipping

Returns void

disableSmartZoom

Returns boolean

enableBeautification

Returns boolean

enableColorCorrector

Returns boolean

enableFrameSkipping

Returns boolean

enablePipelineSkipping

Returns void

enableSmartZoom

Returns boolean

getCustomerId

Returns string

getEffectProcessor

Returns EffectProcessor

getSegmentationPreset

Returns string

getStream

Returns null | MediaStream

hideFps