Transition

Defined in: core/transition.ts:24

The Transition class represents a preset transition within XSplit Broadcaster. This may be used to set the application’s transition scheme when switching scenes, or to set an individual item’s transition when its visibility changes.

Simply use one of the available Transition objects such as Transition.FAN or Transition.COLLAPSE as the parameter to the setTransition() method of an App instance, or a valid Item instance that supports transitions (this includes #core/CameraItem Core/CameraItem, #core/FlashItem Core/FlashItem, #core/GameItem Core/GameItem, #core/HtmlItem Core/HtmlItem, #core/ImageItem Core/ImageItem, #core/MediaItem Core/MediaItem, and #core/ScreenItem Core/ScreenItem.)

For scene transitions, you can also use custom stinger transitions, which are exposed through the static method Transition.getSceneTransitions

Constructors

Constructor

new Transition(key, setValue?): Transition

Defined in: core/transition.ts:58

Parameters

key

string

setValue?

any = null

Returns

Transition

Properties

CLOCK

static CLOCK: Transition

Defined in: core/transition.ts:45

---

COLLAPSE

static COLLAPSE: Transition

Defined in: core/transition.ts:46

---

FADE

static FADE: Transition

Defined in: core/transition.ts:47

---

FAN

static FAN: Transition

Defined in: core/transition.ts:48

---

HOLE

static HOLE: Transition

Defined in: core/transition.ts:49

---

MOVE_BOTTOM

static MOVE_BOTTOM: Transition

Defined in: core/transition.ts:50

---

MOVE_LEFT

static MOVE_LEFT: Transition

Defined in: core/transition.ts:51

---

MOVE_LEFT_RIGHT

static MOVE_LEFT_RIGHT: Transition

Defined in: core/transition.ts:52

---

MOVE_RIGHT

static MOVE_RIGHT: Transition

Defined in: core/transition.ts:53

---

MOVE_TOP

static MOVE_TOP: Transition

Defined in: core/transition.ts:54

---

MOVE_TOP_BOTTOM

static MOVE_TOP_BOTTOM: Transition

Defined in: core/transition.ts:55

---

NONE

static NONE: Transition

Defined in: core/transition.ts:44

---

WAVE

static WAVE: Transition

Defined in: core/transition.ts:56

Methods

toString()

toString(): string

Defined in: core/transition.ts:92

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

Returns

string

---

toTransitionKey()

toTransitionKey(): string

Defined in: core/transition.ts:99

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

Returns

string

---

getSceneTransitions()

static getSceneTransitions(): Promise<Transition[]>

Defined in: core/transition.ts:122

return: Promise<Transition[]>

Get all available transitions for use in scene change

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

Usage

Transtition.getSceneTransitions().then(function(transitions) {
  for (var i = 0; i < transitions.length; i++) {
    transitions.toString(); // Returns the value of the transition
    transitions.toTransitionKey(); // Returns the key of the transition
  }
})

Returns

Promise<Transition[]>