Class Video

Class Video

Inheritance
System.Object
BaseItem
Video
Movie
MusicVideo
Trailer
Episode
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public class Video : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasMediaSources

Properties

ContainingFolderPath

Declaration
[IgnoreDataMember]
public override string ContainingFolderPath { get; }
Property Value
Type Description
System.String
Overrides

EnableDefaultVideoUserDataKeys

Declaration
[IgnoreDataMember]
protected virtual bool EnableDefaultVideoUserDataKeys { get; }
Property Value
Type Description
System.Boolean

Is3D

Gets a value indicating whether [is3 D].

Declaration
[IgnoreDataMember]
public bool Is3D { get; }
Property Value
Type Description
System.Boolean

true if [is3 D]; otherwise, false.

IsResolvedToFolder

Declaration
[IgnoreDataMember]
public override bool IsResolvedToFolder { get; }
Property Value
Type Description
System.Boolean
Overrides

MediaType

Gets the type of the media.

Declaration
[IgnoreDataMember]
public override string MediaType { get; }
Property Value
Type Description
System.String

The type of the media.
Overrides

SupportsAdditionalParts

Declaration
[IgnoreDataMember]
public override bool SupportsAdditionalParts { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsAlternateVersions

Declaration
[IgnoreDataMember]
protected virtual bool SupportsAlternateVersions { get; }
Property Value
Type Description
System.Boolean

SupportsExternalTransfer

Declaration
[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsExtras

Declaration
[IgnoreDataMember]
public override bool SupportsExtras { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsGenres

Declaration
[IgnoreDataMember]
public override bool SupportsGenres { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsLocalTrailers

Declaration
[IgnoreDataMember]
public override bool SupportsLocalTrailers { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsPeople

Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsStudios

Declaration
[IgnoreDataMember]
public override bool SupportsStudios { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsThemeMedia

Declaration
[IgnoreDataMember]
public override bool SupportsThemeMedia { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsThumbnails

Declaration
[IgnoreDataMember]
public bool SupportsThumbnails { get; }
Property Value
Type Description
System.Boolean

Video3DFormat

Gets or sets the video3 D format.

Declaration
[IgnoreDataMember]
public Video3DFormat? Video3DFormat { get; set; }
Property Value
Type Description
System.Nullable<Video3DFormat>

The video3 D format.

Methods

CanDownload()

Declaration
public override bool CanDownload()
Returns
Type Description
System.Boolean
Overrides

CreateBif(Stream, Int32, List<FileSystemMetadata>)

Declaration
public static async Task CreateBif(Stream stream, int intervalMs, List<FileSystemMetadata> images)
Parameters
Type Name Description
System.IO.Stream stream
System.Int32 intervalMs
System.Collections.Generic.List<FileSystemMetadata> images
Returns
Type Description
System.Threading.Tasks.Task

CreatePresentationUniqueKey(BaseItem[], LibraryOptions)

Declaration
public override string CreatePresentationUniqueKey(BaseItem[] collectionFolders, LibraryOptions libraryOptions)
Parameters
Type Name Description
BaseItem[] collectionFolders
LibraryOptions libraryOptions
Returns
Type Description
System.String
Overrides

GetAllItemsForMediaSources(User, Boolean)

Declaration
protected override List<Tuple<BaseItem, MediaSourceType>> GetAllItemsForMediaSources(User user, bool enableAlternateMediaSources)
Parameters
Type Name Description
User user
System.Boolean enableAlternateMediaSources
Returns
Type Description
System.Collections.Generic.List<System.Tuple<BaseItem, MediaSourceType>>
Overrides

GetAlternateVersionIds()

Declaration
public List<long> GetAlternateVersionIds()
Returns
Type Description
System.Collections.Generic.List<System.Int64>

GetDefaultVideoStream()

Declaration
public MediaStream GetDefaultVideoStream()
Returns
Type Description
MediaStream

GetLocalThumbnailSetInfos(String, Guid, Boolean, IDirectoryService)

Declaration
public static ThumbnailSetInfo[] GetLocalThumbnailSetInfos(string videoPath, Guid itemGuid, bool enableCache, IDirectoryService directoryService)
Parameters
Type Name Description
System.String videoPath
System.Guid itemGuid
System.Boolean enableCache
IDirectoryService directoryService
Returns
Type Description
ThumbnailSetInfo[]

GetMetadataFolderThumbnailSetInfos(String, Guid, IDirectoryService)

Declaration
public static ThumbnailSetInfo[] GetMetadataFolderThumbnailSetInfos(string videoPath, Guid itemGuid, IDirectoryService directoryService)
Parameters
Type Name Description
System.String videoPath
System.Guid itemGuid
IDirectoryService directoryService
Returns
Type Description
ThumbnailSetInfo[]

GetRelatedUrls()

Declaration
public override List<ExternalUrl> GetRelatedUrls()
Returns
Type Description
System.Collections.Generic.List<ExternalUrl>
Overrides

GetRunTimeTicksForPlayState()

Declaration
public override long GetRunTimeTicksForPlayState()
Returns
Type Description
System.Int64
Overrides

GetSupportsPositionTicksResume(LibraryOptions)

Declaration
public override bool GetSupportsPositionTicksResume(LibraryOptions libraryOptions)
Parameters
Type Name Description
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean
Overrides

GetThumbnailSetInfos(String, Guid, IDirectoryService, Int32, Boolean)

Declaration
public static ThumbnailSetInfo[] GetThumbnailSetInfos(string videoPath, Guid itemGuid, IDirectoryService directoryService, int maxWidth, bool enableStrictWidthRequirement)
Parameters
Type Name Description
System.String videoPath
System.Guid itemGuid
IDirectoryService directoryService
System.Int32 maxWidth
System.Boolean enableStrictWidthRequirement
Returns
Type Description
ThumbnailSetInfo[]

GetThumbnailSetInfos(String, Guid, Boolean, IDirectoryService)

Declaration
public static ThumbnailSetInfo[] GetThumbnailSetInfos(string videoPath, Guid itemGuid, bool enableCache, IDirectoryService directoryService)
Parameters
Type Name Description
System.String videoPath
System.Guid itemGuid
System.Boolean enableCache
IDirectoryService directoryService
Returns
Type Description
ThumbnailSetInfo[]

GetUserDataKey(BaseItem)

Declaration
public static string GetUserDataKey(BaseItem item)
Parameters
Type Name Description
BaseItem item
Returns
Type Description
System.String

GetUserDataKeyInternal()

Declaration
protected override string GetUserDataKeyInternal()
Returns
Type Description
System.String
Overrides

IsActiveRecording()

Declaration
public override bool IsActiveRecording()
Returns
Type Description
System.Boolean
Overrides

SplitVersion()

Declaration
public void SplitVersion()

SupportsPlayedStatus()

Declaration
public override bool SupportsPlayedStatus()
Returns
Type Description
System.Boolean
Overrides

Implements

Extension Methods