Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VideoPlayer

Video 组件，用于在游戏中播放视频。 由于不同平台对于 VideoPlayer 组件的授权、API、控制方式都不同，还没有形成统一的标准，所以目前只支持 Web、iOS 和 Android 平台。

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private __prefab

__prefab: CompPrefabInfo | null = null

Protected _cachedCurrentTime

_cachedCurrentTime: number = 0

Protected _clip

_clip: VideoClip | null = null

Private _enabled

_enabled: boolean = true

Protected _fullScreenOnAwake

_fullScreenOnAwake: boolean = false

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _impl

_impl: any

Protected _keepAspectRatio

_keepAspectRatio: boolean = true

Protected _loop

_loop: boolean = false

Protected _mute

_mute: boolean = false

Protected _name

_name: string

_objFlags

_objFlags: number

Protected _playOnAwake

_playOnAwake: boolean = true

Protected _playbackRate

_playbackRate: number = 1

Protected _remoteURL

_remoteURL: string = ""

Protected _resourceType

_resourceType: number = ResourceType.LOCAL

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

Protected _stayOnBottom

_stayOnBottom: boolean = false

Protected _volume

_volume: number = 1

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

example
import { log } from 'cc';
log(comp.node);

videoPlayerEvent

videoPlayerEvent: ComponentEventHandler[] = []

视频播放回调函数，该回调函数会在特定情况被触发，比如播放中，暂时，停止和完成播放。

Static EventType

EventType: EventType = EventType

Static ResourceType

ResourceType: { LOCAL: number; REMOTE: number } = ResourceType

Type declaration

  • LOCAL: number
    en

    The local resource type.

    zh

    本地视频

  • REMOTE: number
    en

    The remote resource type.

    zh

    远程视频

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

clip

currentTime

  • get currentTime(): number
  • set currentTime(val: number): void

  • 指定视频从什么时间点开始播放，单位是秒，也可以用来获取当前视频播放的时间进度。

    Returns number

  • 指定视频从什么时间点开始播放，单位是秒，也可以用来获取当前视频播放的时间进度。

    Parameters

    • val: number

    Returns void

duration

  • get duration(): any

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

fullScreenOnAwake

  • get fullScreenOnAwake(): boolean
  • set fullScreenOnAwake(value: boolean): void

isPlaying

  • get isPlaying(): boolean

isValid

  • get isValid(): boolean

  • 表示该对象是否可用（被 destroy 后将不可用）。
    当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy，请使用 isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
const node = new Node();
log(node.isValid);    // true
node.destroy();
log(node.isValid);    // true, still valid in this frame
// after a frame...
log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

keepAspectRatio

  • get keepAspectRatio(): boolean
  • set keepAspectRatio(value: boolean): void

loop

  • get loop(): boolean
  • set loop(value: boolean): void

mute

  • get mute(): boolean
  • set mute(value: boolean): void

  • 是否静音视频。静音时设置音量为 0，取消静音是恢复原来的音量。

    Returns boolean

  • 是否静音视频。静音时设置音量为 0，取消静音是恢复原来的音量。

    Parameters

    • value: boolean

    Returns void

name

  • get name(): string
  • set name(value: string): void

nativeVideo

  • get nativeVideo(): any

playOnAwake

  • get playOnAwake(): boolean
  • set playOnAwake(value: boolean): void

playbackRate

  • get playbackRate(): number
  • set playbackRate(value: number): void

remoteURL

  • get remoteURL(): string
  • set remoteURL(val: string): void

resourceType

  • get resourceType(): number
  • set resourceType(val: number): void

state

  • get state(): any

stayOnBottom

  • get stayOnBottom(): boolean
  • set stayOnBottom(value: boolean): void

  • 永远在游戏视图最底层（这个属性只有在 Web 平台上有效果。注意：具体效果无法保证一致，跟各个浏览器是否支持与限制有关）

    Returns boolean

  • 永远在游戏视图最底层（这个属性只有在 Web 平台上有效果。注意：具体效果无法保证一致，跟各个浏览器是否支持与限制有关）

    Parameters

    • value: boolean

    Returns void

uuid

  • get uuid(): string

volume

  • get volume(): number
  • set volume(value: number): void

Methods

preload

  • __preload(): void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void

  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Optional Private getLocalBounds

  • getLocalBounds(out_rect: Rect): void

  • 如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB）， 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

onPreDestroy

  • _onPreDestroy(): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

destroy

  • destroy(): boolean

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

Protected Optional lateUpdate

  • lateUpdate(dt: number): void

  • 如果该组件启用，则每帧调用 LateUpdate。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

onCompleted

  • onCompleted(): void

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

onError

  • onError(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

  • onLoad(): void

  • 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

onMetaLoaded

  • onMetaLoaded(): void

onPasued

  • onPasued(): void

onPlaying

  • onPlaying(): void

onReadyToPlay

  • onReadyToPlay(): void

Protected Optional onRestore

  • onRestore(): void

  • onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。 然而，在极端的情况下，它可能无法良好运作。
    那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。 一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的，编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

onStopped

  • onStopped(): void

pause

  • pause(): void

play

  • play(): void

  • 开始播放。
    如果视频处于正在播放状态，将会重新开始播放视频。
    如果视频处于暂停状态，则会继续播放视频。

    Returns void

Optional resetInEditor

  • resetInEditor(): void

resume

  • resume(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void

  • 调度一个自定义的回调任务。
    如果回调任务已调度，那么将不会重复调度它，只会更新时间间隔参数。

    example
    import { log } from 'cc';
this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void

  • 调度一个只运行一次的回调任务，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

Protected Optional start

  • start(): void

  • 如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

stop

  • stop(): void

Protected syncSource

  • syncSource(): void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

update

  • update(dt: number): void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc