Module z_media_tag

Generate media urls and html for viewing media, based on the filename, size and optional filters.

Copyright 2009-2016 Marc Worrell

Authors: Marc Worrell (marc@worrell.nl).

Description

Generate media urls and html for viewing media, based on the filename, size and optional filters. Does not generate media previews itself, this is done when fetching the image.

Typical urls are like: /image/2007/03/31/wedding.jpg(300x300)(crop-center)(a3ab6605e5c8ce801ac77eb76289ac12).jpg /media/inline/2007/03/31/wedding.jpg /media/attachment/2007/03/31/wedding.jpg

Function Index

props2url/2
scomp_tag/3Called from template, render the media tag for some resource/medium.
scomp_url/3Called from template, render the media url for some resource/medium.
scomp_viewer/3Called from template, render the media viewer for some resource/medium.
tag/3Generate a HTML image tag for the image with the filename and options.
url/3Generate the url for the image with the filename and options.
url2props/2Translate an url of the format "image.jpg(300x300)(crop-center)(checksum).jpg" to parts.
viewer/3Generate a html fragment for displaying a medium.

Function Details

props2url/2

props2url(Props, Context) -> any()

scomp_tag/3

scomp_tag(IdOrName, Options, Context) -> any()

Called from template, render the media tag for some resource/medium

scomp_url/3

scomp_url(IdOrName, Options, Context) -> any()

Called from template, render the media url for some resource/medium

scomp_viewer/3

scomp_viewer(IdOrName, Options, Context) -> any()

Called from template, render the media viewer for some resource/medium

tag/3

tag(Rsc_list::MediaReference, Options, Context) -> {ok, TagString} | {error, Reason}

Generate a HTML image tag for the image with the filename and options. The medium _must_ be in a format for which we can generate a preview. Note that this will never generate video or audio.

url/3

url(Name::MediaRef, Options, Context) -> {ok, Url::binary()} | {error, Reason}

Generate the url for the image with the filename and options

url2props/2

url2props(Url::binary() | string(), Context::#context{}) -> {ok, {FilePath::string(), Props::list(), Checksum::string(), ChecksumBaseString::string()}} | {error, no_lparen | checksum_invalid | badarg}

Translate an url of the format "image.jpg(300x300)(crop-center)(checksum).jpg" to parts

viewer/3

viewer(Rsc_list::MediaReference, Options, Context) -> {ok, HtmlFragMent} | {error, Reason}

Generate a html fragment for displaying a medium. This can generate audio or video player html.


Generated by EDoc, Dec 9 2016, 15:47:26.