ISourceReplay
Defined in: core/source/ireplay.ts:11
Methods
Section titled “Methods”getChannel()
Section titled “getChannel()”getChannel():
Promise<string>
Defined in: core/source/ireplay.ts:17
return: Promise
Gets the name of the stream/channel tied to the replay.
Returns
Section titled “Returns”Promise<string>
getHotkey()
Section titled “getHotkey()”getHotkey():
Promise<number>
Defined in: core/source/ireplay.ts:36
return: Promise
Gets the hotkey, in numerical value, used to toggle start/stop of the replay.
See conversion from keycode: #system/Replay Replay Class
Returns
Section titled “Returns”Promise<number>
getReplayState()
Section titled “getReplayState()”getReplayState():
Promise<number>
Defined in: core/source/ireplay.ts:90
return: Promise
Gets the replay state, may return any of the following: 0 - playing 1 - not playing -1 - no stream exists -2 - stream exists but cannot be tied to a replay
Returns
Section titled “Returns”Promise<number>
getReplayTime()
Section titled “getReplayTime()”getReplayTime():
Promise<number>
Defined in: core/source/ireplay.ts:55
return: Promise
Gets the duration, or buffer time for the replay
Returns
Section titled “Returns”Promise<number>
isAutostartOnSceneLoad()
Section titled “isAutostartOnSceneLoad()”isAutostartOnSceneLoad():
Promise<boolean>
Defined in: core/source/ireplay.ts:98
return: Promise
Checks whether this source is set to start playback when the application switches to this source’s scene.
Returns
Section titled “Returns”Promise<boolean>
setAutostartOnSceneLoad()
Section titled “setAutostartOnSceneLoad()”setAutostartOnSceneLoad(
value):Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:108
param: (value: boolean)
Specifies whether this source is set to start playback when the application switches to this source’s scene.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceReplay>
setChannel()
Section titled “setChannel()”setChannel(
channel):Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:27
param: (channel: string)
return: Promise<ISourceReplay>Sets the stream/channel tied to the replay via its name.
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”Promise<ISourceReplay>
setHotkey()
Section titled “setHotkey()”setHotkey(
hotkey):Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:48
param: (hotkey: number)
return: Promise<ISourceReplay>Sets the hotkey, in numerical value, used to toggle start/stop of the replay.
See conversion from keycode: #system/Replay Replay Class
Parameters
Section titled “Parameters”hotkey
Section titled “hotkey”number
Returns
Section titled “Returns”Promise<ISourceReplay>
setReplayTime()
Section titled “setReplayTime()”setReplayTime(
buffer):Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:65
param: (time: number)
return: Promise<ISourceReplay>Sets the duration, or buffer time for the replay
Parameters
Section titled “Parameters”buffer
Section titled “buffer”number
Returns
Section titled “Returns”Promise<ISourceReplay>
startReplay()
Section titled “startReplay()”startReplay():
Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:72
return: Promise
Start playing of the buffered replay
Returns
Section titled “Returns”Promise<ISourceReplay>
stopReplay()
Section titled “stopReplay()”stopReplay():
Promise<ISourceReplay>
Defined in: core/source/ireplay.ts:79
return: Promise
Stop playing of the buffered replay
Returns
Section titled “Returns”Promise<ISourceReplay>