Repository navigation
PDF20 Spec 13 Rich Media
Part of: PDF20-Spec-13-Multimedia
Navigation: PDF20-Spec-13-3D | PDF20-Spec-Index | Next →
13.7 Rich media 13.7.1
General
PDF 2.0 introduces rich media annotations providing a common framework for video, audio, animations and other multimedia presentations. For the allowed instances of rich media see "Table 342 — Entries in a RichMediaConfiguration dictionary". The framework includes general controls most of which are commonly needed to stage, present and control an animation, video or other interactive presentation. Such features as: when to activate and deactivate the presentation, supplying scripts that control the presentation, setting viewing parameters such as lighting and camera angles (e.g., for 3D interactive presentations), setting animation parameters such as speed and looping behaviour, supplying assets including the base video, audio and animations files as well as any necessary auxiliary files (e.g., scripts), determining how the rich media annotation relates to the page display (e.g., within a fixed rectangle on the page, or having its own window), and details determining configuration of toolbars, navigation and other controls. Not all of these common framework features are appropriate for all rich media types and selected media types have additional features defined specific to that type. The details for the framework and specific controls are given in the following subclauses.
13.7.2
RichMedia annotations
13.7.2.1
General
The annotation subtype RichMedia shares many low-level structural similarities with the 3D Artwork defined in 13.6, "3D Artwork". At the top level, the rich media annotation has two primary custom structures. The RichMediaSettings dictionary is unique to each annotation, while the RichMediaContent dictionary can be shared across rich-media annotations. The rich media annotation may contain any of the entries of an annotation dictionary (see 12.5.2, "Annotation dictionaries"). "Table 333 — Additional entries specific to a RichMedia annotation" shows the additional annotation entries specific to this type of annotation. Table 333 — Additional entries specific to a RichMedia annotation Key
Type
Value
Subtype
name
(Required; PDF 2.0) The type of annotation that the dictionary describes. The name shall be RichMedia for a rich media annotation.
RichMediaContent
dictionary (Required; PDF 2.0) A RichMediaContent dictionary that stores the rich media artwork and information as to how it should be configured and viewed. See "Table 341 — Entries in a RichMediaContent dictionary".
700
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
Key
Type
Value
RichMediaSettings
dictionary (Optional; PDF 2.0) A RichMediaSettings dictionary that stores conditions and responses that determine when the annotation should be activated and deactivated by an interactive PDF processor and the initial state of artwork in those states. See "Table 334 — Entries in a RichMediaSettings dictionary". Default value: If no RichMediaSettings dictionary is present, the first configuration is loaded.
In addition to these entries, a RichMedia annotation shall provide an appearance stream in its AP entry (see "Table 166 — Entries common to all annotation dictionaries ") that has a normal appearance (the N entry in "Table 170 — Entries in an appearance dictionary"). This appearance may be used by applications that do not support RichMedia annotations and by all applications for the initial display of the annotation As with 3D annotations defined in 13.6.2, "3D Annotations", RichMedia annotations can be in one of two states: •
Inactive: (the default initial state) The annotation displays the normal appearance of the annotation.
NOTE
•
Typically, the normal appearance is a 2D bitmap portraying a rendering of the default view of the artwork within the RichMedia annotation.
Active: The annotation displays a rendering of the artwork. This rendering is specified by the annotation’s RichMediaSettings entry. (See "Table 334 — Entries in a RichMediaSettings dictionary".)
The subsequent clauses describe the structural components of a rich media annotation, beginning with the RichMediaSettings dictionary and its subcomponents, followed by the RichMediaContent dictionary, and its subcomponents. See Example 3 for a detailed and comprehensive example of a rich media annotation.
13.7.2.2
RichMediaSettings dictionary
13.7.2.2.1
General
The RichMediaSettings dictionary has a purpose similar to that of the 3D activation dictionary ("Table 310 — Entries in a 3D activation dictionary") with the 3D Annotation described in 13.6.2, "3D Annotations". The RichMediaSettings dictionary stores the conditions and responses that occur in response to certain events, such as activation and deactivation of the annotation, and contains two dictionaries. "Table 334 — Entries in a RichMediaSettings dictionary" gives the details of the content of this dictionary. Table 334 — Entries in a RichMediaSettings dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, shall be RichMediaSettings.
© ISO 2020 – All rights reserved
701
ISO 32000-2:2020(E)
Key
Type
Activation
dictionary (Optional; PDF 2.0) A RichMediaActivation dictionary (see "Table 335 — Entries in a RichMediaActivation dictionary") that specifies the style of presentation, default script behavior, default view information, and animation style when the annotation is activated.
Deactivation
dictionary (Optional; PDF 2.0) A RichMediaDeactivation dictionary (see "Table 336 — Entries in a RichMediaDeactivation dictionary") that specifies the condition and type of unloading (restart or pause) that occurs during deactivation.
13.7.2.2.2
Value
RichMediaActivation dictionary
The RichMediaActivation dictionary specifies the style of presentation, default script behavior, default view information, and animation style when the annotation is activated. "Table 335 — Entries in a RichMediaActivation dictionary" details the contents of the dictionary. The activation dictionary includes a script array. Each element contains an indirect object reference to file specification objects that are also referenced by the Assets name tree of the RichMediaContent dictionary. When the annotation is activated, each script in the array shall be executed in order in a common environment per annotation by the rich media run time ECMAScript interpreter. There may be an optional reference to a view in the scene’s Views array (see "Table 341 — Entries in a RichMediaContent dictionary") that acts as the default view for the annotation. If not specified, the first view in the views array shall be used. If there are no views specified, default values shall be used for all camera and display parameters. Table 335 — Entries in a RichMediaActivation dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, shall be RichMediaActivation.
Condition
name
(Optional; PDF 2.0) A name that shall specify the circumstances under which the annotation shall be activated. The following values are valid: XA the annotation is explicitly activated by a user action or script. PO the annotation is activated as soon as the page that contains the annotation receives focus as the current page. PV the annotation is activated as soon as any part of the page that contains the annotation becomes visible. NOTE
One example is in a multiple-page presentation. Only one page is the current page although several are visible.
Default value: XA. Animation
702
dictionary (Optional; PDF 2.0) A RichMediaAnimation dictionary (see "Table 337 — Entries in a RichMediaAnimation dictionary") that describes the preferred method that interactive PDF processor should use to drive keyframe animations present in this artwork.
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
Key
Type
Value
View
dictionary (Optional; PDF 2.0) An indirect object reference to a 3D view dictionary (see "Table 315 — Entries in a 3D view dictionary" that shall also be referenced by the Views array within the annotation’s RichMediaContent dictionary (see "Table 341 — Entries in a RichMediaContent dictionary"). Default value: The first element in the Views array of the annotation specified in the RichMediaContent dictionary. If a Views array does not exist, default values for the components of a 3D view dictionary (see "Table 344 — Additional entries in a 3D view dictionary") are used.
Configuration dictionary (Optional; PDF 2.0) An indirect object reference to a RichMediaConfiguration dictionary (see "Table 342 — Entries in a RichMediaConfiguration dictionary") that shall also be referenced by the Configurations array in the RichMediaContent dictionary (see "Table 341 — Entries in a RichMediaContent dictionary"). Default value: The first element within the Configurations array specified in the RichMediaContent dictionary. Presentation
dictionary (Optional; PDF 2.0) A RichMediaPresentation dictionary (see "Table 338 — Entries in a RichMediaPresentation dictionary") that contains information as to how the annotation and user interface elements will be visually laid out and drawn.
13.7.2.2.3
RichMediaDeactivation dictionary
The second component of the RichMediaSettings dictionary is the RichMediaDeactivation dictionary, which specifies the condition that causes deactivation of the annotation. Table 336 — Entries in a RichMediaDeactivation dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, shall be RichMediaDeactivation.
Condition
name
(Optional; PDF 2.0) A name specifying the circumstances under which the annotation shall be deactivated. The following values are valid: XD the annotation is explicitly deactivated by a user action or script. PC the annotation is deactivated as soon as the page that contains the annotation loses focus as the current page. PI the annotation is deactivated as soon as the entire page that contains the annotation is no longer visible. Default value: XD.
13.7.2.2.4
RichMediaAnimation dictionary
A RichMediaAnimation dictionary specifies the preferred method that interactive PDF processors should use to apply timeline scaling to keyframe animations. It can also specify that keyframe animations be played repeatedly. The Animation entry of the RichMediaActivation dictionary ("Table 335 — Entries in a RichMediaActivation dictionary") can specify a RichMediaAnimation dictionary.
© ISO 2020 – All rights reserved
703
ISO 32000-2:2020(E)
A keyframe animation can be provided as part of 3D model content. "Table 337 — Entries in a RichMediaAnimation dictionary" shows the entries in a RichMediaAnimation dictionary. NOTE
Keyframe animation is an interactive feature that is highly dependent on the behaviour and controls provided by the interactive PDF processor.
Table 337 — Entries in a RichMediaAnimation dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, the type shall be RichMediaAnimation.
Subtype
name
(Optional; PDF 2.0) The animation style described by this dictionary. Valid values are None, Linear, and Oscillating. See "Table 313 — Animation styles" for descriptions of these animation styles. If an animation style is encountered other than those described, an animation style of None shall be used. Default value: None
PlayCount integer
(Optional; PDF 2.0) An integer specifying the play count for this animation style. A nonnegative integer shall represent the number of times the animation is played. A negative integer shall indicate that the animation is infinitely repeated. This value shall be ignored for an animation subtype of type None. Default value: -1
Speed
number (Optional; PDF 2.0) A positive number specifying the speed that shall be used when running the animation. A value greater than one shall shorten the time it takes to play the animation, or effectively speed up the animation. NOTE
This allows authors to change the desired speed of animations without reauthoring the content.
This value shall be ignored for an animation subtype of type None. Default value: 1 EXAMPLE
A RichMediaSettings dictionary
20 0 obj <</Type /RichMediaSettings /Activation <</Type /RichMediaActivation /Condition /XA /Configuration 14 0 R /View 19 0 R /Animation <</Type /RichMediaAnimation /Subtype /Linear /Speed 1 /PlayCount -1
/Presentation 21 0 R /Scripts [32 0 R 33 0 R]
/Deactivation <</Type /RichMediaDeactivation /Condition /XD
704
%RichMediaSettings dictionary
%RichMediaActivation Dictionary %Reference to element in Configurations array %Reference to element in Views array %RichMediaAnimation dictionary
%References to scripts in Resources name tree %RichMediaDeactivation dictionary
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
endobj
13.7.2.2.5
RichMediaPresentation dictionary
The RichMediaPresentation dictionary contains information about how the annotation and user interface elements should be visually laid out and drawn by an interactive PDF processor. The visibility of the Toolbar is specified, and it will only take effect if the RichMediaConfiguration subtype is 3D. (See "Table 342 — Entries in a RichMediaConfiguration dictionary") User interface items such as a navigation panes and toolbars can be displayed or hidden by default. Such user interface elements may only be implemented by those interactive PDF processors where it is appropriate to do so. NOTE
The navigation pane is a user interface item that would be used to display the hierarchical relationship of entities within the artwork. (See 13.6.2, "3D Annotations".)
The Style of the annotation can be presented Embedded within the PDF page or separately Windowed. If a Windowed state is chosen, the default dimensions and position of the window may be given. "Table 338 — Entries in a RichMediaPresentation dictionary" contains a description of each element. Table 338 — Entries in a RichMediaPresentation dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, shall be RichMediaPresentation.
Style
name
(Optional; PDF 2.0) The style of presentation of the rich media. The value can be Embedded or Windowed. A interactive PDF processor shall support the state Embedded. Default value: Embedded
Window
dictionary
(Optional; PDF 2.0) A RichMediaWindow Dictionary that describes the size and position of the floating user interface window when the value for Style is set to Windowed. See "Table 339 — Entries in a RichMediaWindow dictionary" for a detailed description.
Transparent
boolean
(Optional; PDF 2.0) A flag that indicates whether the page content shall be displayed through the transparent areas of the rich media content (where the alpha value is less than 1.0). If true, the rich media artwork shall be composited over the page content using an alpha channel. If false, the rich media artwork shall be drawn over an opaque background prior to composition over the page content. Default value: false
NavigationPane
boolean
(Optional; PDF 2.0) A flag that indicates the default behavior of a navigation pane user interface element. If true, the navigation pane should be visible when the content is initially activated. If false, the navigation pane should not displayed by default. Default value: false
© ISO 2020 – All rights reserved
705
ISO 32000-2:2020(E)
Key
Type
Value
Toolbar
boolean
(Optional; PDF 2.0) A flag that indicates the default behavior of an interactive toolbar associated with this annotation. If true, a toolbar should be displayed when the annotation is activated and given focus. If false, a toolbar should not displayed by default. The toolbar should be positioned in proximity to the annotation. Default value: true for content of Subtype 3D, and false otherwise.
PassContextClick boolean
(Optional; PDF 2.0) A flag that indicates whether a contextual click on the rich media annotation is passed to the media player run time or shall be handled natively by the interactive PDF processor. NOTE
A context click is usually generated by a mouse right-click although it can be invoked by other means. This can include, but is not limited to, an explicit context-menu keyboard key or the combination of a mouse click and a keyboard modifier key.
If false, the interactive PDF processor shall handle the context click. If true, the interactive PDF processor shall allow the media runtime to provide any user interface it wishes. Default value: false
13.7.2.2.6
RichMediaWindow dictionary
The RichMediaWindow dictionary stores the dimensions and position of the floating window that an interactive PDF processor may present. It is used only if Style (see "Table 339 — Entries in a RichMediaWindow dictionary") is set to Windowed. The window described is a non-printing user interface element. An interactive PDF processor that supports Windowed styles shall constrain the window extent to be within the presentation area of the interactive PDF processor. All coordinates shall be expressed in default user space units although do not rotate or scale the window to match the orientation and magnification of the page. The expected behavior of the interactive PDF processor is similar to how it presents an annotation when the flags NoZoom and NoRotate are set to true. (See 12.5.3, "Annotation flags".) "Table 339 — Entries in a RichMediaWindow dictionary" details the contents of this dictionary. Table 339 — Entries in a RichMediaWindow dictionary
706
Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, shall be RichMediaWindow.
Width
dictionary
(Optional; PDF 2.0) A dictionary with keys Default, Max, and Min describing values for the width of the Window in default user space units. Default values: Default shall be 288, Max shall be 576, and Min shall be 72
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
Key
Type
Value
Height
dictionary
(Optional; PDF 2.0) A dictionary with keys Default, Max, and Min describing values for the width of the Window in default user space units. Default values: Default shall be 216, Max shall be 432, and Min shall be 72
Position dictionary
(Optional; PDF 2.0) A RichMediaPosition dictionary describing the position of the RichMediaWindow. See "Table 340 — Entries in a RichMediaPosition dictionary" for a detailed description.
The position of the window in the interactive PDF processor presentation area is described by the RichMediaPosition dictionary. The position of the window shall remain fixed, regardless of the page translation. "Table 340 — Entries in a RichMediaPosition dictionary" details the contents of this dictionary. Table 340 — Entries in a RichMediaPosition dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, it shall be RichMediaPosition.
HAlign
name
(Optional; PDF 2.0) Describes the horizontal alignment. Valid values are Near, Center, and Far. Default value: Far
VAlign
name
(Optional; PDF 2.0) Describes the vertical alignment. Valid values are Near, Center, and Far. Default value: Near
HOffset
number
(Optional; PDF 2.0) The offset from the alignment point specified by the HAlign key. A positive value for HOffset, when HAlign is either Near or Center, shall offset the position towards the Far direction. A positive value for HOffset, when HAlign is Far, shall offset the position towards the Near direction. Default value: 18
VOffset
number
(Optional; PDF 2.0) The offset from the alignment point specified by the VAlign key. A positive value for VOffset, when VAlign is either Near or Center, shall offset the position towards the Far direction. A positive value for VOffset, when VAlign is Far, shall offset the position towards the Near direction. Default value: 18
The descriptions of the values of the HAlign and VAlign entries depend on the primary logical content order as defined by the value of the Lang entry in the document's catalog dictionary. For left-to-right reading languages, the descriptions follow. HAlign: Near represents the left edge of the window, and Far represents the right edge of the window. VAlign: Near represents the top edge of the window, and Far represents the bottom edge of the window. © ISO 2020 – All rights reserved
707
ISO 32000-2:2020(E)
For right-to-left reading languages, the above descriptions for HAlign are reversed. EXAMPLE
A RichMediaPresentation Dictionary
24 0 obj <</Type /RichMediaPresentation /Toolbar false /NavigationPane false /PassContextClick false /Style /Windowed /Window 25 0 R
endobj
%RichMediaPresentation dictionary
25 0 obj <</Type /RichMediaWindow /Height <</Default 216 /Max 432 /Min 72
/Width <</Default 288 /Max 576 /Min 72
/Position <</Type /RichMediaPosition /HAlign /Far /VAlign /Near /HOffset 18 /VOffset 18
endobj
%RichMediaWindow dictionary
%RichMediaPosition dictionary
In the above example, the toolbar or the navigation pane shall not be displayed on initial activation of the annotation. Context click events shall be handled by the interactive PDF processor and shall not be passed to the annotation handler. The annotation appears as a separate window with an initial width of four inches and an initial height of three inches and will be aligned 0.25 inches off the top right (in left to right reading languages) corner of the document area.
13.7.2.3
RichMediaContent dictionary
13.7.2.3.1
General
The RichMediaContent dictionary contains content that is present within the annotation as referenced by the RichMediaSettings dictionary (see "Table 334 — Entries in a RichMediaSettings dictionary"). "Table 341 — Entries in a RichMediaContent dictionary" details the elements of the RichMediaContent dictionary. Table 341 — Entries in a RichMediaContent dictionary
708
Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, it shall be RichMediaContent.
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
Key
Type
Assets
name tree (Optional; PDF 2.0) A name tree of embedded file specification dictionaries as detailed in 7.11.3, "File specification dictionaries".
Configurations
array
(Optional; PDF 2.0) An array where each element is an indirect object reference to a RichMediaConfiguration dictionary.
Views
array
(Optional; PDF 2.0) An array where each element is an indirect object reference to a 3D view dictionary. See "Table 315 — Entries in a 3D view dictionary" for the details of the entries of this dictionary. Default value: If no views are specified, default values shall be used for the components of a view dictionary, including rendering/lighting modes, background colour, and camera data.
13.7.2.3.2
Value
The assets name tree
The Assets entry takes a name tree of embedded file specification dictionaries. (For usage, see "Table 341 — Entries in a RichMediaContent dictionary" and "Table 343 — Entries in a RichMediaInstance dictionary".) The text string that represents the file name in the name tree shall match the values stored for both the F and UF keys, which shall be the same value. The file name shall be encoded as a relative URI and has the following naming restrictions: •
The string shall be a PDF text string.
•
The string shall not contain any embedded NULL (U+0000) characters.
•
The number of characters in the string shall be between 1 and 255 inclusive.
•
The string shall not contain any of these six characters: COLON (U+003A) (:), ASTERISK (U+002A) (*), QUOTATION MARK (U+0022) ("), LESS-THAN SIGN (U+003C) (<), GREATER-THAN SIGN (U+003E) (>), and VERTICAL LINE (U+007C) (|).
•
The last character shall not be a FULL STOP (U+002E) (.).
EXAMPLE
Assets name tree
29 0 obj % Assets name tree << /Names [(3D.prc) 30 0 R … more name value pairs where each value is a file specification dictionary reference … ]
endobj 30 0 obj <</Type /Filespec /F (3D.prc) /UF (3D.prc) /EF <</F 40 0 R>>
endobj
% File specification dictionary for 3D file
40 0 obj << /Type /EmbeddedFile /Length …
% Embedded file stream for 3D file % 3D.prc
© ISO 2020 – All rights reserved
% Stream containing the 3D file
709
ISO 32000-2:2020(E)
/Filter …
stream … Data for 3D.prc … endstream endobj
13.7.2.3.3
RichMediaConfiguration dictionary
The RichMediaConfiguration dictionary describes a set of instances that are loaded for a given scene configuration. The configuration that shall be loaded when an annotation is activated is referenced by the Configuration key in the RichMediaActivation dictionary specified in the RichMediaSettings dictionary. "Table 342 — Entries in a RichMediaConfiguration dictionary" details the elements of the RichMediaConfiguration dictionary. Table 342 — Entries in a RichMediaConfiguration dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, it shall be RichMediaConfiguration.
Subtype
name
(Optional; PDF 2.0) A name specifying the primary content type for the configuration. Valid values are 3D, Sound, and Video. Default value: If no value is specified, the run time shall determines the scene type by referring to the type of asset file specified by the first element in the Instances array.
Name
text string
(Optional; PDF 2.0) A unique name for the configuration.
Instances
array
(Optional; PDF 2.0) An array of indirect object references to RichMediaInstance dictionaries. (See "Table 343 — Entries in a RichMediaInstance dictionary".)
A RichMediaConfiguration may be an aggregate of several RichMediaInstance dictionaries with different values for subtype. The Subtype entry helps to describe the behavior for the collection of those RichMediaInstance dictionaries. Setting the Subtype suggests the author’s intended use of the assets, which better informs the choices when presenting content-specific user interfaces during the authoring or editing process.
13.7.2.3.4
RichMediaInstance dictionary
The RichMediaInstance dictionary, referenced by the Instances entry of the RichMediaConfiguration dictionary ("Table 342 — Entries in a RichMediaConfiguration dictionary"), describes a single instance of an asset with settings to populate the artwork of an annotation, as described in "Table 343 — Entries in a RichMediaInstance dictionary".
710
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
Table 343 — Entries in a RichMediaInstance dictionary Key
Type
Value
Type
name
(Optional; PDF 2.0) The type of PDF object that this dictionary describes. If present, it shall be RichMediaInstance.
Subtype
name
(Required; PDF 2.0) A name specifying the content type for the instance. Valid values are 3D, Sound, and Video. The subtype shall match the asset file type of the instance.
Asset
dictionary
(Required; PDF 2.0) A dictionary that shall be an indirect object reference to a file specification dictionary that is also referenced in the Assets name tree specified in the RichMediaContent dictionary of the annotation.
EXAMPLE 1
RichMediaInstance dictionaries
15 0 obj %RichMediaInstances array [16 0 R … more references to RichMediaInstance dictionaries … ] endobj 16 0 obj <</Type /RichMediaInstance /Subtype /3D /Asset 30 0 R
endobj
13.7.2.3.5
%RichMediaInstance dictionary
%Reference to 3D filespec in Assets
View dictionary
View dictionaries specify a unique view of the artwork that may be used when the annotation is activated or selected. A View dictionary entry in a rich media annotation contains a superset of the information present in a 3D view (3DV) dictionary as specified in "Table 315 — Entries in a 3D view dictionary". "Table 344 — Additional entries in a 3D view dictionary" describes the entries in addition to those present within a 3D view dictionary. Table 344 — Additional entries in a 3D view dictionary Key
Type
Value
Snapshot
stream
(Optional; PDF 2.0) A stream that shall contains an image XObject (see 8.9, "Images") to be displayed when the view is invoked. Default value: No image shall be used, the currently active rich media content is displayed.
Params
array
(Optional; PDF 2.0) An array containing View Params dictionaries (see 13.7.2.3.6, "View params dictionary"). Default value: an empty array. NOTE
© ISO 2020 – All rights reserved
(2020) The Params key was accidently omitted from earlier PDF 2.0 specifications and was reinstated in this document.
711
ISO 32000-2:2020(E)
If the Snapshot entry exists, the image it describes shall be displayed in place of the current artwork. Because the snapshot image should be integrated by the player with other elements, such as user interface controls for video playback, the colour space of the image may be modified by the interactive PDF processor.
13.7.2.3.6
View params dictionary
13.7.2.3.6.1 General The View Params dictionary provides a reference to a RichMediaInstance dictionary within the Instances array, and additional Data that is passed to the instance. This data may be formatted to serve the individual purpose of the content being referenced. Table 345 — Entries in a View Params dictionary Key
Type
Value
Instance
dictionary (Required; PDF 2.0) A dictionary that shall be an indirect object reference to a RichMediaInstance dictionary that is also present in the Instances array of the annotation.
Data
text string (Required; PDF 2.0) A text string or stream containing state data that or stream shall be passed to the instance when the view is triggered.
The Data entry ("Table 345 — Entries in a View Params dictionary") is used to store and load opaque data specific to the Instance referenced in the same dictionary when a View is activated. NOTE
This system allows content-specific state information to be stored when a view is created, such as during a comment or drawing markup.
13.7.2.3.6.2 Saving state data When the View is created, the run time shall iterate through all active instances for the current configuration and query them for state data. For 3D content, an ECMAScript StateEvent is invoked with the type property set to the value save. After the event is handled, the value for the data property, if it is present and can be interpreted as a string, shall be stored as the value for Data.
13.7.2.3.6.3 Loading state data When the View is activated, the run time shall iterate through each View Params dictionary and load the state data for each instance referenced. For 3D content, an ECMAScript StateEvent is invoked with the type property set to the value load and the data property set to the value stored for Data.
712
© ISO 2020 – All rights reserved
ISO 32000-2:2020(E)
14
Navigation: PDF20-Spec-13-3D | PDF20-Spec-Index | Next →