Uses of Class
io.wcm.handler.media.format.MediaFormat

Packages that use MediaFormat

Package	Description
io.wcm.handler.media	Media Handler API.
io.wcm.handler.media.format	Media format management.
io.wcm.handler.media.markup	Default media markup builder implementations.
io.wcm.handler.media.spi	SPI for configuring and tailoring media handler processing.

Uses of MediaFormat in io.wcm.handler.media

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

Modifier and Type	Method	Description
@Nullable MediaFormat	MediaArgs.MediaFormatOption.getMediaFormat()
@Nullable MediaFormat	MediaArgs.PictureSource.getMediaFormat()
@Nullable MediaFormat	Rendition.getMediaFormat()
MediaFormat @Nullable []	MediaArgs.getMediaFormats()	Returns list of media formats to resolve to.

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

Modifier and Type	Method	Description
@NotNull MediaBuilder	MediaHandler.get(@Nullable java.lang.String mediaRef, MediaFormat @NotNull ... mediaFormats)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(@Nullable org.apache.sling.api.resource.Resource resource, MediaFormat @NotNull ... mediaFormats)	Build media which is referenced in the resource (as property or inline binary data).
@NotNull MediaArgs	MediaArgs.mandatoryMediaFormats(@NotNull MediaFormat @Nullable ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mandatoryMediaFormats(@NotNull MediaFormat @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormat(MediaFormat value)	Sets a single media format to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormat(@NotNull MediaFormat value)	Sets a single media format to resolve to.
@NotNull MediaArgs	MediaArgs.mediaFormats(@Nullable MediaFormat @Nullable ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormats(@NotNull MediaFormat @NotNull ... values)	Sets list of media formats to resolve to.

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

Constructor	Description
MediaArgs(@NotNull MediaFormat @NotNull ... mediaFormats)
MediaFormatOption(@Nullable MediaFormat mediaFormat, boolean mandatory)
PictureSource(@NotNull MediaFormat mediaFormat)

Uses of MediaFormat in io.wcm.handler.media.format

Methods in io.wcm.handler.media.format that return MediaFormat

Modifier and Type	Method	Description
@NotNull MediaFormat	MediaFormatBuilder.build()	Builds the media format definition.
@Nullable MediaFormat	MediaFormatHandler.detectMediaFormat(@Nullable java.lang.String extension, long fileSize, long width, long height)	Detect matching media format.
@Nullable MediaFormat	MediaFormatHandler.getMediaFormat(@NotNull java.lang.String mediaFormatName)	Resolves media format name to media format object.

Methods in io.wcm.handler.media.format that return types with arguments of type MediaFormat

Modifier and Type	Method	Description
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.detectMediaFormats(@Nullable java.lang.String extension, long fileSize, long width, long height)	Detect all matching media formats.
java.util.SortedMap<java.lang.String,java.util.SortedSet<MediaFormat>>	MediaFormatProviderManager.getAllMediaFormats()	Get all media format definitions deployed in the system, grouped by bundle which exposes them.
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getMediaFormats()	Get media formats defined by a CMS application that is responsible for the given media library path.
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getMediaFormats(@NotNull java.util.Comparator<MediaFormat> comparator)	Get media formats defined by a CMS application that is responsible for the given media library path.
java.util.SortedSet<MediaFormat>	MediaFormatProviderManager.getMediaFormats(org.apache.sling.api.resource.Resource contextResource)	Get all media format definitions for application.
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getSameBiggerMediaFormats(@NotNull MediaFormat mediaFormatRequested, boolean filterRenditionGroup)	Get list of media formats that have the same (or bigger) resolution as the requested media format and (nearly) the same aspect ratio.
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getSameSmallerMediaFormats(@NotNull MediaFormat mediaFormatRequested, boolean filterRenditionGroup)	Get list of possible media formats that can be rendered from the given media format, i.e. same size or smaller and (nearly) the same aspect ratio.

Methods in io.wcm.handler.media.format with parameters of type MediaFormat

Modifier and Type	Method	Description
int	MediaFormatCombinedTitleComparator.compare(MediaFormat obj1, MediaFormat obj2)
int	MediaFormatRankingComparator.compare(MediaFormat obj1, MediaFormat obj2)
int	MediaFormatSizeRankingComparator.compare(MediaFormat obj1, MediaFormat obj2)
int	MediaFormat.compareTo(MediaFormat o)
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getSameBiggerMediaFormats(@NotNull MediaFormat mediaFormatRequested, boolean filterRenditionGroup)	Get list of media formats that have the same (or bigger) resolution as the requested media format and (nearly) the same aspect ratio.
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getSameSmallerMediaFormats(@NotNull MediaFormat mediaFormatRequested, boolean filterRenditionGroup)	Get list of possible media formats that can be rendered from the given media format, i.e. same size or smaller and (nearly) the same aspect ratio.
static boolean	Ratio.matches(@NotNull MediaFormat first, @NotNull MediaFormat second)	Checks if the ratios of both given media formats are the same within the bounds of the MediaFormatHandler.RATIO_TOLERANCE.

Method parameters in io.wcm.handler.media.format with type arguments of type MediaFormat

Modifier and Type	Method	Description
@NotNull java.util.SortedSet<MediaFormat>	MediaFormatHandler.getMediaFormats(@NotNull java.util.Comparator<MediaFormat> comparator)	Get media formats defined by a CMS application that is responsible for the given media library path.

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

Methods in io.wcm.handler.media.markup that return MediaFormat

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

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

Modifier and Type	Method	Description
protected @Nullable java.lang.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 java.lang.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.

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

Methods in io.wcm.handler.media.spi that return types with arguments of type MediaFormat

Modifier and Type	Method	Description
@NotNull java.util.Set<MediaFormat>	MediaFormatProvider.getMediaFormats()

Constructor parameters in io.wcm.handler.media.spi with type arguments of type MediaFormat

Constructor	Description
MediaFormatProvider(java.util.Set<MediaFormat> mediaFormats)