Struct MediaRendition 

pub struct MediaRendition {
    pub clip: MediaClip,
    pub play_params: MediaPlayParams,
    pub name: Option<String>,
}

Media rendition for Screen annotations.

Per PDF spec Section 13.2.3, a rendition describes how to present media.

Fields

clip: MediaClip

Media clip

play_params: MediaPlayParams

Play parameters

name: Option<String>

Rendition name

Implementations

impl MediaRendition

pub fn new(clip: MediaClip) -> Self

Create a new media rendition.

pub fn with_name(self, name: impl Into<String>) -> Self

Set rendition name.

pub fn with_play_params(self, params: MediaPlayParams) -> Self

Set play parameters.

pub fn with_volume(self, volume: f32) -> Self

Set volume.

pub fn with_repeat(self, count: u32) -> Self

Set repeat count.

pub fn build(&self, clip_ref: Option<ObjectRef>) -> HashMap<String, Object>

Build the Rendition dictionary.

Note: The MediaClip must be written separately and referenced.

pub fn clip(&self) -> &MediaClip

Get the media clip reference.

Trait Implementations

impl Clone for MediaRendition

fn clone(&self) -> MediaRendition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaRendition

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

Formats the value using the given formatter.