Struct Player 

pub struct Player<I = RenderedTexture> { /* private fields */ }

Stateful real-time runner holding the last picture drawn. I is FrameRenderer::Image: a RenderedTexture on the GPU or an Arc<CpuImage> on the alpha2_render::CpuRenderer.

Defaults to MissingFramePolicy::HoldPrevious; see Player::with_missing_frame_policy.

Implementations

impl<I> Player<I>

pub fn render_size( &self, project: &EngineProject, ) -> Result<RenderSize, EngineError>

The size frames of project render at, for preparing captions.

Errors

Returns an error when the quality profile cannot size the project.

pub fn new(quality: QualityProfile) -> Result<Self, EngineError>

Creates a player with explicit runtime quality.

Errors

Returns EngineError::InvalidQualityProfile for invalid controls.

pub const fn with_prefetch_frames(self, frames: u32) -> Self

Sets how many future frame boundaries prefetch requests include, clamped to 120.

pub const fn prefetch_frames(&self) -> u32

How many future frame boundaries prefetch requests include.

pub const fn quality(&self) -> QualityProfile

Returns the active quality profile.

pub const fn with_missing_frame_policy(self, policy: MissingFramePolicy) -> Self

Sets what Player::render_at returns while source frames are missing.

MissingFramePolicy::HoldPrevious repeats the last successful texture; MissingFramePolicy::Wait withholds it so the host can show a loading state. The held frame is retained either way.

pub const fn missing_frame_policy(&self) -> MissingFramePolicy

Returns the policy used when source frames are unavailable.

pub fn prefetch_needs( &self, project: &EngineProject, time: MediaTime, ) -> Result<Vec<FrameNeed>, EngineError>

Collects deduplicated decode requests for the current and future frames.

Errors

Returns evaluation or timeline overflow errors.

pub fn render_at<'a, R: FrameRenderer<Image = I> + ?Sized>( &'a mut self, project: &EngineProject, renderer: &R, frames: &dyn FrameProvider, time: MediaTime, ) -> Result<PlaybackFrame<'a, I>, EngineError>

Evaluates and attempts to present the host clock’s current frame.

With inputs missing, the last successful texture is returned with repeated = true under MissingFramePolicy::HoldPrevious and withheld under MissingFramePolicy::Wait. texture is absent before the first success.

A frame whose size, cache key and content epoch match the last returned texture (with every source keyed) is not rendered and returns unchanged = true. Unkeyed sources always render.

Errors

Returns timeline evaluation, quality, or rendering failures, and EngineError::UnregisteredEffect naming an effect the frame draws that renderer has not registered.

pub fn reset(&mut self)

Drops the held frame, for example after a seek or project swap.

Trait Implementations

impl<I: Debug> Debug for Player<I>

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

Formats the value using the given formatter.

impl<I> Default for Player<I>

fn default() -> Self

Returns the “default value” for a type.