MediaHelper Class

Class providing helper methods for media. Overridable helper

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<MediaHelper>
        CMS.Helpers.MediaHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23

Syntax

public class MediaHelper : AbstractHelper<MediaHelper>

The MediaHelper type exposes the following members.

Constructors

	Name	Description
Public method	MediaHelper

Methods

	Name	Description
Public method Static member	GetAllowedHTML5Extensions	Returns the list of allowed media extensions supported by HTML5
Public method Static member	GetAllowedImageExtensions	Gets allowed extensions for images depends on settings
Public method Static member	GetAudioVideo	Returns HTML code of the audio/video player
Protected method	GetAudioVideoInternal	Returns HTML code of the audio/video player
Public method Static member	GetFlash	Returns HTML code of the Flash player.
Protected method	GetFlashInternal	Returns HTML code of the Flash player.
Public method Static member	GetImage	Returns HTML code of the image/image with link/image with special behavior.
Protected method	GetImageInternal	Returns HTML code of the image/image with link/image with special behavior.
Public method Static member	GetImageStyleAtt	Generates the IMG tag according to given parameters.
Protected method	GetImageStyleAttInternal	Generates the IMG tag according to given parameters.
Public method Static member	GetMediaType	Returns media type according to the specified extension.
Public method Static member	GetYouTubeVideo	Returns HTML code of the YouTube player.
Protected method	GetYouTubeVideoInternal	Returns HTML code of the YouTube player.
Public method Static member	IsAudio	Returns true if it is audio extension, otherwise returns false.
Protected method	IsAudioInternal	Returns true if it is audio extension, otherwise returns false.
Public method Static member	IsAudioVideo	Returns true if it is audio or video extension, otherwise returns false.
Public method Static member	IsFlash	Returns true if it is flash extension, otherwise returns false.
Protected method	IsFlashInternal	Returns true if it is flash extension, otherwise returns false.
Public method Static member	IsVideo	Returns true if it is video extension, otherwise returns false.
Protected method	IsVideoInternal	Returns true if it is video extension, otherwise returns false.
Public method Static member	RenderHTML5MediaTags	Returns true if rendering of HTML5 media tags is enabled for the given site
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	RegShortYouTube	Regular expression for short youtube URL.