Class RichMediaInstance

All Implemented Interfaces:
Serializable

public class RichMediaInstance extends PdfDictionary
The RichMediaInstance dictionary, referenced by the Instances entry of the RichMediaConfiguration, describes a single instance of an asset with settings to populate the artwork of an annotation. See ExtensionLevel 3 p88
Since:
5.0.0
See Also:
  • Field Details

    • flash

      protected boolean flash
      True if the instance is a flash animation.
  • Constructor Details

    • RichMediaInstance

      public RichMediaInstance(PdfName subtype)
      Creates a RichMediaInstance. Also specifies the content type for the instance. Valid values are 3D, Flash, Sound, and Video. The subtype must match the asset file type of the instance.
      Parameters:
      subtype - possible values are: PdfName._3D, PdfName.FLASH, PdfName.SOUND, and PdfName.VIDEO.
  • Method Details

    • setParams

      public void setParams(RichMediaParams params)
      Sets the parameters. This will only work for Flash.
      Parameters:
      params - a RichMediaParams object
    • setAsset

      public void setAsset(PdfIndirectReference asset)
      Sets a dictionary that shall be an indirect object reference to a file specification dictionary that is also referenced in the Assets name tree of the content of the annotation.
      Parameters:
      asset - a reference to a dictionary present in the Assets name tree