org.pdfclown.documents.multimedia.MediaClipData Class Reference

Media clip data [PDF:1.7:9.1.3]. More...

Inheritance diagram for org.pdfclown.documents.multimedia.MediaClipData:

List of all members.

Classes
class	Viability
	Media clip data viability. More...
Public Types
enum	TempFilePermissionEnum { Never, ContentExtraction, Accessibility, Always }
	Circumstance under which it is acceptable to write a temporary file in order to play a media clip. More...
Public Member Functions
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
	MediaClipData (PdfObjectWrapper data, string mimeType)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static MediaClip	Wrap (PdfDirectObject baseObject)
	Wraps a clip base object into a clip object.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
virtual PdfString	RetrieveName ()
	Retrieves the name possibly associated to this object, walking through the document's name dictionary.
PdfDirectObject	RetrieveNamedBaseObject ()
	Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
Properties
virtual PdfDirectObject	BaseObject [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
override PdfObjectWrapper	Data [get, set]
	Gets/Sets the actual media data.
PdfIndirectObject	DataContainer [get]
	Gets the indirect object containing the base data object.
Document	Document [get]
	Gets the document context.
File	File [get]
	Gets the file context.
string	MimeType [get, set]
	Gets/Sets the MIME type of data [RFC 2045].
MediaPlayers	Players [get, set]
	Gets/Sets the player rules for playing this media.
Viability	Preferences [get, set]
	Gets/Sets the preferred options the renderer should attempt to honor without affecting its viability.
Viability	Requirements [get, set]
	Gets/Sets the minimum requirements the renderer must honor in order to be considered viable.
TempFilePermissionEnum	TempFilePermission [get, set]
	Gets/Sets the circumstance under which it is acceptable to write a temporary file in order to play this media clip.

---

Media clip data [PDF:1.7:9.1.3].

---

Member Enumeration Documentation

enum org::pdfclown::documents::multimedia::MediaClipData::TempFilePermissionEnum

Circumstance under which it is acceptable to write a temporary file in order to play a media clip.

Enumerator:

Never	Never allowed.
ContentExtraction	Allowed only if the document permissions allow content extraction.
Accessibility	Allowed only if the document permissions allow content extraction, including for accessibility purposes.
Always	Always allowed.

---

Constructor & Destructor Documentation

org.pdfclown.documents.multimedia.MediaClipData.MediaClipData	(	PdfObjectWrapper	data,
		string	mimeType
	)

---

Member Function Documentation

void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility

(

object

feature

)

[protected, inherited]

Checks whether the specified feature is compatible with the document's conformance version.

Parameters:

feature

Entity whose compatibility has to be checked. Supported types: VersionEnum Property name resolvable to an annotated getter method MemberInfo

virtual object org.pdfclown.objects.PdfObjectWrapper.Clone

(

Document

context

)

[virtual, inherited]

Gets a clone of the object, registered inside the given document context.

Parameters:

context

Which document the clone has to be registered in.

virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete

(

)

[virtual, inherited]

Removes the object from its document context.

The object is no more usable after this method returns.

Returns:

Whether the object was actually decontextualized (only indirect objects can be decontextualize).

Reimplemented in org.pdfclown.documents.interaction.annotations.Annotation, org.pdfclown.documents.interaction.navigation.page.Article, and org.pdfclown.documents.interaction.navigation.page.ArticleElement.

override bool org.pdfclown.objects.PdfObjectWrapper.Equals

(

object

obj

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.fonts.Font.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDictionary >

wrapper

)

[static, inherited]

Gets the PDF object backing the specified wrapper.

Parameters:

wrapper

Object to extract the base from.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode

(

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.fonts.Font.

virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName

(

)

[protected, virtual, inherited]

Retrieves the name possibly associated to this object, walking through the document's name dictionary.

Reimplemented in org.pdfclown.documents.multimedia.Rendition.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject

(

)

[protected, inherited]

Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.

static MediaClip org.pdfclown.documents.multimedia.MediaClip.Wrap

(

PdfDirectObject

baseObject

)

[static, inherited]

Wraps a clip base object into a clip object.

References org.pdfclown.objects.PdfObject.Resolve().

---

Property Documentation

virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited]

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited]

Gets the indirect object containing the base object.

override PdfObjectWrapper org.pdfclown.documents.multimedia.MediaClipData.Data [get, set]

Gets/Sets the actual media data.

Returns:

Either a FullFileSpecification or a FormXObject.

Reimplemented from org.pdfclown.documents.multimedia.MediaClip.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited]

Gets the indirect object containing the base data object.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

string org.pdfclown.documents.multimedia.MediaClipData.MimeType [get, set]

Gets/Sets the MIME type of data [RFC 2045].

MediaPlayers org.pdfclown.documents.multimedia.MediaClipData.Players [get, set]

Gets/Sets the player rules for playing this media.

Viability org.pdfclown.documents.multimedia.MediaClipData.Preferences [get, set]

Gets/Sets the preferred options the renderer should attempt to honor without affecting its viability.

Viability org.pdfclown.documents.multimedia.MediaClipData.Requirements [get, set]

Gets/Sets the minimum requirements the renderer must honor in order to be considered viable.

TempFilePermissionEnum org.pdfclown.documents.multimedia.MediaClipData.TempFilePermission [get, set]

Gets/Sets the circumstance under which it is acceptable to write a temporary file in order to play this media clip.