Class ScreenCapture

The ScreenCapture component allows you to share your screen, camera or microphone with other users in the networked room.
When the stream is active the video will be displayed on the VideoPlayer component attached to the same GameObject.

Note: For debugging append ?debugscreensharing to the URL to see more information in the console.

By default the component will start sharing the screen when the user clicks on the object this component is attached to. You can set device This behaviour can be disabled by setting allowStartOnClick to false.
It is also possible to start the stream manually from your code by calling the share method.

Hierarchy (View Summary)

Implements

Properties

allowStartOnClick autoConnect device deviceFilter? deviceName? gameObject guid sourceId?

Accessors

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

Methods

addEventListener close destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onBeforeXR? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onEnterXR? onLeaveXR? onPausedChanged? onPointerDown? onPointerMove? onPointerUp? onTriggerEnter? onTriggerExit? onTriggerStay? onUpdateXR? onValidate? onXRControllerAdded? onXRControllerRemoved? removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation share start? startCoroutine stopCoroutine supportsXR? update?

Properties

allowStartOnClick

allowStartOnClick: boolean = true

When enabled the stream will start when the user clicks on the object this component is attached to
It is also possible to start the stream manually from your code by calling the share method
To modify what type of device is shared you can set the device property.

Default

true

autoConnect

autoConnect: boolean = false

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

device

device: "Screen" | "Camera" | "Canvas" | "Microphone" = "Screen"

Which streaming device type should be used when starting to share (if share is called without a device option). Options are Screen, Camera, Microphone.
This is e.g. used if allowStartOnClick is enabled and the user clicks on the object.

Default

Screen

OptionaldeviceFilter

deviceFilter?: (device: MediaDeviceInfo) => boolean

Filter which device should be chosen for sharing by id or label.
Assign a method to this property to manually filter the available devices.

OptionaldeviceName

deviceName?: string

If assigned the device the device will be selected by this id or label when starting to share.
Note: This is only supported for Camera devices

gameObject

gameObject: GameObject

the object this component is attached to. Note that this is a threejs Object3D with some additional features

guid

guid: string = "invalid"

the unique identifier for this component

OptionalsourceId

sourceId?: string

holds the source identifier this object was created with/from (e.g. if it was part of a glTF file the sourceId holds the url to the glTF)

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

    Returns boolean

    true if the object is enabled and active in the hierarchy

context

  • get context(): Context

    Use the context to get access to many Needle Engine features and use physics, timing, access the camera or scene

    Returns Context

  • set context(context: Context): void

    Parameters

    Returns void

currentMode

  • get currentMode(): ScreenCaptureMode

    Returns ScreenCaptureMode

currentScream

destroyed

  • get destroyed(): boolean

    Returns boolean

    true if this component was destroyed (this.destroy()) or the whole object this component was part of

enabled

  • get enabled(): boolean

    Returns boolean

  • set enabled(val: boolean): void

    Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

    Forward (0,0,-1) vector in world space

    Returns Vector3

isReceiving

  • get isReceiving(): boolean

    Returns boolean

    true if the component is currently receiving a stream

isSending

  • get isSending(): undefined | boolean

    Returns undefined | boolean

    true if the component is currently sending a stream

layer

  • get layer(): number

    Returns number

    the layer of the gameObject this component is attached to

name

  • get name(): string

    Returns string

    the name of the gameObject this component is attached to

  • set name(str: string): void

    Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

    Right (1,0,0) vector in world space

    Returns Vector3

scene

  • get scene(): Scene

    shorthand for this.context.scene

    Returns Scene

    the scene of the context

screenspace

  • get screenspace(): boolean

    When enabled the video will be displayed in the screenspace of the VideoPlayer component.

    Returns boolean

  • set screenspace(v: boolean): void

    Parameters

    • v: boolean

    Returns void

static

  • get static(): boolean

    Is the gameObject marked as static

    Returns boolean

  • set static(value: boolean): void

    Parameters

    • value: boolean

    Returns void

tag

  • get tag(): string

    Returns string

    the tag of the gameObject this component is attached to

  • set tag(str: string): void

    Parameters

    • str: string

    Returns void

up

  • get up(): Vector3

    Up (0,1,0) vector in world space

    Returns Vector3

videoPlayer

  • get videoPlayer(): undefined | VideoPlayer

    Returns undefined | VideoPlayer

  • set videoPlayer(val: undefined | VideoPlayer): void

    If a VideoPlayer component is assigned to this property the video will be displayed on the VideoPlayer component.

    Parameters

    Returns void

worldEuler

  • get worldEuler(): Euler

    Returns Euler

  • set worldEuler(val: Euler): void

    Parameters

    Returns void

worldPosition

  • get worldPosition(): Vector3

    Returns Vector3

  • set worldPosition(val: Vector3): void

    Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

    Returns Quaternion

  • set worldQuaternion(val: Quaternion): void

    Parameters

    Returns void

worldRotation

  • get worldRotation(): Vector3

    Returns Vector3

  • set worldRotation(val: Vector3): void

    Parameters

    Returns void

Methods

addEventListener

  • addEventListener<T extends Event>(type: string, listener: (evt: T) => any): void

    Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Parameters

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

    Returns void

close

  • close(): void

    Returns void

destroy

  • destroy(): void

    Destroys this component (and removes it from the object)

    Returns void

dispatchEvent

  • dispatchEvent(evt: Event): boolean

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

OptionalearlyUpdate

  • earlyUpdate(): void

    first callback in a frame (called every frame when implemented)

    Returns void

OptionallateUpdate

  • lateUpdate(): void

    late callback in a frame (called every frame when implemented)

    Returns void

OptionalonAfterRender

OptionalonBeforeRender

  • onBeforeRender(frame: null | XRFrame): void

    called before the scene gets rendered in the main update loop

    Parameters

    • frame: null | XRFrame

    Returns void

OptionalonBeforeXR

  • onBeforeXR(mode: XRSessionMode, args: XRSessionInit): void

    Called before the XR session is requested. Use this callback if you want to modify the session init features

    Parameters

    • mode: XRSessionMode
    • args: XRSessionInit

    Returns void

OptionalonCollisionEnter

OptionalonCollisionExit

OptionalonCollisionStay

onDestroy

  • onDestroy(): void

    Called when the component gets destroyed

    Returns void

OptionalonEnterXR

OptionalonLeaveXR

OptionalonPausedChanged

  • onPausedChanged(isPaused: boolean, wasPaused: boolean): void

    Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

OptionalonPointerDown

OptionalonPointerMove

OptionalonPointerUp

OptionalonTriggerEnter

OptionalonTriggerExit

OptionalonTriggerStay

OptionalonUpdateXR

OptionalonValidate

  • onValidate(prop?: string): void

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

    Parameters

    • Optionalprop: string

      the name of the field that was changed

    Returns void

OptionalonXRControllerAdded

  • onXRControllerAdded(args: NeedleXRControllerEventArgs): void

    Callback when a controller is connected/added while in a XR session
    OR when the component joins a running XR session that has already connected controllers
    OR when the component becomes active during a running XR session that has already connected controllers

    Parameters

    Returns void

OptionalonXRControllerRemoved

removeEventListener

  • removeEventListener<T extends Event>(
        type: string,
        listener: (arg: T) => any,
    ): void

    Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Type Parameters

    Parameters

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

    Returns void

OptionalresolveGuids

  • resolveGuids(guidsMap: 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

  • setWorldPosition(x: number, y: number, z: number): void

    Parameters

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

    Returns void

setWorldQuaternion

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

    Parameters

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

    Returns void

setWorldRotation

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

    Parameters

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

    Returns void

share

  • share(opts?: ScreenCaptureOptions): Promise<null | void>

    Call to begin screensharing

    Parameters

    • Optionalopts: ScreenCaptureOptions

    Returns Promise<null | void>

Optionalstart

  • start(): void

    called at the beginning of a frame (once per component)

    Returns void

startCoroutine

  • startCoroutine(routine: Generator, evt?: FrameEvent): Generator

    starts a coroutine (javascript generator function)
    yield will wait for the next frame:

    • Use yield WaitForSeconds(1) to wait for 1 second.
    • Use yield WaitForFrames(10) to wait for 10 frames.
    • Use yield new Promise(...) to wait for a promise to resolve.

    Parameters

    • routine: Generator

      generator function to start

    • evt: FrameEvent = FrameEvent.Update

      event to register the coroutine for (default: FrameEvent.Update). Note that all coroutine FrameEvent callbacks are invoked after the matching regular component callbacks. For example FrameEvent.Update will be called after regular component update() methods)

    Returns Generator

    the generator function (use it to stop the coroutine with stopCoroutine)

    Example

    onEnable() { this.startCoroutine(this.myCoroutine()); }
    private *myCoroutine() {
       while(this.activeAndEnabled) {
          console.log("Hello World", this.context.time.frame);
          // wait for 5 frames
          for(let i = 0; i < 5; i++) yield;
       }
    }

stopCoroutine

  • stopCoroutine(routine: Generator, evt?: FrameEvent): void

    Stop a coroutine that was previously started with startCoroutine

    Parameters

    • routine: Generator

      the routine to be stopped

    • evt: FrameEvent = FrameEvent.Update

      the frame event to unregister the routine from (default: FrameEvent.Update)

    Returns void

OptionalsupportsXR

  • supportsXR(mode: XRSessionMode): boolean

    Optional callback, you can implement this to only get callbacks for VR or AR sessions if necessary.

    Parameters

    • mode: XRSessionMode

    Returns boolean

    true if the mode is supported (if false the mode is not supported by this component and it will not receive XR callbacks for this mode)

Optionalupdate

  • update(): void

    regular callback in a frame (called every frame when implemented)

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods