Interface HespTypedSource

Specific TypedSource variant for an HESP media resource.

Remarks


- Note: This API is in an experimental stage and may be subject to breaking changes.
- Only available with the feature 'hesp'.
- Only applicable when configuring an HESP source.

interface HespTypedSource {
    abr?: SourceAbrConfiguration;
    contentProtection?: DRMConfiguration;
    crossOrigin?: CrossOriginSetting;
    dash?: DashPlaybackConfiguration;
    drm?: DRMConfiguration;
    hesp?: HespSourceConfiguration;
    hls?: HlsPlaybackConfiguration;
    hlsDateRange?: boolean;
    integration?: SourceIntegrationId;
    lcevc?: boolean;
    liveOffset?: number;
    lowLatency?: boolean;
    src?: string;
    ssai?: ServerSideAdInsertionConfiguration;
    timeServer?: string;
    type: "application/vnd.theo.hesp+json";
    useCredentials?: boolean;
    useNativePlayback?: boolean;
}

Hierarchy (view full)

Properties

abr? contentProtection? crossOrigin? dash? drm? hesp? hls? hlsDateRange? integration? lcevc? liveOffset? lowLatency? src? ssai? timeServer? type useCredentials? useNativePlayback?

Properties

Optional abr

abr?: SourceAbrConfiguration

The source's ABR configuration.

Remarks


- Available since v3.1.0.
- Overrides PlayerConfiguration.abr.
- Used for DASH and LL-HLS streams.

Optional contentProtection

contentProtection?: DRMConfiguration

The content protection parameters for the media resource.

Remarks


- Available since v2.15.0.

Optional crossOrigin

crossOrigin?: CrossOriginSetting

The cross-origin setting of the source.

Default Value

''

Remarks


- Available since v2.9.0.

Optional dash

dash?: DashPlaybackConfiguration

The configuration for controlling playback of an MPEG-DASH stream.

Remarks


- Available since v2.79.0.
- Ignored for non-DASH streams.

Optional drm

drm?: DRMConfiguration

The content protection parameters for the media resource.

Deprecated

Superseded by TypedSource.contentProtection.

Optional hesp

hesp?: HespSourceConfiguration

Specific source configuration for an HESP media resource.

Remarks


- Note: This API is in an experimental stage and may be subject to breaking changes.
- Only available with the feature 'hesp'.
- Only applicable when configuring an HESP source.

Optional hls

hls?: HlsPlaybackConfiguration

The configuration for controlling playback of an HLS stream.

Remarks


- Available since v2.82.0.
- Ignored for non-HLS streams.

Optional hlsDateRange

hlsDateRange?: boolean

Whether the player should parse and expose date ranges from HLS manifests.

Default Value

false

Remarks


- Available since v2.61.0.

Optional integration

integration?: SourceIntegrationId

The integration ID of the source.

Remarks


- This can be used to signal that a source is specific to an integration.

Optional lcevc

lcevc?: boolean

Whether this source should be played using the LCEVC sdk.

Remarks


- Requires the LCEVC feature to be enabled.
- Requires the V-Nova LCEVC SDK to be loaded on the page.
- Only available for DASH and HLS streams.

Optional liveOffset

liveOffset?: number

The offset in seconds used to determine the live point. This live point is the end of the manifest minus the provided offset.

Remarks


- Available since v2.35.0.

Default Value

Three times the segment's target duration.

Optional lowLatency

lowLatency?: boolean

Whether the source should be played in the low-latency-mode of the player.

Default Value

false

Remarks


- This setting must be true when using Low-Latency CMAF with ABR.
- Available since v2.62.0.

Optional src

src?: string

The source URL of the media resource.

Remarks


- Required if the ssai property is absent.
- Available since v2.4.0.

Optional ssai

ssai?: ServerSideAdInsertionConfiguration

The Server-side Ad Insertion parameters for the media resource.

Remarks


- Available since v2.12.0.

Optional timeServer

timeServer?: string

The URL of a time server used by the player to synchronise the time in DASH sources.

Remarks


- Available since v2.47.0.
- The time server should return time in ISO-8601 format.
- Overrides the time server provided the DASH manifest's <UTCTiming>.
- Only this source will use the time server. Alternatively, for all source use SourceConfiguration.timeServer.

type

type: "application/vnd.theo.hesp+json"

The content type (MIME type) of the media resource, represented by a value from the following list:
- 'application/dash+xml': The media resource is an MPEG-DASH stream.
- 'application/x-mpegURL' or 'application/vnd.apple.mpegurl': The media resource is an HLS stream.
- 'video/mp4', 'video/webm' and other formats: The media resource should use native HTML5 playback if supported by the browser.
- 'application/vnd.theo.hesp+json': The media resource is an HESP stream.

Remarks


- Available since v2.4.0.

Optional useCredentials

useCredentials?: boolean

Whether the player is allowed to use credentials for cross-origin requests.

Remarks


- Credentials are cookies, authorization headers or TLS client certificates.

Default Value

false

Optional useNativePlayback

useNativePlayback?: boolean

Whether this source should be played using native playback.

Default Value

false

Remarks


- Available since v2.68.0.
- Ignored for DASH streams.
- Only supported on browsers that can play HLS streams natively, will error otherwise.

Settings

Member Visibility

Theme

On This Page

abrcontentProtectioncrossOrigindashdrmhesphlshlsDateRangeintegrationlcevcliveOffsetlowLatencysrcssaitimeServertypeuseCredentialsuseNativePlayback

Generated using TypeDoc