Class ScreenCapture

Hierarchy (view full)

Implements

  • IPointerClickHandler

Properties

autoConnect device

Accessors

activeAndEnabled context currentMode currentScream destroyed enabled forward hideFlags isComponent isReceiving isSending layer name right scene screenspace static tag up videoPlayer worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake close destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPointerClick onPointerEnter onPointerExit onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation share start? startCoroutine stopCoroutine update?

Properties

autoConnect

autoConnect: boolean = false

When enabled the stream will start when this component becomes active (enabled in the scene)

device

device: ScreenCaptureDevice = ScreenCaptureDevice.Screen

Note: this can not be changed while streaming

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

currentMode

  • get currentMode(): ScreenCaptureMode

  • Returns ScreenCaptureMode

currentScream

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isReceiving

  • get isReceiving(): boolean

  • Returns boolean

isSending

  • get isSending(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

screenspace

  • get screenspace(): boolean

  • Returns boolean

  • set screenspace(v): void

  • Parameters

    • v: boolean

    Returns void

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

up

  • get up(): Vector3

  • Returns Vector3

videoPlayer

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

close

  • close(): void

  • Returns void

destroy

dispatchEvent

Optional earlyUpdate

Optional lateUpdate

Optional onAfterRender

Optional onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

onPointerClick

  • onPointerClick(evt): void

  • Parameters

    Returns void

onPointerEnter

  • onPointerEnter(): void

  • Returns void

onPointerExit

  • onPointerExit(): void

  • Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

share

  • share(opts?): Promise<void>

  • Call to begin screensharing

    Parameters

    • Optional opts: ScreenCaptureOptions

    Returns Promise<void>

Optional start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

autoConnectdeviceactiveAndEnabledcontextcurrentModecurrentScreamdestroyedenabledforwardhideFlagsisComponentisReceivingisSendinglayernamerightscenescreenspacestatictagupvideoPlayerworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakeclosedestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPointerClickonPointerEnteronPointerExitonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationsharestartstartCoroutinestopCoroutineupdate

Generated using TypeDoc