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

Data Structures

struct  A3DPDFRichMediaAnnotData
 A3DPDFRichMediaAnnotData structure: options for the RichMedia annot behavior in the PDF. More...
 

Enumerations

enum  A3DPDFEPlaybackControlsSkin {
  kA3DPDFSkinOverPlay = 0,
  kA3DPDFSkinOverPlayMute,
  kA3DPDFSkinOverPlaySeekMute,
  kA3DPDFSkinOverPlaySeekStop,
  kA3DPDFSkinOverPlayStopSeekMuteVol,
  kA3DPDFSkinOverAllNoVolNoCaptionNoFull,
  kA3DPDFSkinOverAllNoFullNoCaption
}
 Type of skins for playback controls of rich media annot. More...
 

Functions

A3DStatus A3DPDFPageInsertRichMediaAnnot (A3DPDFPage *pPage, const A3DPDFRichMediaAnnot *pRichMediaAnnot, const A3DPDFRectData *pRectData)
 Function to insert a RichMedia Annot in a page. More...
 
A3DStatus A3DPDFRichMediaAnnotCreateFromFile (A3DPDFDocument *pDoc, const A3DPDFRichMediaAnnotData *pRichMediaAnnotData, const A3DUTF8Char *pcFileName, A3DPDFRichMediaAnnot **ppRichMediaAnnot)
 Function to create a RichMedia Annotation object. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ A3DPDFEPlaybackControlsSkin

Type of skins for playback controls of rich media annot.

Version
12.2
Enumerator
kA3DPDFSkinOverPlay 

Play

kA3DPDFSkinOverPlayMute 

PlayMute

kA3DPDFSkinOverPlaySeekMute 

PlaySeekMute

kA3DPDFSkinOverPlaySeekStop 

PlaySeekStop

kA3DPDFSkinOverPlayStopSeekMuteVol 

PlayStopSeekMuteVol

kA3DPDFSkinOverAllNoVolNoCaptionNoFull 

AllNoVolNoCaptionNoFull

kA3DPDFSkinOverAllNoFullNoCaption 

AllNoFullNoCaption

Function Documentation

◆ A3DPDFRichMediaAnnotCreateFromFile()

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.

Parameters
[in,out]pDocThe Document object to work with.
[in]pRichMediaAnnotDataThe RichMedia Annot parameters.
[in]pcFileNameThe 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
[out]ppRichMediaAnnotThe RichMedia Annot object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
12.2

◆ A3DPDFPageInsertRichMediaAnnot()

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.

Parameters
[in,out]pPageThe Page object to work with.
[in]pRichMediaAnnotThe RichMedia Annot to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
12.2