Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SourceConfigOptions

Hierarchy

  • SourceConfigOptions

Index

Properties

Optional audioCodecPriority

audioCodecPriority: string[]

Specify the priority of audio codecs for this source. If more than one audio codec is available this order will be respected while finding a codec which is supported by the current browser. Default is PlaybackConfig.audioCodecPriority

since

7.6

Optional dashManifestWithCredentials

dashManifestWithCredentials: undefined | false | true

Send credentials and cookies along with cross origin MPEG-DASH manifest requests. Must be supported by the server. Default is false.

Optional dashWithCredentials

dashWithCredentials: undefined | false | true

Send credentials and cookies along with cross origin MPEG-DASH segment requests. Must be supported by the server. Default is false.

Optional headers

headers: HttpHeaders

Optional hlsManifestWithCredentials

hlsManifestWithCredentials: undefined | false | true

Send credentials and cookies along with cross origin HLS manifest requests. Must be supported by the server. Default is false.

Optional hlsWithCredentials

hlsWithCredentials: undefined | false | true

Send credentials and cookies along with cross origin HLS segment requests. Must be supported by the server. Default is false.

Optional manifestWithCredentials

manifestWithCredentials: undefined | false | true

Send credentials and cookies along with cross origin manifest (HLS and MPEG-DASH) requests. Must be supported by the server. Default is false.

Optional persistentPoster

persistentPoster: undefined | false | true

If set to true, this will keep the poster image visible during playback, e.g. for audio-only streams.

Optional startOffset

startOffset: undefined | number

The position where the stream should be started. Number can be positive or negative depending on the used TimelineReferencePoint. Invalid numbers will be corrected according to the stream boundaries. For VOD this is applied at the time the stream is loaded, for LIVE when the playback starts.

Example:

// Start a VOD stream at 10.5 seconds
{
 startOffset: 10.5,
 startOffsetTimelineReference: TimelineReferencePoint.Start // also the default value
}

// Start a LIVE stream 20 seconds behind the live edge
{
  startOffset: -20,
  startOffsetTimelineReference: TimelineReferencePoint.End // also the default value
}
since

8.9.0

Optional startOffsetTimelineReference

startOffsetTimelineReference: TimelineReferencePoint

Timeline reference point to calculate SourceConfigOptions.startOffset from. Default for live: TimelineReferencePoint.End Default for VOD: TimelineReferencePoint.Start

Optional startTime

startTime: undefined | number

The position in fractional seconds to start playback from.

since

7.1

deprecated

use StartOffset instead

Optional videoCodecPriority

videoCodecPriority: string[]

Specify the priority of video codecs for this source. If more than one video codec is available this order will be respected while finding a codec which is supported by the current browser. Default is PlaybackConfig.videoCodecPriority

since

7.6

Optional withCredentials

withCredentials: undefined | false | true

Send credentials and cookies along with cross origin (HLS and MPEG-DASH) segment requests. Must be supported by the server. Default is false.

Generated using TypeDoc