# RichMediaAnnotationProperties

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / RichMediaAnnotationProperties

# Type Alias: RichMediaAnnotationProperties

> **RichMediaAnnotationProperties** = [`AnnotationBaseProperties`](AnnotationBaseProperties) & `object`

Defines properties of a rich media annotation.
Rich media annotations provide a common framework for video, audio,
animations and other multimedia presentations.

## Type Declaration

### activationCondition?

> `optional` **activationCondition**: `"XA"` \| `"PO"` \| `"PV"`

The string specifying
the circumstances under which the annotation shall be activated, the valid values:
"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.

### audio?

> `optional` **audio**: [`FileSpecification`](../classes/FileSpecification) \| [`FileSpecificationProperties`](FileSpecificationProperties)

The audio content represented by a [FileSpecification](../classes/FileSpecification) object.
Only one 'video' or 'audio' should be specified, if both specified then 'video' is preffered.

### deactivationCondition?

> `optional` **deactivationCondition**: `"XD"` \| `"PC"` \| `"PI"`

The string specifying
the circumstances under which the annotation shall be deactivated, the valid values:
"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.

### presentationStyle?

> `optional` **presentationStyle**: `"Embedded"` \| `"Windowed"`

The string specifying
the style of presentation of the rich media (embedded or windowed), the valid values:
"Embedded", "Windowed"

### showNavigationPane?

> `optional` **showNavigationPane**: `boolean`

A value indicating 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 be displayed.

### showToolbar?

> `optional` **showToolbar**: `boolean`

Gets or sets the value indicating the default behavior of an interactive toolbar
associated with this annotation.
If "true", the toolbar should be displayed when the annotation is activated and given focus.
If "false", the toolbar should not be displayed.

### type

> **type**: `"richmedia"`

### video?

> `optional` **video**: [`FileSpecification`](../classes/FileSpecification) \| [`FileSpecificationProperties`](FileSpecificationProperties)

The video content represented by a [FileSpecification](../classes/FileSpecification) object.
Only one 'video' or 'audio' should be specified, if both specified then 'video' is preffered.

## See

[RichMediaAnnotation](../classes/RichMediaAnnotation)