PlatformScreenRecorder
Defined in: platform/types.ts:734
The host’s game-screen recorder, one per host (both vendors hand out a singleton). Every call resolves when the host says the thing happened, not when it was asked: otherwise a refused start shows “recording” over nothing.
Properties
Section titled “Properties”canShare
Section titled “canShare”
readonlycanShare:boolean
Defined in: platform/types.ts:738
Whether a finished recording can be shared from here at all.
limits
Section titled “limits”
readonlylimits:object
Defined in: platform/types.ts:736
The recording length the host accepts, in seconds.
maxSeconds
Section titled “maxSeconds”
readonlymaxSeconds:number
minSeconds
Section titled “minSeconds”
readonlyminSeconds:number
Methods
Section titled “Methods”abort()
Section titled “abort()”abort():
Promise<void>
Defined in: platform/types.ts:745
Returns
Section titled “Returns”Promise<void>
highlight()
Section titled “highlight()”highlight(
beforeSeconds,afterSeconds):void
Defined in: platform/types.ts:747
Keep beforeSeconds before now and afterSeconds after it for sharing.
Parameters
Section titled “Parameters”beforeSeconds
Section titled “beforeSeconds”number
afterSeconds
Section titled “afterSeconds”number
Returns
Section titled “Returns”void
pause()
Section titled “pause()”pause():
Promise<void>
Defined in: platform/types.ts:742
Returns
Section titled “Returns”Promise<void>
resume()
Section titled “resume()”resume():
Promise<void>
Defined in: platform/types.ts:743
Returns
Section titled “Returns”Promise<void>
share()
Section titled “share()”share(
recording,options):Promise<void>
Defined in: platform/types.ts:749
Both hosts refuse unless this runs inside the player’s tap.
Parameters
Section titled “Parameters”recording
Section titled “recording”options
Section titled “options”Returns
Section titled “Returns”Promise<void>
start()
Section titled “start()”start(
maxSeconds,onFailure):Promise<void>
Defined in: platform/types.ts:741
onFailure hears a failure after the start was accepted — the recording
is gone when it is called.
Parameters
Section titled “Parameters”maxSeconds
Section titled “maxSeconds”number
onFailure
Section titled “onFailure”(error) => void
Returns
Section titled “Returns”Promise<void>
stop()
Section titled “stop()”stop():
Promise<PlatformRecording>
Defined in: platform/types.ts:744
Returns
Section titled “Returns”Promise<PlatformRecording>