Filter

Defined in: core/filter.ts:10

The Filter class represents a post-processing shader used within XSplit Broadcaster. This can be used to apply effects to videoitems.

Simply use one of the available Filter objects such as Filter.BLUR or Filter.SKETCHPENCILSTROKE as the parameter to the setFilter() method of an Item instance

Constructors

Constructor

new Filter(key): Filter

Defined in: core/filter.ts:40

Parameters

key

string

Returns

Filter

Properties

_filterMap

static _filterMap: object

Defined in: core/filter.ts:14

BLOOM

BLOOM: string = 'bloom'

BLUR

BLUR: string = 'blur'

COOL

COOL: string = 'cool'

INVERTCOLOR

INVERTCOLOR: string = 'invertcolor'

LUT

LUT: string = 'lut'

MAGNIFYSMOOTH

MAGNIFYSMOOTH: string = 'magnifysmooth'

MONOCHROME

MONOCHROME: string = 'monochrome'

NONE

NONE: string = 'none'

OLDMOVIE

OLDMOVIE: string = 'oldmovie'

SKETCHPENCILSTROKE

SKETCHPENCILSTROKE: string = 'sketchpencilstroke'

WARM

WARM: string = 'warm'

---

BLOOM

static BLOOM: Filter

Defined in: core/filter.ts:31

---

BLUR

static BLUR: Filter

Defined in: core/filter.ts:37

---

COOL

static COOL: Filter

Defined in: core/filter.ts:29

---

INVERTCOLOR

static INVERTCOLOR: Filter

Defined in: core/filter.ts:33

---

LUT

static LUT: Filter

Defined in: core/filter.ts:38

---

MAGNIFYSMOOTH

static MAGNIFYSMOOTH: Filter

Defined in: core/filter.ts:36

---

MONOCHROME

static MONOCHROME: Filter

Defined in: core/filter.ts:32

---

NONE

static NONE: Filter

Defined in: core/filter.ts:28

---

OLDMOVIE

static OLDMOVIE: Filter

Defined in: core/filter.ts:34

---

SKETCHPENCILSTROKE

static SKETCHPENCILSTROKE: Filter

Defined in: core/filter.ts:35

---

WARM

static WARM: Filter

Defined in: core/filter.ts:30

Methods

toFilterKey()

toFilterKey(): string

Defined in: core/filter.ts:62

Converts this transition object to a easily identifiable string such as ‘NONE’.

Returns

string

---

toString()

toString(): string

Defined in: core/filter.ts:55

Converts this transition object to the underlying string representation to be read by XSplit Broadcaster.

Returns

string

---

getFilters()

static getFilters(): Promise<Filter[]>

Defined in: core/filter.ts:85

return: Promise<Filter[]>

Get all available filters for use in videoitems

** MINIMUM XBC REQUIREMENT ** requires XBC v.3.9.1912.1002 and above

Usage

Filter.getFilters()
.then(function(filters) {
  for (var i = 0; i < filters.length; i++) {
    console.log(filters[i].toString(); // Returns the value of the filter
  }
})

Returns

Promise<Filter[]>