public abstract class

MediaAnnotation

extends AssetAnnotation
java.lang.Object
   ↳ com.pspdfkit.annotations.Annotation
     ↳ com.pspdfkit.annotations.LinkAnnotation
       ↳ com.pspdfkit.annotations.AssetAnnotation
         ↳ com.pspdfkit.annotations.MediaAnnotation
Known Direct Subclasses

Class Overview

Abstract annotation class holding a media file asset. Holds shared code between ScreenAnnotation and RichMediaAnnotation.

Summary

[Expand]
Inherited Constants
From class com.pspdfkit.annotations.Annotation
[Expand]
Inherited Fields
From class com.pspdfkit.annotations.Annotation
Public Methods
EnumSet<MediaOptions> getMediaOptions()
Media options flags set.
MediaWindowType getWindowMediaType()
Returns type of the window to be used when playing this media content.
void setMediaOptions(EnumSet<MediaOptions> mediaOptions)
Set media options for this media annotation.
void setWindowMediaType(MediaWindowType mediaWindowType)
Sets type of the window to be used when playing this media content.
[Expand]
Inherited Methods
From class com.pspdfkit.annotations.AssetAnnotation
From class com.pspdfkit.annotations.LinkAnnotation
From class com.pspdfkit.annotations.Annotation
From class java.lang.Object

Public Methods

public EnumSet<MediaOptions> getMediaOptions ()

Media options flags set. Changing returned EnumSet does not change media options flags. Instead call setMediaOptions(EnumSet) to change annotation flags.

Returns
  • Set of annotation flags of empty set if no flags were configured.

public MediaWindowType getWindowMediaType ()

Returns type of the window to be used when playing this media content.

Returns
  • Type of the media window to be used.

public void setMediaOptions (EnumSet<MediaOptions> mediaOptions)

Set media options for this media annotation.

Parameters
mediaOptions Media options flags to be set on the annotation.

public void setWindowMediaType (MediaWindowType mediaWindowType)

Sets type of the window to be used when playing this media content.

Parameters
mediaWindowType Type of the media window to be used.