Struct ScreenAnnotation 

pub struct ScreenAnnotation {
    pub rect: Rect,
    pub rendition: MediaRendition,
    pub title: Option<String>,
    pub flags: AnnotationFlags,
    pub contents: Option<String>,
    pub appearance: Option<Vec<u8>>,
    pub operation: RenditionOperation,
}

A screen annotation for modern multimedia.

Per PDF spec Section 12.5.6.18, a screen annotation represents a region on a page where media can be played.

Fields

rect: Rect

Bounding rectangle for the media display area

rendition: MediaRendition

Media rendition

title: Option<String>

Annotation title

flags: AnnotationFlags

Annotation flags

contents: Option<String>

Contents/description

appearance: Option<Vec<u8>>

Background appearance stream

operation: RenditionOperation

Rendition operation

Implementations

impl ScreenAnnotation

pub fn new(rect: Rect, rendition: MediaRendition) -> Self

Create a new screen annotation.

Arguments

• rect - Display area for the media
• rendition - Media rendition to play

pub fn from_clip(rect: Rect, clip: MediaClip) -> Self

Create a screen annotation from a media clip.

pub fn video(rect: Rect, filename: impl Into<String>, data: Vec<u8>) -> Self

Create a video annotation.

pub fn audio(rect: Rect, filename: impl Into<String>, data: Vec<u8>) -> Self

Create an audio annotation.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title.

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

Set rendition name.

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

Set volume.

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

Set repeat count (0 = infinite loop).

pub fn with_auto_play(self, auto: bool) -> Self

Set auto-play.

pub fn with_controls(self, show: bool) -> Self

Set whether to show controls.

pub fn with_window_type(self, wtype: WindowType) -> Self

Set window type.

pub fn with_contents(self, contents: impl Into<String>) -> Self

Set description/contents.

pub fn with_flags(self, flags: AnnotationFlags) -> Self

Set annotation flags.

pub fn with_operation(self, op: RenditionOperation) -> Self

Set rendition operation.

pub fn build(&self, _page_refs: &[ObjectRef]) -> HashMap<String, Object>

Build the annotation dictionary for PDF output.

Note: The Rendition and MediaClip must be written separately.

pub fn rendition(&self) -> &MediaRendition

Get the rendition reference.

Trait Implementations

impl Clone for ScreenAnnotation

fn clone(&self) -> ScreenAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenAnnotation

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

Formats the value using the given formatter.

impl From<ScreenAnnotation> for Annotation

fn from(screen: ScreenAnnotation) -> Self

Converts to this type from the input type.