Interface VideoTextureProvider

Controls a video texture resource. Can be accessed through Texture.control.

Example

// Plays a video texture
//@input Asset.Texture movie

var loops = 100;

var provider = script.movie.control;
provider.play(loops);

//@input Asset.Texture movie
var provider = script.movie.control;
var seekTime = 5.0; // Seek to 5 seconds into the video
if (provider) {     
    // The video automatically plays from 5 seconds
    provider.seek(seekTime); 
    print("Video resumed from " + seekTime + " seconds"); 
} else {
    print("Video control not available");
}
interface VideoTextureProvider {
    currentPlayCount: number;
    currentTime: number;
    duration: number;
    isPlaybackReady: boolean;
    lastFrameTime: number;
    onPlaybackDone: event0<void>;
    onPlaybackReady: event0<void>;
    playbackRate: number;
    relativeEndTime: number;
    relativeStartTime: number;
    status: VideoStatus;
    totalDuration: number;
    volume: number;
    getAspect(): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    pause(): void;
    play(playCount: number): void;
    resume(): void;
    seek(value: number): boolean;
    stop(): void;
}

Hierarchy (view full)

Properties

currentPlayCount currentTime duration isPlaybackReady lastFrameTime onPlaybackDone onPlaybackReady playbackRate relativeEndTime relativeStartTime status totalDuration volume

Methods

getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame pause play resume seek stop

Properties

ReadonlycurrentPlayCount

currentPlayCount: number

Returns the number of played cycles.

ReadonlycurrentTime

currentTime: number

Returns the current time in seconds, or zero if accessed during playback being in unprepared state.

Readonlyduration

duration: number

Returns the duration of playback range in seconds, or zero if accessed while playback is in an unprepared state.

ReadonlyisPlaybackReady

isPlaybackReady: boolean

Returns true if video file has been loaded and is ready for decoding and false otherwise.

ReadonlylastFrameTime

lastFrameTime: number

Returns the time of the last acquired texture in seconds, or zero if accessed during playback being in unprepared state.

ReadonlyonPlaybackDone

onPlaybackDone: event0<void>

The event for being reported about playback finished. When this event is triggered, lens developers can evict this texture from material slots to avoid disrupting user's experience.

ReadonlyonPlaybackReady

onPlaybackReady: event0<void>

The event for being reported about playback start. When this event is triggered, lens developers can set video texture to material slots and see actual video frames.

playbackRate

playbackRate: number

The playback rate of the video. The rate is set when starting playback, meaning that updates to this property does not take effect until the video is stopped and started again. Defaults to 1.

relativeEndTime

relativeEndTime: number

Sets or returns playback end time in unit range.

relativeStartTime

relativeStartTime: number

Sets or returns playback start time in unit range.

Readonlystatus

status: VideoStatus

A read-only property that returns the status of provider. Suggested as a substitution for the existing getStatus()

ReadonlytotalDuration

totalDuration: number

Returns the duration of loaded video file in seconds, or zero if accessed during playback being in unprepared state.

volume

volume: number

The audio volume of the video resource, normalized from 0 to 1.

Methods

getAspect

  • getAspect(): number

  • Returns the texture's aspect ratio, which is calculated as width / height.

    Returns number

getHeight

getLoadStatus

getTypeName

getWidth

  • getWidth(): number

  • Returns the width of the texture in pixels.

    Returns number

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

pause

  • pause(): void

  • Pauses the video playback.

    Returns void

play

  • play(playCount): void

  • Plays the video playCount times. If playCount is less than 0, it loops infinitely.

    Parameters

    • playCount: number

    Returns void

resume

  • resume(): void

  • Resumes the video playback.

    Returns void

seek

  • seek(value): boolean

  • Sets the current playback time to the specified time in seconds.

    Parameters

    • value: number

    Returns boolean

stop

  • stop(): void

  • Stops the video playback.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods