Uses of Class
io.wcm.handler.media.Media

Packages that use Media

Package	Description
io.wcm.handler.media	Media Handler API.
io.wcm.handler.media.markup	Default media markup builder implementations.
io.wcm.handler.media.spi	SPI for configuring and tailoring media handler processing.
io.wcm.handler.media.ui	Sling model classes for UI views.
io.wcm.handler.mediasource.dam	Media source implementation for assets stored in DAM.
io.wcm.handler.mediasource.dam.markup	Default media markup implementations for DAM.
io.wcm.handler.mediasource.inline	Media source implementation for binaries stored inline in the page content.

Uses of Media in io.wcm.handler.media

Methods in io.wcm.handler.media that return Media

Modifier and Type	Method	Description
@NotNull Media	MediaBuilder.build()	Resolve media and return metadata objects that contains all results.
Media	MediaHandler.invalid()	Returns an empty media that is marked as invalid.

Uses of Media in io.wcm.handler.media.markup

Methods in io.wcm.handler.media.markup with parameters of type Media

Modifier and Type	Method	Description
boolean	DummyImageMediaMarkupBuilder.accepts(@NotNull Media media)
boolean	DummyResponsiveImageMediaMarkupBuilder.accepts(@NotNull Media media)	Deprecated.
boolean	ResponsiveImageMediaMarkupBuilder.accepts(@NotNull Media media)	Deprecated.
boolean	SimpleImageMediaMarkupBuilder.accepts(@NotNull Media media)
protected @Nullable io.wcm.handler.commons.dom.HtmlElement<?>	SimpleImageMediaMarkupBuilder.applyImageMap(@Nullable io.wcm.handler.commons.dom.HtmlElement<?> element, @NotNull Media media)	If a image map was resolved apply map markup to given image element.
protected void	AbstractImageMediaMarkupBuilder.applyWcmMarkup(@Nullable io.wcm.handler.commons.dom.HtmlElement<?> mediaElement, @NotNull Media media)	Apply Markup for Drag&Drop mode and Diff decoration in WCM edit/preview mode.
io.wcm.handler.commons.dom.HtmlElement<?>	DummyImageMediaMarkupBuilder.build(@NotNull Media media)
io.wcm.handler.commons.dom.HtmlElement<?>	DummyResponsiveImageMediaMarkupBuilder.build(@NotNull Media media)	Deprecated.
io.wcm.handler.commons.dom.HtmlElement<?>	ResponsiveImageMediaMarkupBuilder.build(@NotNull Media media)	Deprecated.
io.wcm.handler.commons.dom.HtmlElement<?>	SimpleImageMediaMarkupBuilder.build(@NotNull Media media)
protected @NotNull String	SimpleImageMediaMarkupBuilder.buildImageMapName(@NotNull List<ImageMapArea> map, @NotNull Media media)	Builds an ID for the image map that is unique within the page.
protected @Nullable MediaFormat	SimpleImageMediaMarkupBuilder.getFirstMediaFormat(@NotNull Media media)	Get first media format from the resolved media renditions.
protected @Nullable MediaFormat	SimpleImageMediaMarkupBuilder.getFirstMediaFormatWithRatio(@NotNull Media media)	Get first media format from the media formats of the media args that has a ratio set.
protected io.wcm.handler.commons.dom.HtmlElement<?>	DummyResponsiveImageMediaMarkupBuilder.getImageElement(Media media)	Deprecated. Create an IMG element.
protected io.wcm.handler.commons.dom.HtmlElement<?>	ResponsiveImageMediaMarkupBuilder.getImageElement(Media media)	Deprecated. Create an IMG element with alt text.
protected @Nullable io.wcm.handler.commons.dom.HtmlElement<?>	SimpleImageMediaMarkupBuilder.getImageElement(@NotNull Media media)	Create an img element that displays the given rendition image.
protected @Nullable io.wcm.handler.commons.dom.HtmlElement<?>	SimpleImageMediaMarkupBuilder.getMediaElement(@NotNull Media media)	Create img or picture media element.
static @NotNull Dimension	MediaMarkupBuilderUtil.getMediaformatDimension(@NotNull Media media)	Get dimension from first media format defined in media args.
protected @Nullable io.wcm.handler.commons.dom.HtmlElement<?>	SimpleImageMediaMarkupBuilder.getPictureElement(@NotNull Media media)	Create an img element that displays the given rendition image.
protected org.apache.sling.commons.json.JSONArray	DummyResponsiveImageMediaMarkupBuilder.getResponsiveImageSources(Media media)	Deprecated. Collect responsive JSON metadata for all renditions as image sources.
protected org.apache.sling.commons.json.JSONArray	ResponsiveImageMediaMarkupBuilder.getResponsiveImageSources(Media media)	Deprecated. Collect responsive JSON metadata for all renditions as image sources.
protected @Nullable String	SimpleImageMediaMarkupBuilder.getSrcSetRenditions(@NotNull Media media, @NotNull MediaFormat mediaFormat, long @NotNull ... widths)	Generate srcset list from the resolved renditions for the ratio of the given media formats and the given widths.
protected @Nullable String	SimpleImageMediaMarkupBuilder.getSrcSetRenditions(@NotNull Media media, @NotNull MediaFormat mediaFormat, @NotNull MediaArgs.WidthOption @Nullable ... widths)	Generate srcset list from the resolved renditions for the ratio of the given media formats and the given widths.
protected void	AbstractImageMediaMarkupBuilder.setAdditionalAttributes(@Nullable io.wcm.handler.commons.dom.HtmlElement<?> mediaElement, @NotNull Media media)	Set additional attributes on the media element from the MediaArgs properties.
protected void	DummyResponsiveImageMediaMarkupBuilder.setResponsiveImageSource(io.wcm.handler.commons.dom.HtmlElement<?> mediaElement, org.apache.sling.commons.json.JSONArray responsiveImageSources, Media media)	Deprecated. Set attribute on media element for responsive image sources
protected void	ResponsiveImageMediaMarkupBuilder.setResponsiveImageSource(io.wcm.handler.commons.dom.HtmlElement<?> mediaElement, org.apache.sling.commons.json.JSONArray responsiveImageSources, Media media)	Deprecated. Set attribute on media element for responsive image sources
protected org.apache.sling.commons.json.JSONObject	DummyResponsiveImageMediaMarkupBuilder.toReponsiveImageSource(Media media, MediaFormat mediaFormat)	Deprecated. Build JSON metadata for one rendition as image source.
protected org.apache.sling.commons.json.JSONObject	ResponsiveImageMediaMarkupBuilder.toReponsiveImageSource(Media media, Rendition rendition)	Deprecated. Build JSON metadata for one rendition as image source.

Uses of Media in io.wcm.handler.media.spi

Methods in io.wcm.handler.media.spi that return Media

Modifier and Type	Method	Description
@NotNull Media	MediaProcessor.process(@NotNull Media media)	Process media metadata
abstract @NotNull Media	MediaSource.resolveMedia(@NotNull Media media)	Resolves a media request

Methods in io.wcm.handler.media.spi with parameters of type Media

Modifier and Type	Method	Description
boolean	MediaMarkupBuilder.accepts(@NotNull Media media)	Checks whether this builder can generate markup for the given media.
@Nullable io.wcm.handler.commons.dom.HtmlElement<?>	MediaMarkupBuilder.build(@NotNull Media media)	Build media element markup
@NotNull Media	MediaProcessor.process(@NotNull Media media)	Process media metadata
abstract @NotNull Media	MediaSource.resolveMedia(@NotNull Media media)	Resolves a media request
protected boolean	MediaSource.resolveRenditions(Media media, Asset asset, MediaArgs mediaArgs)	Resolves single rendition (or multiple renditions if any of the MediaArgs.MediaFormatOption.isMandatory() is set to true and sets the resolved rendition and the URL of the first (best-matching) rendition in the media object.

Uses of Media in io.wcm.handler.media.ui

Methods in io.wcm.handler.media.ui that return Media

Modifier and Type	Method	Description
@NotNull Media	ResourceMedia.getMetadata()	Returns a Media object with the metadata of the resolved media.

Uses of Media in io.wcm.handler.mediasource.dam

Methods in io.wcm.handler.mediasource.dam that return Media

Modifier and Type	Method	Description
@NotNull Media	DamMediaSource.resolveMedia(@NotNull Media media)

Methods in io.wcm.handler.mediasource.dam with parameters of type Media

Modifier and Type	Method	Description
@NotNull Media	DamMediaSource.resolveMedia(@NotNull Media media)

Uses of Media in io.wcm.handler.mediasource.dam.markup

Methods in io.wcm.handler.mediasource.dam.markup with parameters of type Media

Modifier and Type	Method	Description
boolean	DamVideoMediaMarkupBuilder.accepts(@NotNull Media media)
protected void	DamVideoMediaMarkupBuilder.addSources(io.wcm.handler.commons.dom.Video video, Media media)	Add sources for HTML5 video player
io.wcm.handler.commons.dom.HtmlElement<?>	DamVideoMediaMarkupBuilder.build(@NotNull Media media)
protected Map<String,String>	DamVideoMediaMarkupBuilder.getAdditionalFlashPlayerFlashVars(Media media, Dimension dimension)	Get additional parameters to be set as flashvars parameter on html object element for flash player.
protected Map<String,String>	DamVideoMediaMarkupBuilder.getAdditionalFlashPlayerParameters(Media media, Dimension dimension)	Get additional parameters to be set as <param> elements on html object element for flash player.
protected com.day.cq.dam.api.Asset	DamVideoMediaMarkupBuilder.getDamAsset(Media media)
protected io.wcm.handler.commons.dom.HtmlElement	DamVideoMediaMarkupBuilder.getFlashPlayerElement(Media media, Dimension dimension)	Deprecated. Usage of flash for video player fallback is deprecated
protected io.wcm.handler.commons.dom.Video	DamVideoMediaMarkupBuilder.getVideoPlayerElement(@NotNull Media media)	Build HTML5 video player element

Uses of Media in io.wcm.handler.mediasource.inline

Methods in io.wcm.handler.mediasource.inline that return Media

Modifier and Type	Method	Description
@NotNull Media	InlineMediaSource.resolveMedia(@NotNull Media media)

Methods in io.wcm.handler.mediasource.inline with parameters of type Media

Modifier and Type	Method	Description
@NotNull Media	InlineMediaSource.resolveMedia(@NotNull Media media)