Skip to main content

Video

Struct Video 

Source
#[non_exhaustive]
pub struct Video { pub id: Option<WidgetId>, pub source: VideoSource, pub width: Option<f32>, pub height: Option<f32>, pub autoplay: bool, pub loop_playback: bool, pub audio: VideoAudioOptions, }
Expand description

A platform-native video player widget.

The video is rendered by the platform’s native player and embedded into the Fission layout as an opaque surface. Use [crate::internal::BuildCtx::video_controls] to create play/pause/seek action envelopes.

§Example

Video::network("https://example.com/clip.mp4")
    .size(640.0, 360.0)
    .autoplay(true)
    .loop_playback(false)
    .audio(VideoAudioOptions::playback())
    .into();

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: Option<WidgetId>

Stable widget identity (auto-derived from source if None).

§source: VideoSource

Typed video source consumed by the active shell.

§width: Option<f32>

Fixed width in layout points.

§height: Option<f32>

Fixed height in layout points.

§autoplay: bool

Whether to start playing immediately.

§loop_playback: bool

Whether to loop playback when the video ends.

§audio: VideoAudioOptions

Platform-neutral audio-session behavior for this video.

The default is VideoAudioOptions::system_default, which lets the host platform keep its normal audio policy. Use VideoAudioOptions::playback for foreground media playback that should behave like a video player rather than incidental UI audio.

Implementations§

Source§

impl Video

Source

pub fn asset(path: impl Into<String>) -> Self

Creates a video from an app-bundled asset path.

Source

pub fn file(path: impl Into<String>) -> Self

Creates a video from a local filesystem path.

Source

pub fn network(url: impl Into<String>) -> Self

Creates a video from a network URL.

Source

pub fn from_source(source: impl Into<VideoSource>) -> Self

Creates a video from a typed source.

Source

pub fn id(self, id: WidgetId) -> Self

Sets an explicit widget identity.

Source

pub fn width(self, width: f32) -> Self

Sets a fixed width in layout points.

Source

pub fn height(self, height: f32) -> Self

Sets a fixed height in layout points.

Source

pub fn size(self, width: f32, height: f32) -> Self

Sets a fixed width and height in layout points.

Source

pub fn autoplay(self, autoplay: bool) -> Self

Sets whether playback starts automatically.

Source

pub fn loop_playback(self, loop_playback: bool) -> Self

Sets whether playback loops after reaching the end.

Source

pub fn audio(self, audio: VideoAudioOptions) -> Self

Sets platform-neutral audio behavior.

Trait Implementations§

Source§

impl Clone for Video

Source§

fn clone(&self) -> Video

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Video

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Video

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Video

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Video> for Widget

Source§

fn from(w: Video) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Video

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Video

§

impl RefUnwindSafe for Video

§

impl Send for Video

§

impl Sync for Video

§

impl Unpin for Video

§

impl UnsafeUnpin for Video

§

impl UnwindSafe for Video

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WidgetIdExt for T
where T: Into<Widget>,

Source§

fn id<I>(self, id: I) -> Widget
where I: Into<WidgetId>,