TexturesModule Overview
TexturesModule Overview
GalleryTextureMediaVideo

GalleryTextureMediaVideo

The GalleryTextureMediaVideo class represents video media picked from the gallery that is being used by a given GalleryTexture and exposes APIs to control video playback.

Inherits From : GalleryTextureMediaBase

Properties

PropertyDescription
duration
(get) duration: ScalarSignal
(set) (Not Available)


Specifies a 'ScalarSignal' that returns the duration of the video media in
seconds.
looping
(get) looping: BoolSignal
(set) looping: BoolSignal


Specifies a 'BoolSignal' that is representing if playback should be looping.
Note that setting 'looping' to true while playback has stopped at the end will
implicitly restart playback at the beginning.
onCompleted
(get) onCompleted: EventSource<void>
(set) (Not Available)


Returns an EventSource that will fire once playback has been completed, ie.
reached the end of the media and stopped.
This event will only be emitted when looping is disabled.
onLooped
(get) onLooped: EventSource<void>
(set) (Not Available)


Returns an EventSource that will fire once playback has reached the end and has
been wrapped around to the beginning while still playing.
This event will only be emitted when looping is enabled.
playing
(get) playing: BoolSignal
(set) playing: BoolSignal


Specifies a 'BoolSignal' that is representing the current 'playing' state of the
video. Will evaluate to true if playing or false if paused or the video reached
the end and is not looping.
Note that a true 'playing' signal has no effect if the playback has completed and
looping is disabled.
progress
(get) progress: ScalarSignal
(set) progress: ScalarSignal


Specifies a 'ScalarSignal' that is representing the current progress while
playing back the GalleryTexture. Note that the progress normalized and
is in [0.0, 1.0].
Note that setting an out of bounds progress value (ie. < 0.0 or > 1.0) will
be ignored and playback continues unchanged. This is useful because binding
this signal to values that are in range constantly will result in constant
seek attempts in the underlying Video Player that might degrade performance.
Also cf. seek() API.

Note that setting the progress signal on a paused video won't implicitly
start it.

Methods

MethodDescription
seek
seek(value: number): Promise<void>


Seeks video playback position to 'value' for the current media.
Note that the value normalized and is in [0.0, 1.0] and that this API
is causing a seek operation in the underlying Video Player.

Any signal bound to "progress" will take precedence over an explicit seek()
call. An error will be returned from seek() in that case.

Was this article helpful?