Class Source

Represents audio and video content that can be loaded into a player.

Hierarchy

Constructors

constructor

Properties

config? isDestroyed isInitialized nativeId remoteControl

Methods

destroy duration getThumbnail initialize isActive isAttachedToPlayer loadingState metadata setMetadata

Constructors

constructor

  • new Source(config?): Source

  • Generate UUID in case the user-defined nativeId is empty.

    Parameters

    Returns Source

Properties

Optional Readonly config

config?: SourceConfig

The configuration object used to initialize this instance.

isDestroyed

isDestroyed: boolean = false

Whether the native Source object has been disposed.

isInitialized

isInitialized: boolean = false

Whether the native Source object has been created.

Readonly nativeId

nativeId: string

Optionally user-defined string id for the native instance, or UUIDv4.

remoteControl

remoteControl: null | SourceRemoteControlConfig = null

The remote control config for this source. This is only supported on iOS.

Platform

iOS

Methods

destroy

  • destroy(): void

  • Destroys the native Source and releases all of its allocated resources.

    Returns void

duration

  • duration(): Promise<number>

  • The duration of the source in seconds if it’s a VoD or INFINITY if it’s a live stream. Default value is 0 if the duration is not available or not known.

    Returns Promise<number>

getThumbnail

  • getThumbnail(time): Promise<null | Thumbnail>

  • Parameters

    • time: number

      The time in seconds for which to retrieve the thumbnail.

    Returns Promise<null | Thumbnail>

    a Thumbnail for the specified playback time if available. Supported thumbnail formats are:

    • WebVtt configured via SourceConfig.thumbnailTrack, on all supported platforms
    • HLS Image Media Playlist in the multivariant playlist, Android-only
    • DASH Image Adaptation Set as specified in DASH-IF IOP, Android-only If a WebVtt thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.

initialize

  • initialize(): void

  • Allocates the native Source instance and its resources natively.

    Returns void

isActive

  • isActive(): Promise<boolean>

  • Whether the source is currently active in a player (i.e. playing back or paused). Only one source can be active in the same player instance at any time.

    Returns Promise<boolean>

isAttachedToPlayer

  • isAttachedToPlayer(): Promise<boolean>

  • Whether the source is currently attached to a player instance.

    Returns Promise<boolean>

loadingState

metadata

  • metadata(): Promise<null | Record<string, any>>

  • Metadata for the currently loaded source.

    Returns Promise<null | Record<string, any>>

setMetadata

  • setMetadata(metadata): void

  • Set metadata for the currently loaded source. Setting the metadata to null clears the metadata object in native source.

    Parameters

    • metadata: null | Record<string, any>

      metadata to be set.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorconfigisDestroyedisInitializednativeIdremoteControldestroydurationgetThumbnailinitializeisActiveisAttachedToPlayerloadingStatemetadatasetMetadata