Skip to main content

PlayerState

Struct PlayerState 

Source
pub struct PlayerState { /* private fields */ }
Expand description

The persistant state for the video player. This must be created on the UI thread and persist across frames.

Implementations§

Source§

impl PlayerState

Source

pub fn colormatrix(&self) -> Result<Option<Rc<str>>, BackendError>

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn container_fps(&self) -> Result<Option<f64>, BackendError>

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn current_demuxer(&self) -> Result<Option<Rc<str>>, BackendError>

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn file_format(&self) -> Result<Option<Rc<str>>, BackendError>

Get the file format of the currently loaded media.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn filename(&self) -> Result<Option<Rc<str>>, BackendError>

Get the filename of the currently loaded media.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn hwdec_current(&self) -> Result<Option<Rc<str>>, BackendError>

Get which hardware decoder is being used, if any.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn media_title(&self) -> Result<Option<Rc<str>>, BackendError>

Get the title of the current media.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn muted(&self) -> Result<bool, BackendError>

Get whether playback is muted.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn video_codec(&self) -> Result<Option<Rc<str>>, BackendError>

Get the codec of the current video.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn video_format(&self) -> Result<Option<Rc<str>>, BackendError>

Get the format of the current video.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn volume(&self) -> Result<f64, BackendError>

Get the current playback volume

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn paused(&self) -> Result<bool, BackendError>

Get whether playback is paused.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn duration(&self) -> Result<Option<f64>, BackendError>

Get the total duration of the current video in seconds.

§Errors

This function returns Ok(None) if the property is unavailable, and returns an Err(_) if a libmpv error occured.

Source

pub fn dimensions(&self) -> Result<Option<(i64, i64)>, BackendError>

Get the dimensions of the loaded video.

Upon success, this function returns Ok(Some(width, height)).

§Errors

If the dimensions are unavailable, it returns Ok(None). An Err(_) is returned in the event of a BackendError.

Source

pub fn aspect_ratio(&self) -> Result<Option<f64>, BackendError>

Get the aspect ratio of the loaded video.

§Errors

If the dimensions are unavailable, it returns Ok(None). An Err(_) is returned in the event of a BackendError.

Source

pub fn new(cc: &CreationContext<'_>) -> Result<Self, BackendError>

Create a new PlayerState using an eframe::CreationContext.

§Panics

This function should never panic. If it does, this is a bug.

§Errors

An Err(_) is returned if there was an issue initializing the libmpv backend.

Source

pub fn load_file(&self, path: impl AsRef<str>) -> Result<(), BackendError>

Load the file at path.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn toggle_pause(&self) -> Result<(), BackendError>

Toggle playback status.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn play(&self) -> Result<(), BackendError>

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn pause(&self) -> Result<(), BackendError>

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn toggle_mute(&self) -> Result<(), BackendError>

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn set_volume(&self, volume: f64) -> Result<(), BackendError>

Set the playback volume as a percentage in the range 0.0..=100.0.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn time_pos(&self) -> Result<Option<f64>, BackendError>

Get the current playback position in seconds.

§Errors

This function returns Ok(None) if the time-pos property is unavailable. An Err(_) is returned in the event of a BackendError.

Source

pub fn seek_to(&self, seconds: f64) -> Result<(), BackendError>

Seek to an exact timestamp in the video.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn seek_relative(&self, seconds: f64) -> Result<(), BackendError>

Seek to an offset relative to the current position.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn frame_drop_count(&self) -> Result<Option<i64>, BackendError>

Get the frame drop count.

§Errors

An Err(_) is returned in the event of a BackendError.

Source

pub fn destroy_gl_resources(&mut self)

Call this in your app’s App::on_exit implementation to clean up OpenGL resources.

struct App {
    player: PlayerState,
}

impl eframe::App for App {
    fn on_exit(&mut self, _gl: Option<&eframe::glow::Context>) {
        self.player.destroy_gl_resources();
    }
    // ...
}

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more