Class VideoPlayer

Hierarchy (view full)

Constructors

constructor

Properties

playInBackground

Accessors

activeAndEnabled context crossOrigin currentTime currentVideo destroyed enabled forward hideFlags isComponent isLooping isPlaying layer muted name playbackSpeed right scene screenspace static tag up videoElement videoMaterial videoTexture worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake create destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? pause play preload removeEventListener resolveGuids? setClipURL setVideo setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stop stopCoroutine update? updateAspect

Constructors

constructor

Properties

playInBackground

playInBackground: boolean = true

Set this to false to pause video playback while the tab is not active

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

crossOrigin

  • get crossOrigin(): string

  • Returns string

  • set crossOrigin(val): void

  • Parameters

    • val: string

    Returns void

currentTime

  • get currentTime(): number

  • Returns number

  • set currentTime(val): void

  • Parameters

    • val: number

    Returns void

currentVideo

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

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

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isLooping

  • get isLooping(): boolean

  • Returns boolean

  • set isLooping(val): void

  • Parameters

    • val: boolean

    Returns void

isPlaying

  • get isPlaying(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

muted

  • get muted(): boolean

  • Returns boolean

  • set muted(val): void

  • Parameters

    • val: boolean

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

playbackSpeed

  • get playbackSpeed(): number

  • Returns number

  • set playbackSpeed(val): void

  • Parameters

    • val: number

    Returns void

right

  • get right(): Vector3

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

    Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

screenspace

  • get screenspace(): boolean

  • Returns boolean

  • set screenspace(val): void

  • Parameters

    • val: 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

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

    Returns Vector3

videoElement

videoMaterial

  • get videoMaterial(): any

  • Returns any

videoTexture

  • get videoTexture(): any

  • Returns any

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

create

  • create(playAutomatically): boolean

  • create the video element and assign the video source url or stream

    Parameters

    • playAutomatically: boolean

    Returns boolean

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

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    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

pause

  • pause(): void

  • Returns void

play

  • play(): void

  • start playing video source

    Returns void

preload

  • preload(): void

  • ensure's the video elemnent has been created and will start loading the clip

    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

setClipURL

  • setClipURL(url): void

  • Parameters

    • url: string

    Returns void

setVideo

  • setVideo(video): void

  • Set a new video stream
    starts to play automatically if the videoplayer hasnt been active before and playOnAwake is true

    Parameters

    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

Optional start

startCoroutine

stop

  • stop(): void

  • Returns void

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

Optional update

updateAspect

  • updateAspect(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructorplayInBackgroundactiveAndEnabledcontextcrossOrigincurrentTimecurrentVideodestroyedenabledforwardhideFlagsisComponentisLoopingisPlayinglayermutednameplaybackSpeedrightscenescreenspacestatictagupvideoElementvideoMaterialvideoTextureworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakecreatedestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidatepauseplaypreloadremoveEventListenerresolveGuidssetClipURLsetVideosetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopstopCoroutineupdateupdateAspect

Generated using TypeDoc