You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jellyfin/Jellyfin.Data/Entities/MediaSegment.cs

61 lines
2.0 KiB

using System;
using Jellyfin.Data.Enums.MediaSegmentAction;
using Jellyfin.Data.Enums.MediaSegmentType;
namespace Jellyfin.Data.Entities.MediaSegment
{
/// <summary>
/// A moment in time of a media stream (ItemId+StreamIndex) with Type and possible Action applicable between StartTicks/Endticks.
/// </summary>
public class MediaSegment
{
/// <summary>
/// Gets or sets the start position in Ticks.
/// </summary>
/// <value>The start position.</value>
public long StartTicks { get; set; }
/// <summary>
/// Gets or sets the end position in Ticks.
/// </summary>
/// <value>The end position.</value>
public long EndTicks { get; set; }
/// <summary>
/// Gets or sets the Type.
/// </summary>
/// <value>The media segment type.</value>
public MediaSegmentType Type { get; set; }
/// <summary>
/// Gets or sets the TypeIndex which relates to the type.
/// </summary>
/// <value>The type index.</value>
public int TypeIndex { get; set; }
/// <summary>
/// Gets or sets the associated MediaSourceId.
/// </summary>
/// <value>The id.</value>
public Guid ItemId { get; set; }
/// <summary>
/// Gets or sets the associated MediaStreamIndex.
/// </summary>
/// <value>The id.</value>
public int StreamIndex { get; set; }
/// <summary>
/// Gets or sets the creator recommended action. Can be overwritten with user defined action.
/// </summary>
/// <value>The media segment action.</value>
public MediaSegmentAction Action { get; set; }
/// <summary>
/// Gets or sets a comment.
/// </summary>
/// <value>The user provided value to be displayed when the <see cref="MediaSegment.Type"/> is a <see cref="MediaSegmentType.Annotation" />.</value>
public string? Comment { get; set; }
}
}