Interface ISubtitlerTransition

Namespace

Gasimo.Subtitles

Assembly

Gasimo.Subtitler.dll

Interface to define transition animations for subtitle lines.

public interface ISubtitlerTransition

Methods

AnimateSubtitleEntrance(Label, ISubtitleEntry, CancellationToken)

Called when a subtitle entry is about to be displayed.

Task AnimateSubtitleEntrance(Label subtitle, ISubtitleEntry entry, CancellationToken cancellationToken)

Parameters

subtitle Label

Label containing this subtitle

entry ISubtitleEntry

cancellationToken CancellationToken

Token which gets called when the entry is interrupted.

Returns

Task

Task containing the animaion

AnimateSubtitleExit(Label, ISubtitleEntry, CancellationToken)

Called when a subtitle entry is about to be hidden.

Task AnimateSubtitleExit(Label subtitle, ISubtitleEntry entry, CancellationToken cancellationToken)

Parameters

subtitle Label

Label containing this subtitle

entry ISubtitleEntry

cancellationToken CancellationToken

Token which gets called when the entry is interrupted.

Returns

Task

OnLabelCreated(Label)

Called when a label is created in the Subtitler Pool. Use this to initialize the label with any custom settings required. Subtitler already sets any properties exposed in the Subtitler component.

void OnLabelCreated(Label subtitle)

Parameters

subtitle Label