Rich Media Module

Types

	A3DPDFRichMediaAnnotData
	`A3DPDFEPlaybackControlsSkin`

Fields

	`kA3DPDFSkinOverPlay`
	`kA3DPDFSkinOverPlayMute`
	`kA3DPDFSkinOverPlaySeekMute`
	`kA3DPDFSkinOverPlaySeekStop`
	`kA3DPDFSkinOverPlayStopSeekMuteVol`
	`kA3DPDFSkinOverAllNoVolNoCaptionNoFull`
	`kA3DPDFSkinOverAllNoFullNoCaption`

Functions

`A3DStatus`	`A3DPDFRichMediaAnnotCreateFromFile`
`A3DStatus`	`A3DPDFPageInsertRichMediaAnnot`

Detailed Description

group a3d_pdf_richmediaannot_module

Adds rich media (video, sound) in the page.

This module describes the functions and structures that allow you to add rich medias in the page. A rich media is a video or a sound. Supported file formats for video are : QuickTime Movie (.mov) ; MPEG (.mp4, .m4v) ; 3GPP Movie (.3gp, .3g2) Different skins can be selected to control the video player. Supported file formats for audio are : mp3

Type Documentation

enum A3DPDFEPlaybackControlsSkin

Type of skins for playback controls of rich media annot.

Version: 12.2

Values:

enumerator kA3DPDFSkinOverPlay: Play

enumerator kA3DPDFSkinOverPlayMute: PlayMute

enumerator kA3DPDFSkinOverPlaySeekMute: PlaySeekMute

enumerator kA3DPDFSkinOverPlaySeekStop: PlaySeekStop

enumerator kA3DPDFSkinOverPlayStopSeekMuteVol: PlayStopSeekMuteVol

enumerator kA3DPDFSkinOverAllNoVolNoCaptionNoFull: AllNoVolNoCaptionNoFull

enumerator kA3DPDFSkinOverAllNoFullNoCaption: AllNoFullNoCaption

Function Documentation

A3DStatus A3DPDFRichMediaAnnotCreateFromFile(A3DPDFDocument *pDoc, const A3DPDFRichMediaAnnotData *pRichMediaAnnotData, const A3DUTF8Char *pcFileName, A3DPDFRichMediaAnnot **ppRichMediaAnnot)

Function to create a RichMedia Annotation object.

The RichMedia Annotation object is primarily created with this function, and it should be inserted on the page with the functions A3DPDFPageInsertRichMediaAnnot.

Version: 12.2

Parameters

pDoc – [inout] The Document object to work with.
pRichMediaAnnotData – [in] The RichMedia Annot parameters.
pcFileName – [in] The file name of the rich media input file. The file format is deducted from file extension. Supported file formats for video are : QuickTime Movie (.mov) ; MPEG (.mp4, .m4v) ; 3GPP Movie (.3gp, .3g2). Supported file formats for audio are : mp3
ppRichMediaAnnot – [out] The RichMedia Annot object created.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPDFPageInsertRichMediaAnnot(A3DPDFPage *pPage, const A3DPDFRichMediaAnnot *pRichMediaAnnot, const A3DPDFRectData *pRectData)

Function to insert a RichMedia Annot in a page.

Insert a RichMedia Annot object on the page. Several RichMedia Annots can be stored on a page.

Version: 12.2

Parameters

pPage – [inout] The Page object to work with.
pRichMediaAnnot – [in] The RichMedia Annot to insert on the page.
pRectData – [in] The rectangle to specify the position on the page.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code