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

Packages that use MediaArgs

Package	Description
io.wcm.handler.media	Media Handler API.
io.wcm.handler.media.spi	SPI for configuring and tailoring media handler processing.

Uses of MediaArgs in io.wcm.handler.media

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

Modifier and Type	Method	Description
@NotNull MediaArgs	MediaArgs.altText(String value)	Allows to specify a custom alternative text that is to be used instead of the one defined in the the media lib item
@NotNull MediaArgs	MediaArgs.autoCrop(boolean value)
MediaArgs	MediaArgs.clone()	Custom clone-method for MediaArgs
@NotNull MediaArgs	MediaArgs.contentDispositionAttachment(boolean value)
@NotNull MediaArgs	MediaArgs.download(boolean value)
@NotNull MediaArgs	MediaArgs.dragDropSupport(DragDropSupport value)	Drag&Drop support for media builder.
@NotNull MediaArgs	MediaArgs.dummyImage(boolean value)
@NotNull MediaArgs	MediaArgs.dummyImageUrl(String value)
@NotNull MediaArgs	MediaArgs.dynamicMediaDisabled(boolean value)
@NotNull MediaArgs	MediaArgs.fileExtension(String value)
@NotNull MediaArgs	MediaArgs.fileExtensions(@NotNull String @Nullable ... values)
@NotNull MediaArgs	MediaArgs.fixedDimension(long widthValue, long heightValue)	Use fixed dimensions instead of width from media format or original image
@NotNull MediaArgs	MediaArgs.fixedHeight(long value)	Use fixed height instead of width from media format or original image
@NotNull MediaArgs	MediaArgs.fixedWidth(long value)	Use fixed width instead of width from media format or original image
@NotNull MediaArgs	MediaRequest.getMediaArgs()
@NotNull MediaArgs	MediaArgs.imageSizes(MediaArgs.ImageSizes value)
@NotNull MediaArgs	MediaArgs.includeAssetThumbnails(boolean value)
@NotNull MediaArgs	MediaArgs.includeAssetWebRenditions(boolean value)
@NotNull MediaArgs	MediaArgs.ipeRatioCustomize(IPERatioCustomize value)
@NotNull MediaArgs	MediaArgs.mandatoryMediaFormatNames(@NotNull String @Nullable ... names)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mandatoryMediaFormats(@NotNull MediaFormat @Nullable ... values)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormat(MediaFormat value)	Sets a single media format to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormatName(String name)	Sets a single media format to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormatNames(@NotNull String @Nullable ... names)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormatOptions(@NotNull MediaArgs.MediaFormatOption @Nullable ... values)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormats(@Nullable MediaFormat @Nullable ... values)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormatsMandatory(boolean value)	The "mandatory" flag of all media format options is set to to the given value.
@NotNull MediaArgs	MediaArgs.pictureSources(@NotNull MediaArgs.PictureSource @Nullable ... value)
@NotNull MediaArgs	MediaArgs.properties(Map<String,Object> map)	Custom properties that my be used by application-specific markup builders or processors.
@NotNull MediaArgs	MediaArgs.property(String key, Object value)	Custom properties that my be used by application-specific markup builders or processors.
@NotNull MediaArgs	MediaArgs.urlMode(io.wcm.handler.url.UrlMode value)

Methods in io.wcm.handler.media with parameters of type MediaArgs

Modifier and Type	Method	Description
@NotNull MediaBuilder	MediaBuilder.args(@NotNull MediaArgs mediaArgs)	Sets additional arguments affection media resolving e.g. media formats.
@NotNull MediaBuilder	MediaHandler.get(String mediaRef, MediaArgs mediaArgs)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(org.apache.sling.api.resource.Resource resource, MediaArgs mediaArgs)	Build media which is referenced in the resource (as property or inline binary data).
@Nullable Rendition	Asset.getDownloadRendition(@NotNull MediaArgs mediaArgs)	Get the first download rendition that matches the given media args.
@Nullable Rendition	Asset.getFlashRendition(@NotNull MediaArgs mediaArgs)	Deprecated. Flash support is deprecated
@Nullable Rendition	Asset.getImageRendition(@NotNull MediaArgs mediaArgs)	Get the first image rendition that matches the given media args.
@Nullable Rendition	Asset.getRendition(@NotNull MediaArgs mediaArgs)	Get the first rendition that matches the given media args.

Constructors in io.wcm.handler.media with parameters of type MediaArgs

Constructor	Description
MediaRequest(@NotNull String mediaRef, @Nullable MediaArgs mediaArgs)
MediaRequest(@NotNull org.apache.sling.api.resource.Resource resource, @Nullable MediaArgs mediaArgs)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable MediaRequest.MediaPropertyNames mediaPropertyNames)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable String refProperty, @Nullable String cropProperty)	Deprecated. Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable String refProperty, @Nullable String cropProperty, @Nullable String rotationProperty)	Deprecated. Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)

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

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

Modifier and Type	Method	Description
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.