Class MediaCacheItem

This class represents the cached media that is passed between the backend PropertyMedia controls and front ent javascript

Inheritance

System.Object

MediaCacheItem

Namespace: ImageVault.EPiServer.Common

Assembly: ImageVault.EPiServer.Common.dll

Syntax

public class MediaCacheItem : Object

Constructors

MediaCacheItem()

Initializes a new instance of the MediaCacheItem class.

Declaration

public MediaCacheItem()

MediaCacheItem(Int32, Int32, Thumbnail, Media, String, String, String)

Initializes a new instance of the MediaCacheItem class.

Declaration

public MediaCacheItem(int id, int vaultId, Thumbnail thumbMedia, Media originalMedia, string originalFormatContentType = "", string originalFormatUrl = "", string areaOfInterest = "")

Parameters

Type	Name	Description
System.Int32	id
System.Int32	vaultId
Thumbnail	thumbMedia
Media	originalMedia
System.String	originalFormatContentType
System.String	originalFormatUrl
System.String	areaOfInterest

Properties

AreaOfInterest

Get/Sets the AreaOfInterest of the MediaCacheItem

Declaration

public string AreaOfInterest { get; set; }

Property Value

Type	Description
System.String

Id

Get/Sets the Id of the MediaCacheItem

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32

Original

Get/Sets the Original of the MediaCacheItem

Declaration

public Media Original { get; set; }

Property Value

Type	Description
Media

OriginalFormatContentType

Get/Sets the OriginalContentType of the MediaCacheItem

Declaration

public string OriginalFormatContentType { get; set; }

Property Value

Type	Description
System.String

OriginalFormatUrl

Get/Sets the OriginalVideoUrl of the MediaCacheItem

Declaration

public string OriginalFormatUrl { get; set; }

Property Value

Type	Description
System.String

Thumb

Get/Sets the Thumb of the MediaCacheItem

Declaration

public Thumbnail Thumb { get; set; }

Property Value

Type	Description
Thumbnail

VaultId

Get/Sets the VaultId of the MediaCacheItem

Declaration

public int VaultId { get; set; }

Property Value

Type	Description
System.Int32

VaultRole

Get/Sets the VaultRole of the MediaCacheItem

Declaration

public Nullable<VaultRoles> VaultRole { get; set; }

Property Value

Type	Description
System.Nullable<VaultRoles>

Methods

CreateFromMediaItem(MediaItem, Nullable<Int32>)

Declaration

public static MediaCacheItem CreateFromMediaItem(MediaItem mediaItem, Nullable<int> thumbFormatId)

Parameters

Type	Name	Description
MediaItem	mediaItem
System.Nullable<System.Int32>	thumbFormatId

Returns

Type	Description
MediaCacheItem

Parse(String)

Parses the supplied json string to a MediaCacheItem instance

Declaration

public static MediaCacheItem Parse(string json)

Parameters

Type	Name	Description
System.String	json

Returns

Type	Description
MediaCacheItem

ParseList(String)

Parses the supplied json and returns a list of MediaCacheItems

Declaration

public static List<MediaCacheItem> ParseList(string json)

Parameters

Type	Name	Description
System.String	json

Returns

Type	Description
System.Collections.Generic.List<MediaCacheItem>

ToJson(List<MediaCacheItem>)

Converts a list of MediaCacheItem to json

Declaration

public static string ToJson(List<MediaCacheItem> list)

Parameters

Type	Name	Description
System.Collections.Generic.List<MediaCacheItem>	list

Returns

Type	Description
System.String

ToString()

Returns a System.String that represents the current MediaCacheItem.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current MediaCacheItem.

Remarks

Serializes the instance as json

UpdateRenderData(Media, MediaItem)

Duration is needed for the Azure Media Player Editor Trim tool to work, need to add it to the renderData

Declaration

public static void UpdateRenderData(Media media, MediaItem mediaItem)

Parameters

Type	Name	Description
Media	media
MediaItem	mediaItem