Class RenderingSubtitlesEventArgs

Provides the subtitles rendering payload as event arguments.

Inheritance

Object

EventArgs

RenderingEventArgs

RenderingSubtitlesEventArgs

Inherited Members

RenderingEventArgs.EngineState

RenderingEventArgs.Stream

RenderingEventArgs.Clock

RenderingEventArgs.StartTime

RenderingEventArgs.Duration

RenderingEventArgs.PresentationTime

EventArgs.Empty

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unosquare.FFME.Common

Syntax

public sealed class RenderingSubtitlesEventArgs : RenderingEventArgs

Properties

Cancel

When set to true, clears the current subtitle and prevents the subtitle block from being rendered.

Declaration

public bool Cancel { get; set; }

Property Value

Type	Description
Boolean

Format

Gets the type of subtitle format the original subtitle text is in.

Declaration

public AVSubtitleType Format { get; }

Property Value

Type	Description
AVSubtitleType

OriginalText

Gets the text as originally decoded including all markup and formatting.

Declaration

public IList<string> OriginalText { get; }

Property Value

Type	Description
IList<String>

Text

Gets the text stripped out of ASS or SRT formatting. This is what the default subtitle renderer will display on the screen.

Declaration

public IList<string> Text { get; }

Property Value

Type	Description
IList<String>

See Also

EventArgs

Comments