类 VideoTexture

En

Video texture class, used to create video textures.

Zh

视频纹理

Blueprint Ignore Subclasses

层级 (查看完整内容)

属性

_id allowBackground destroyedImmediately hdrEncodeFormat lock? name? url uuid DEBUG

访问器

anisoLevel baseMipmapLevel compareMode cpuMemory currentSrc currentTime deps destroyed dimension duration ended filterMode format frameRate frameRender gammaSpace gpuMemory height id loop maxMipmapLevel mipmap mipmapCount muted obsolute paused playbackRate readyState referenceCount source updateFrame useFrame useMediaFrameRate videoHeight videoWidth volume width wrapModeU wrapModeV wrapModeW cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps canPlayType destroy event gpuCompressFormat hasListener isCreateFromURL load off offAll offAllCaller on once pause play resume createInstance destroyUnusedResources

属性

_id

_id: number = 0

allowBackground

allowBackground: boolean = false

En

Whether to allow the video to continue playing in the background。

Zh

视频是否允许在后台继续播放。

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

hdrEncodeFormat

hdrEncodeFormat: HDREncodeFormat

En

hdr encode format

Zh

hdr编码格式

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

访问器

anisoLevel

baseMipmapLevel

compareMode

cpuMemory

currentSrc

currentTime

deps

destroyed

dimension

duration

  • get duration(): number

  • 返回 number

    En

    The duration of the video in seconds. Available after the ready event is triggered.

    Zh

    视频长度（秒）。ready 事件触发后可用。

ended

filterMode

format

frameRate

  • get frameRate(): number

  • 返回 number

    En

    The frame rate of the video texture, which indicates the number of renderings in one second. It only takes effect when useMediaFrameRate is false or the current platform does not support obtaining the video frame rate.

    Zh

    视频纹理更新帧率，表示一秒内的渲染次数。只有useMediaFrameRate为false或者当前平台不支持获取视频自身帧率时才生效。

  • set frameRate(value): void

  • 参数

    • value: number

    返回 void

frameRender

  • get frameRender(): boolean

  • 返回 boolean

    En

    Whether to call the render function internally. If not, the user needs to call the render function manually. Default is true.

    Zh

    是否内部驱动调用render函数。如果否，则需要用户自行调用render函数。默认true。

  • set frameRender(value): void

  • 参数

    • value: boolean

    返回 void

gammaSpace

gpuMemory

height

id

loop

maxMipmapLevel

mipmap

mipmapCount

muted

obsolute

  • get obsolute(): boolean

  • 返回 boolean

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value): void

  • 参数

    • value: boolean

    返回 void

paused

playbackRate

  • get playbackRate(): number

  • 返回 number

    En

    The current playback speed of the audio/video. For example:

    • 1.0: Normal speed
    • 0.5: Half speed (slower)
    • 2.0: Double speed (faster)
    • -1.0: Backwards, normal speed
    • -0.5: Backwards, half speed Note: Only Google Chrome and Safari support the playbackRate property.

    Zh

    音频/视频的当前播放速度。如：

    • 1.0：正常速度
    • 0.5：半速（更慢）
    • 2.0：倍速（更快）
    • -1.0：向后，正常速度
    • -0.5：向后，半速 注意：只有 Google Chrome 和 Safari 支持 playbackRate 属性。
  • set playbackRate(value): void

  • 参数

    • value: number

    返回 void

readyState

  • get readyState(): number

  • 返回 number

    En

    The readiness state of the video element:

    • 0 = HAVE_NOTHING - No information is available about the audio/video
    • 1 = HAVE_METADATA - Metadata for the audio/video is ready
    • 2 = HAVE_CURRENT_DATA - Data for the current playback position is available, but not enough to play the next frame/millisecond
    • 3 = HAVE_FUTURE_DATA - Data for the current and at least the next frame is available
    • 4 = HAVE_ENOUGH_DATA - Enough data is available to start playing

    Zh

    视频元素的就绪状态：

    • 0 = HAVE_NOTHING - 没有关于音频/视频是否就绪的信息
    • 1 = HAVE_METADATA - 关于音频/视频就绪的元数据
    • 2 = HAVE_CURRENT_DATA - 关于当前播放位置的数据是可用的，但没有足够的数据来播放下一帧/毫秒
    • 3 = HAVE_FUTURE_DATA - 当前及至少下一帧的数据是可用的
    • 4 = HAVE_ENOUGH_DATA - 可用数据足以开始播放

referenceCount

source

updateFrame

useFrame

useMediaFrameRate

videoHeight

  • get videoHeight(): number

  • 返回 number

    En

    The height of the video source. Available after the ready event is triggered.

    Zh

    视频源高度。ready 事件触发后可用。

videoWidth

  • get videoWidth(): number

  • 返回 number

    En

    The width of the video source. Available after the ready event is triggered.

    Zh

    视频源宽度。ready 事件触发后可用。

volume

width

wrapModeU

wrapModeV

wrapModeW

静态cpuMemory

静态gpuMemory

方法

_addReference

  • _addReference(count?): void

  • 参数

    • count: number = 1

      The amount by which to increment the reference count, default is 1.

    返回 void

    En

    Increments the reference count of the resource by the specified amount.

    Zh

    按指定数量增加资源的引用计数。

_clearReference

_removeReference

  • _removeReference(count?): void

  • 参数

    • count: number = 1

      The amount by which to decrement the reference count, default is 1.

    返回 void

    En

    Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

    Zh

    按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

_setCreateURL

  • _setCreateURL(url, uuid?): void

  • 参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDep

addDeps

canPlayType

  • canPlayType(type): CanPlayTypeResult

  • 参数

    • type: string

      Video format type, such as "mp4", "ogg", "webm", "m3u8", etc.

    返回 CanPlayTypeResult

    The level of support. Possible values:

    • "probably": The browser most likely supports this audio/video type
    • "maybe": The browser might support this audio/video type
    • "": (empty string) The browser does not support this audio/video type

    En

    Check if the specified video format is supported for playback

    Zh

    检测是否支持播放指定格式视频

destroy

event

  • event(type, data?): boolean

  • 参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

gpuCompressFormat

hasListener

  • hasListener(type): boolean

  • 参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url): boolean

  • 参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

load

off

offAll

offAllCaller

on

  • on(type, listener): EventDispatcher

  • 参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type, caller, listener, args?): EventDispatcher

  • 参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type, listener): EventDispatcher

  • 参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(type, caller, listener, args?): EventDispatcher

  • 参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

pause

play

resume

静态createInstance

  • createInstance(): VideoTexture

  • 返回 VideoTexture

    En

    Create a video texture instance. You need to create a video texture in this way. You cannot directly use the new VideoTexture() method to create it.

    Zh

    创建一个视频纹理实例，需要通过这种方式创建视频纹理，不能直接使用new VideoTexture()的方式创建。

静态destroyUnusedResources

显示设置

成员可见性

目录

属性
访问器
方法