Interface IMediaFormatService
Summary description for IMediaFormatService.
Namespace: ImageVault.Common.Services
Assembly: ImageVault.Common.dll
Syntax
public interface IMediaFormatService : IServiceProperties
OriginalFormat
Gets the OriginalFormat of the MediaFormatService
Declaration
OriginalFormat OriginalFormat { get; }Property Value
| Type | Description |
|---|---|
| OriginalFormat |
Methods
Delete(Int32)
Deletes a conversion format by it's id
Declaration
void Delete(int formatId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | formatId | The id of the conversion format to delete |
Find(MediaFormatQuery)
Finds mediaformats based on the supplied query
Declaration
List<MediaFormatBase> Find(MediaFormatQuery q)Parameters
| Type | Name | Description |
|---|---|---|
| MediaFormatQuery | q |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<MediaFormatBase> |
FindFormats(IList<MediaFormatBase>)
Finds MediaFormats based on the supplied format templates
Declaration
IList<MediaFormatBase> FindFormats(IList<MediaFormatBase> templates)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<MediaFormatBase> | templates | The System.Collections.Generic.List<> of templates that you would like to find |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IList<MediaFormatBase> | The System.Collections.Generic.IList<> of found formats |
Remarks
A template can be a MediaFormatBase where the Id is set to get a format matching the supplied id. The matching format can be both system and user formats. If no format that matches the id exists no format will be returned. It can also be a MediaFormatBase where the Name is set to get a named user conversion format. If many format matches the name, one will be returned. If no format matches the name, no format will be returned. The Original format is retrieved by supplying a OriginalFormat. You can also supply a concrete conversion format like a ImageFormat with parameters set to get a matching system format. If no system format exists that matches the format, a new will be created for you.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | If you supply a MediaFormatBase without supplying MediaFormatId or Name for a match. |
Store(MediaFormatBase)
Stores the supplied format
Declaration
MediaFormatBase Store(MediaFormatBase format)Parameters
| Type | Name | Description |
|---|---|---|
| MediaFormatBase | format |
Returns
| Type | Description |
|---|---|
| MediaFormatBase |