1. Home
  2. Actions & Qualifiers
  3. Source

Source

Description

This namespace contains different sources that can be used in overlays and underlays

Details

qualifiers/source.ts, line 8

Classes

new BaseSource()

new AudioSource()

new SubtitlesSource()

new TextSource()

new BaseTextSource()

new ImageSource()

new VideoSource()

new FetchSource()

Methods

<static> image( publicID ) → {Qualifiers.Source.ImageSource}

qualifier

Description

Returns an instance of an ImageSource

Parameters
Name Type Description
publicID string

The publicID of the image to be used as a layer
Returns
Details

qualifiers/source.ts, line 22

<static> text( text, textStyle ) → {Qualifiers.Source.TextSource}

qualifier

Description

Returns an instance of a TextSource

Parameters
Name Type Description
text string

The text to display.
textStyle TextStyle | string

The textStyle to use with the text in the layer
Returns
Details

qualifiers/source.ts, line 33

<static> video( publicID ) → {Qualifiers.Source.VideoSource}

qualifier

Description

Returns an instance of a VideoSource

Parameters
Name Type Description
publicID string

The publicID of the video to be used as a layer
Returns
Details

qualifiers/source.ts, line 43

<static> audio( publicID ) → {Qualifiers.Source.AudioSource}

qualifier

Description

Returns an instance of a AudioSource

Parameters
Name Type Description
publicID string

The publicID of the audio to be used as a layer
Returns
Details

qualifiers/source.ts, line 53

<static> subtitles( fileName ) → {Qualifiers.Source.VideoSource}

qualifier

Description

Returns an instance of an VideoSource

Parameters
Name Type Description
fileName string

The publicID of the video to be used as a layer
Returns
Details

qualifiers/source.ts, line 63

<static> fetch( remoteURL ) → {Qualifiers.Source.FetchSource}

qualifier

Description

Returns an instance of a FetchSource

Parameters
Name Type Description
remoteURL string

The URL of the remote asset to fetch as a layer
Returns
Details

qualifiers/source.ts, line 73