2014-02-10 19:39:41 +01:00
|
|
|
|
using MediaBrowser.Controller.Providers;
|
2014-02-07 21:30:41 +01:00
|
|
|
|
using MediaBrowser.Model.Entities;
|
2013-12-19 22:51:32 +01:00
|
|
|
|
using System;
|
2014-01-28 19:37:01 +01:00
|
|
|
|
using System.Collections.Generic;
|
2014-02-10 19:39:41 +01:00
|
|
|
|
using System.IO;
|
2013-12-19 22:51:32 +01:00
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Entities
|
|
|
|
|
{
|
2014-01-30 22:47:13 +01:00
|
|
|
|
public interface IHasImages : IHasProviderIds
|
2013-12-19 22:51:32 +01:00
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the name.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The name.</value>
|
2014-01-28 19:37:01 +01:00
|
|
|
|
string Name { get; set; }
|
2013-12-19 22:51:32 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The path.</value>
|
2014-01-01 19:26:31 +01:00
|
|
|
|
string Path { get; set; }
|
|
|
|
|
|
2013-12-19 22:51:32 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the identifier.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The identifier.</value>
|
|
|
|
|
Guid Id { get; }
|
|
|
|
|
|
2014-01-28 19:37:01 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the type of the location.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The type of the location.</value>
|
|
|
|
|
LocationType LocationType { get; }
|
|
|
|
|
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the images.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <returns>IEnumerable{ItemImageInfo}.</returns>
|
|
|
|
|
IEnumerable<ItemImageInfo> GetImages(ImageType imageType);
|
|
|
|
|
|
2013-12-19 22:51:32 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the image path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
string GetImagePath(ImageType imageType, int imageIndex);
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// Gets the image information.
|
2013-12-19 22:51:32 +01:00
|
|
|
|
/// </summary>
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
|
|
|
/// <returns>ItemImageInfo.</returns>
|
|
|
|
|
ItemImageInfo GetImageInfo(ImageType imageType, int imageIndex);
|
2013-12-19 22:51:32 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Sets the image.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <param name="index">The index.</param>
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// <param name="file">The file.</param>
|
|
|
|
|
void SetImagePath(ImageType type, int index, FileInfo file);
|
2013-12-19 22:51:32 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Determines whether the specified type has image.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
|
|
|
/// <returns><c>true</c> if the specified type has image; otherwise, <c>false</c>.</returns>
|
|
|
|
|
bool HasImage(ImageType type, int imageIndex);
|
|
|
|
|
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Allowses the multiple images.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
|
|
|
|
bool AllowsMultipleImages(ImageType type);
|
|
|
|
|
|
2013-12-19 22:51:32 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Swaps the images.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <param name="index1">The index1.</param>
|
|
|
|
|
/// <param name="index2">The index2.</param>
|
|
|
|
|
/// <returns>Task.</returns>
|
|
|
|
|
Task SwapImages(ImageType type, int index1, int index2);
|
2013-12-21 19:37:34 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the display type of the media.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The display type of the media.</value>
|
|
|
|
|
string DisplayMediaType { get; set; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the primary image path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The primary image path.</value>
|
2014-02-01 07:18:16 +01:00
|
|
|
|
string PrimaryImagePath { get; }
|
2013-12-27 01:23:58 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the preferred metadata language.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
string GetPreferredMetadataLanguage();
|
2014-01-28 19:37:01 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Validates the images and returns true or false indicating if any were removed.
|
|
|
|
|
/// </summary>
|
2014-02-10 19:39:41 +01:00
|
|
|
|
bool ValidateImages(IDirectoryService directoryService);
|
2014-01-28 19:37:01 +01:00
|
|
|
|
|
2014-02-06 05:39:16 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets a value indicating whether this instance is owned item.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value><c>true</c> if this instance is owned item; otherwise, <c>false</c>.</value>
|
|
|
|
|
bool IsOwnedItem { get; }
|
2014-02-06 06:17:00 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the containing folder path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <value>The containing folder path.</value>
|
|
|
|
|
string ContainingFolderPath { get; }
|
2014-02-07 21:30:41 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Adds the images.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="images">The images.</param>
|
|
|
|
|
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
|
|
|
|
bool AddImages(ImageType imageType, IEnumerable<FileInfo> images);
|
2014-02-08 21:02:35 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Determines whether [is save local metadata enabled].
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <returns><c>true</c> if [is save local metadata enabled]; otherwise, <c>false</c>.</returns>
|
|
|
|
|
bool IsSaveLocalMetadataEnabled();
|
2013-12-19 22:51:32 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public static class HasImagesExtensions
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the image path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
public static string GetImagePath(this IHasImages item, ImageType imageType)
|
|
|
|
|
{
|
|
|
|
|
return item.GetImagePath(imageType, 0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public static bool HasImage(this IHasImages item, ImageType imageType)
|
|
|
|
|
{
|
|
|
|
|
return item.HasImage(imageType, 0);
|
|
|
|
|
}
|
2014-01-01 19:26:31 +01:00
|
|
|
|
|
2013-12-19 22:51:32 +01:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Sets the image path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
2014-02-07 21:30:41 +01:00
|
|
|
|
/// <param name="file">The file.</param>
|
|
|
|
|
public static void SetImagePath(this IHasImages item, ImageType imageType, FileInfo file)
|
2013-12-19 22:51:32 +01:00
|
|
|
|
{
|
2014-02-07 21:30:41 +01:00
|
|
|
|
item.SetImagePath(imageType, 0, file);
|
2013-12-19 22:51:32 +01:00
|
|
|
|
}
|
2014-02-10 19:39:41 +01:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Sets the image path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="file">The file.</param>
|
|
|
|
|
public static void SetImagePath(this IHasImages item, ImageType imageType, string file)
|
|
|
|
|
{
|
|
|
|
|
item.SetImagePath(imageType, new FileInfo(file));
|
|
|
|
|
}
|
2013-12-19 22:51:32 +01:00
|
|
|
|
}
|
|
|
|
|
}
|