com.aspose.slides

Class VideoPlayerHtmlController

java.lang.Object

com.aspose.slides.VideoPlayerHtmlController

All Implemented Interfaces:

IHtmlFormattingController, ILinkEmbedController, ISvgShapeFormattingController, IVideoPlayerHtmlController

public class VideoPlayerHtmlController
extends java.lang.Object
implements IVideoPlayerHtmlController

This class allows export of video and audio files into a HTML

Constructor Summary

Constructors

Constructor and Description
VideoPlayerHtmlController(java.lang.String path, java.lang.String fileName, java.lang.String baseUri) Creates a new instance of controller

Method Summary

Modifier and Type	Method and Description
void	formatShape(ISvgShape svgShape, IShape shape) This function is called before rendering of shape to SVG to allow user to control resulting SVG.
int	getObjectStoringLocation(int id, byte[] entityData, java.lang.String semanticName, java.lang.String contentType, java.lang.String recomendedExtension) Determines where object should be stored.
java.lang.String	getUrl(int id, int referrer) Returns an URL to an external object.
void	saveExternal(int id, byte[] entityData) Saves external object.
void	writeDocumentEnd(IHtmlGenerator generator, IPresentation presentation) Called to write html document footer.
void	writeDocumentStart(IHtmlGenerator generator, IPresentation presentation) Called to write html document header.
void	writeShapeEnd(IHtmlGenerator generator, IShape shape) Called before shape's rendering.
void	writeShapeStart(IHtmlGenerator generator, IShape shape) Called before shape's rendering.
void	writeSlideEnd(IHtmlGenerator generator, ISlide slide) Called to write html slide footer.
void	writeSlideStart(IHtmlGenerator generator, ISlide slide) Called to write html slide header.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoPlayerHtmlController

public VideoPlayerHtmlController(java.lang.String path,
                                 java.lang.String fileName,
                                 java.lang.String baseUri)

Creates a new instance of controller

Parameters:

path - The path where video and audio files will be generated

fileName - The name of the HTML file

baseUri - The base URI which will be used for links generating

Method Detail

writeDocumentStart

public final void writeDocumentStart(IHtmlGenerator generator,
                                     IPresentation presentation)

Description copied from interface: IHtmlFormattingController

Called to write html document header. Called once per presentation conversion.

Specified by:

writeDocumentStart in interface IHtmlFormattingController

Parameters:

generator - Output object.

presentation - Presentation which being currently rendered.

writeDocumentEnd

public final void writeDocumentEnd(IHtmlGenerator generator,
                                   IPresentation presentation)

Description copied from interface: IHtmlFormattingController

Called to write html document footer. Called once per presentation conversion.

Specified by:

writeDocumentEnd in interface IHtmlFormattingController

Parameters:

generator - Output object.

presentation - Presentation which being currently rendered.

writeSlideStart

public final void writeSlideStart(IHtmlGenerator generator,
                                  ISlide slide)

Description copied from interface: IHtmlFormattingController

Called to write html slide header. Called once per each of slides.

Specified by:

writeSlideStart in interface IHtmlFormattingController

Parameters:

generator - Output object.

slide - Slide which being currently rendered.

writeSlideEnd

public final void writeSlideEnd(IHtmlGenerator generator,
                                ISlide slide)

Description copied from interface: IHtmlFormattingController

Called to write html slide footer. Called once per each of slides.

Specified by:

writeSlideEnd in interface IHtmlFormattingController

Parameters:

generator - Output object.

slide - Slide which being currently rendered.

writeShapeStart

public final void writeShapeStart(IHtmlGenerator generator,
                                  IShape shape)

Description copied from interface: IHtmlFormattingController

Called before shape's rendering. Called once per each of shape. If this function writes anything to generator, current slide image generation will be finished, added html fragment inserted and new image will be started atop of the previous.

Specified by:

writeShapeStart in interface IHtmlFormattingController

Parameters:

generator - Output object.

shape - Shape which is about to render.

writeShapeEnd

public final void writeShapeEnd(IHtmlGenerator generator,
                                IShape shape)

Description copied from interface: IHtmlFormattingController

Called before shape's rendering. Called once per each of shape. If this function writes anything to generator, current slide image generation will be finished, added html fragment inserted and new image will be started atop of the previous.

Specified by:

writeShapeEnd in interface IHtmlFormattingController

Parameters:

generator - Output object.

shape - Shape which is rendered last.

formatShape

public final void formatShape(ISvgShape svgShape,
                              IShape shape)

Description copied from interface: ISvgShapeFormattingController

This function is called before rendering of shape to SVG to allow user to control resulting SVG.

Specified by:

formatShape in interface ISvgShapeFormattingController

Parameters:

svgShape - Object to control SVG shape generation.

shape - Source shape.

getObjectStoringLocation

public final int getObjectStoringLocation(int id,
                                          byte[] entityData,
                                          java.lang.String semanticName,
                                          java.lang.String contentType,
                                          java.lang.String recomendedExtension)

Description copied from interface: ILinkEmbedController

Determines where object should be stored. This method is called once for each object id. It is not guaranteed that there won't be two objects with same data, semanticName and contentType but with different id.

Specified by:

getObjectStoringLocation in interface ILinkEmbedController

Parameters:

id - Object id. This id is saving operation-wide unique.

entityData - Object binary data. This parameter can be null, if object binary data is not generated yet.

semanticName - Some short text, describing meaning of object. Controller may use this as a part of external object name, but it is up to dispatcher to ensure that names will be unique and contain only allowed characters.

contentType - MIME type of object.

recomendedExtension - File name extension, recommended for this MIME type.

Returns:

Decision

getUrl

public final java.lang.String getUrl(int id,
                                     int referrer)

Description copied from interface: ILinkEmbedController

Returns an URL to an external object. This method always called if ILinkEmbedController.getObjectStoringLocation(int,byte[],String,String,String) returned LinkEmbedDecision.Link and may be called if ILinkEmbedController.getObjectStoringLocation(int,byte[],String,String,String) returned LinkEmbedDecision.Embed but embedding is impossible. Can be called multiple time for same object id.

Specified by:

getUrl in interface ILinkEmbedController

Parameters:

id - Object id. This id is saving operation-wide unique.

referrer - id of referrencing object or 0, if object is referrenced by the root document. May be used to generate relative link.

Returns:

Url of external object or null if this object should be ignored.

saveExternal

public final void saveExternal(int id,
                               byte[] entityData)

Description copied from interface: ILinkEmbedController

Saves external object.

Specified by:

saveExternal in interface ILinkEmbedController

Parameters:

id - Object id. This id is saving operation-wide unique.

entityData - Object binary data. This parameter cannot be null.