Struct VideoDef 

pub struct VideoDef {
    pub id: String,
    pub width: u32,
    pub height: u32,
    pub fps_num: u32,
    pub fps_den: u32,
    pub sizes: Vec<u32>,
    pub packets: Vec<u8>,
    pub keyframes: Vec<u32>,
    pub sound: Option<String>,
    pub volume: f32,
    pub looping: bool,
}

A compiled video (mymod:intro).

Fields

id: String

width: u32

The size it’s shown at, pixels; its decoded frames may be bigger (padded up to the encoder’s least), shown from their top-left.

height: u32

fps_num: u32

Frames a second, as a fraction (num / den).

fps_den: u32

sizes: Vec<u32>

Each frame’s AV1 packet’s size, in order; the packets are packets one after another.

packets: Vec<u8>

keyframes: Vec<u32>

The frames a decoder may start at (ascending; the first is 0).

sound: Option<String>

The sound event played with it (none: it’s silent).

volume: f32

Its sound’s loudness.

looping: bool

It starts again at its end.

Implementations

impl VideoDef

pub fn plan(&self, shown: Option<u32>, target: u32) -> Plan

How to get from showing shown (none yet) to showing target: onward from shown when no keyframe is closer, else from the keyframe before target.

impl VideoDef

pub fn frames(&self) -> u32

How many frames it has.

pub fn frame_seconds(&self) -> f64

Seconds a frame shows.

pub fn seconds(&self) -> f64

How long it lasts, seconds.

pub fn packets(&self) -> impl Iterator<Item = &[u8]>

Each frame’s packet, in order.

pub fn packet(&self, frame: u32) -> Option<&[u8]>

Frame frame’s packet (none past its end).

pub fn keyframe_before(&self, frame: u32) -> u32

The keyframe at or before frame.

Trait Implementations

impl Clone for VideoDef

fn clone(&self) -> VideoDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VideoDef

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

Formats the value using the given formatter.

impl Fields for VideoDef

const FIELDS: &'static [(&'static str, &'static str)]

impl PartialEq for VideoDef

fn eq(&self, other: &VideoDef) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Schema for VideoDef

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(__yog_d: &mut Decoder<'_>) -> Option<VideoDef>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<VideoDef>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<VideoDef>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for VideoDef