Struct Video

Source

pub struct Video(/* private fields */);

Expand description

Handle to a video clip. Derefs to Node.

let demo = view.add(Video::new().file("assets/demo.mp4").width(pct(70)).radius(24.0));
demo.play();
wait_for(2.0).await;
demo.playback_rate().to(0.25, 0.5).await;

Implementations§

Source §

impl Video

Source

pub fn new() -> VideoBuilder

A video node; set the clip with .file(path).

Source

pub fn node(self) -> Node

The untyped node handle.

Source

pub fn time(self) -> Signal<f64>

Seconds into the clip that the node shows. Set or animate it to scrub; play advances it.

Source

pub fn playback_rate(self) -> Signal<f64>

Clip seconds per scene second while playing. .to(0.25, 0.5) slows to quarter speed. The clip’s sound plays only at rate 1.

Source

pub fn duration(self) -> f64

Length of the clip in seconds (0 when it could not be opened).

Source

pub fn is_playing(self) -> bool

The clip is playing.

Source

pub fn play(self)

Plays from the current time until pause or the end of the clip. Returns at once; the clip plays alongside the scene.

Source

pub fn pause(self)

Stops at the current frame.

Source

pub fn seek(self, seconds: f64)

Jumps to seconds into the clip, playing or not.

Methods from Deref<Target = Node>§

Source

pub fn id(self) -> NodeId

Index of the node in the scene graph.

Source

pub fn x(self) -> Signal<f64>

The x property as an animatable signal.

Source

pub fn y(self) -> Signal<f64>

The y property as an animatable signal.

Source

pub fn rotation(self) -> Signal<f64>

Degrees, clockwise.

The rotation property as an animatable signal.

Source

pub fn scale(self) -> Signal<Vec2>

The scale property as an animatable signal.

Source

pub fn opacity(self) -> Signal<f64>

The opacity property as an animatable signal.

Source

pub fn fill(self) -> Signal<Color>

The fill property as an animatable signal.

Source

pub fn stroke(self) -> Signal<Color>

The stroke property as an animatable signal.

Source

pub fn line_width(self) -> Signal<f64>

The line_width property as an animatable signal.

Source

pub fn start(self) -> Signal<f64>

Start of the drawn part of the outline (fraction of its length).

The start property as an animatable signal.

Source

pub fn end(self) -> Signal<f64>

End of the drawn part of the outline.

The end property as an animatable signal.

Source

pub fn fill_gradient(self) -> Signal<Option<Gradient>>

The fill_gradient property as an animatable signal.

Source

pub fn stroke_gradient(self) -> Signal<Option<Gradient>>

The stroke_gradient property as an animatable signal.

Source

pub fn dash(self) -> Signal<Vec<f64>>

The dash property as an animatable signal.

Source

pub fn dash_offset(self) -> Signal<f64>

The dash_offset property as an animatable signal.

Source

pub fn line_cap(self) -> Signal<LineCap>

The line_cap property as an animatable signal.

Source

pub fn line_join(self) -> Signal<LineJoin>

The line_join property as an animatable signal.

Source

pub fn blur(self) -> Signal<f64>

The blur property as an animatable signal.

Source

pub fn shadow_color(self) -> Signal<Color>

The shadow_color property as an animatable signal.

Source

pub fn shadow_blur(self) -> Signal<f64>

The shadow_blur property as an animatable signal.

Source

pub fn shadow_offset(self) -> Signal<Vec2>

The shadow_offset property as an animatable signal.

Source

pub fn clip(self) -> Signal<bool>

The clip property as an animatable signal.

Source

pub fn blend(self) -> Signal<BlendMode>

The blend property as an animatable signal.

Source

pub fn z_index(self) -> Signal<f64>

The z_index property as an animatable signal.

Source

pub fn anchor(self) -> Signal<Vec2>

The anchor property as an animatable signal.

Source

pub fn grow(self) -> Signal<f64>

The grow property as an animatable signal.

Source

pub fn shrink(self) -> Signal<f64>

The shrink property as an animatable signal.

Source

pub fn basis(self) -> Signal<Option<f64>>

The basis property as an animatable signal.

Source

pub fn margin(self) -> Signal<f64>

The margin property as an animatable signal.

Source

pub fn align_self(self) -> Signal<Option<LayoutAlign>>

The align_self property as an animatable signal.

Source

pub fn add<B: NodeBuilder>(self, child: B) -> B::Handle

Adds a child node; children are positioned relative to the parent.

The call site is stored on the node (oxframe check and oxframe inspect print it). .name("title") overrides the automatic label.

Source

pub fn remove(self)

Detaches the node from its parent; it stops being drawn.

Source

pub fn fade_in(self) -> Tween<f64> ⓘ

Fades the node in from transparent, over the theme’s normal duration with its enter easing.

Source

pub fn pop_in(self) -> Tween<Vec2> ⓘ

Grows the node from nothing to its current scale with a small overshoot (the theme’s emphasis easing, OUT_BACK by default).

Source

pub fn draw_on(self) -> Tween<f64> ⓘ

Draws the outline from start to end (end from 0 to 1), as if with a pen. Works on every shape with an outline: paths, lines, rectangles, circles, polygons.

Source

pub fn slide_in(self, from: Side) -> impl Future<Output = ()> + 'static

Slides the node into its place from SLIDE_DISTANCE pixels towards from, fading in on the way.

Source

pub fn next_to(self, other: impl Into<Node>, side: Side) -> Self

Sits just outside other. The gap is the theme’s Md step, and the position is recomputed every frame.

Source

pub fn align_to(self, other: impl Into<Node>, edge: Edge) -> Self

Lines this node’s edge up with the same edge of other.

Source

pub fn to_edge(self, edge: Edge) -> Self

Pins one edge to the safe area. The other axis is left as it is.

Source

pub fn center_in(self, other: impl Into<Node>) -> Self

Same center as other.

Source

pub fn fade_out(self) -> Tween<f64> ⓘ

Fades the node out, over the theme’s normal duration with its exit easing.

Source

pub fn reparent(self, parent: impl Into<Node>)

Moves the node under another parent.

Source

pub fn effect(self, effect: EffectBuilder) -> Effect

Runs a shader effect on this node’s pixels, children included.

let ring = card.effect(shaders::ripple().strength(0.0));
ring.strength().to(1.0, 0.6).await;

A node has one effect; a second call replaces the first. The node must not sit inside a group with opacity below 1, a blur, a clip, a blend, a shadow or another effect: there its pixels are not finished, and check reports input_cycle.

Source