Definitions

Type Definitions

AdBreak

AdBreak definition
Properties:
Name Type Description
start number The start time of the range, in milliseconds.
end number The end time of the range, in milliseconds.

AudioTrack

AudioTrack definition
Properties:
Name Type Attributes Description
id string The id of the track.
language string The audio language.
name string <nullable>
 The audio name.
label string <nullable>
 The audio label.
role string <nullable>
 The audio role.
channelsCount number <nullable>
 The audio channels.

Chapter

Chapter definition
Properties:
Name Type Description
id string The id of the chapter.
title string The title of the chapter.
startTime number The time that describes the beginning of the range of the chapter.
endTime number The time that describes the end of the range of chapter.

Config

Config
Properties:
Name Type Attributes Default Description
licenseKey string HISPlayer license key to validate the playback.
div Element The div container of the player.
src string URL of the stream to be played.
backupManifests Array.<string> <optional>
 [] It’s possible to set one or multiple backup manifests so the player can switch to them in case the original fails. Please note that this feature is currently only available for live DASH streams and the backup manifests MUST have the same properties as the original one (codecs, container format, timestamps, etc.).
debug boolean <optional>
 false Activates the player's logs.
drm Array.<object> <optional>
 [] Contains an array of DRM information.
Properties
Name Type Attributes Default Description
type string DRM type of the video. Values: 'com.widevine.alpha', 'com.microsoft.playready', 'com.apple.fps.1_0', 'org.w3.clearkey'.
licenseServer string <optional>
 License server of the video. Optional only for ClearKey.
clearKeys object <optional>
 ClearKeys of the video. Only used on ClearKey. If licenseServer is present, this property is ignored.
provider string <optional>
 Provider of the video (only for FairPlay). Values: 'ezdrm', 'conax', 'verimatrix', 'expressplay'
certificateUri string <optional>
 CertificateUri of the video (only for FairPlay). Config.drm.certificateUri will have priority over Config.drm.certificate if both of them are provided.
certificate string <optional>
 Certificate of the video (only for FairPlay).
headers Array.<object> <optional>
 [] Headers of the video.
Properties
Name Type Description
name string Name of the HTTP header.
value string Value of the HTTP header.
autoplay boolean <optional>
 true Determines whether the playback must start automatically or not.
mutedAtStart boolean <optional>
 false Determines wheter the playback must start muted or not. Ignored in SmartTVs and video game consoles.
resumePosition number <optional>
 Determines the position where the video will start playing.
poster string <optional>
 Video poster URL.
showPosterWhenPaused boolean <optional>
 false Show the poster when the stream is paused.
logosrc string <optional>
 Company URL logo.
title string <optional>
 The stream's name.
subtitle string <optional>
 Secondary or explanatory title of the stream.
externalSubtitles Array.<object> <optional>
 [] Used to provide subtitle files as external subtitles.
Properties
Name Type Description
src string Subtitles file URL.
language string Subtitle language identifier.
staticThumbnailsVTT string <optional>
 Used to provide the player an external thumbnails VTT file.
lcevc boolean <optional>
 false Determines if the playback is MPEG-5 Part 2 (LCEVC).
ps5SecureVideoMode boolean <optional>
 false Enables the Enhanced Security Video Mode. This uses a more secure video render pipeline which is required when content is encrypted with PlayReady SL-3000 and/or HDR content.
externalChapters Array.<object> <optional>
 [] Used to provide the player an external chapters.
Properties
Name Type Attributes Description
src string <optional>
 Chapter file URL.
markers Array.<object> <optional>
 Chapter markers.
Properties
Name Type Attributes Description
time number <optional>
 Chapter time.
title string <optional>
 Chapter title.
language string Chapter language identifier.
vrMode string <optional>
 'none' Determines the VR mode: 'cubemap', 'equirectangular' or 'none'.
preferredAudioLanguage string <optional>
 Determines which is the default audio language.
preferredSubtitleLanguage string <optional>
 Determines which is the default subtitle language.
preferredAudioChannelLayout string <optional>
 'stereo' Determines which is the default audio channel layout. Values: 'mono', 'stereo', 'surround'.
mediaOptions Array.<string> <optional>
 [] HTML media options. Eg: 'disablePictureInPicture',
ads object <optional>
 Ad configuration.
Properties
Name Type Attributes Default Description
adsMode string <optional>
 'none' Determines the ad library: ‘ima’, ‘dai’, 'mediatailor' or none. Note that ‘dai’ needs a [daiConfig] object to work, while ‘ima’ require a [adTagUri] string and 'mediatailor' needs a [mediatailorConfig] object to work.
enableVpaid boolean <optional>
 true If it is set to true the player can execute VPAID ads, otherwise, the player will play other media that is available in the ad. In case no other media files are included in the ad an error will be fired.
adTagUri string <optional>
 Advertisement URL that is going to be played. VAST, VPAID, VMAP are supported.
pageUrl string <optional>
<nullable>
 Adds a parameter to the ad request to keep track of the domain that sent the request. For targeting purposes. Parameter for ima.
daiConfig object <optional>
 Used to initialize the DAI stream.
Properties
Name Type Attributes Description
assetKey string <optional>
 This is used to determine which stream should be played. Required for live streams.
contentSrcId string <optional>
 Unique identifier for the publisher content, from a CMS. Required for on-demand streams.
videoId string <optional>
 Identifier for the video content source. Required for on-demand streams.
mediatailorConfig object <optional>
 Used to initialize the Media Tailor stream.
Properties
Name Type Attributes Description
baseUrl string <optional>
 Base URL for Video and Ads.
manifestUrl string <optional>
 Video URL to be attached to the baseURL.
adsParams object <optional>
 Contains “Params: string” this is the Ad URL to be attached to the baseURL.
playerConfig object <optional>
 Playback configuration.
Properties
Name Type Attributes Default Description
abrRestrictToElementSize boolean <optional>
 false If true, restrict the quality to media element size
lowLatency boolean <optional>
 false If the stream is low latency and if true, low latency streaming mode is enabled.
cmcd object <optional>
 CMCD configuration and settings. (Common Media Client Data)
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 false If true, enable CMCD data to be sent with media requests.
useHeaders boolean <optional>
 false If true, send CMCD data using the header transmission mode instead of query args.
sessionId string <optional>
 A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification. By default the sessionId is automatically generated on each init() call.
contentId string <optional>
 A unique string identifying the current content. Maximum length is 64 characters. This value is consistent across multiple different sessions and devices and is defined and updated at the discretion of the service provider.
progressTimeEvents boolean <optional>
 false If true, fire progress time events
requireHdcp boolean <optional>
 false If true, requires a HDCP to reproduce DRM content. May be ignored if not supported by the device.
disableAudio boolean <optional>
 false If true, the audio tracks are ignored. Defaults to false.
disableVideo boolean <optional>
 false If true, the video tracks are ignored. Defaults to false.
disableText boolean <optional>
 false If true, the text tracks are ignored. Defaults to false.
disableThumbnails boolean <optional>
 false If true, the thumbnails tracks are ignored. Defaults to false.
useHLSCompatibilityMode boolean <optional>
 false If true, uses a player mode that provide more compatibility with stream that has A/V sync problems. Defaults to false.
bufferConfig object <optional>
 Buffer settings
Properties
Name Type Attributes Description
bufferingGoal number <optional>
 The number of seconds of content that the player will attempt to buffer ahead of the playhead. This value must be greater than or equal to the rebuffering goal.
bufferBehind number <optional>
 The maximum number of seconds of content that the player will keep in buffer behind the playhead when it appends a new media segment. The player will evict content to meet this limit.
rebufferingGoal number <optional>
 The minimum number of seconds of content that the player must buffer before it can begin playback or can continue playback after it has entered into a buffering state
preferredVideoCodecs Array.<string> <optional>
 ['dvh1', 'dvhe', 'av01', 'hvc1', 'hev1', 'avc1', 'avc3'] This property can be used to give priority to a specific video codec.
preferredAudioCodecs Array.<string> <optional>
 [] This property can be used to give priority to a specific audio codec.
bitrateConfig object <optional>
 Determines whether the video will start playing at the bitrate you set by default.
Properties
Name Type Attributes Description
disableABR number <optional>
 Disables the ABR to prevent the player from changing tracks regardless of bandwidth.
maxBitrate number <optional>
 The player should ignore any bitrate profiles in the manifest above this value, and never play them.
minBitrate number <optional>
 The player should ignore any bitrate profiles in the manifest under this value, and never play them.
startingBitrate number <optional>
 The bitrate the player will try to start playing.
withCredentials object <optional>
 Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates.
Properties
Name Type Attributes Default Description
license boolean <optional>
 false Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates in license requests
manifest boolean <optional>
 false Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates in manifest requests
segment boolean <optional>
 false Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates in segment requests
liveSync object <optional>
 Properties for live synchronization. Note: only works for live Streams.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 false Indicates if live synchronization is enabled or disabled.
synchronizationDistance boolean <optional>
 2 Indicates the live synchronization distance in seconds. The live point is the seek range end.
syncAlways boolean <optional>
 true Indicates if live synchronization is always enabled or only for the initial load. If true, if the user play/pause, the player always go to live synchronization point.
maxAbrResolution object <optional>
 Determines the max resolutions picked by the ABR.
Properties
Name Type Attributes Default Description
width object <optional>
 Infinity Max width picked by the ABR.
height object <optional>
 Infinity Max height picked by the ABR.
ui object <optional>
 UI configuration and settings.
Properties
Name Type Attributes Default Description
enabled object <optional>
 false UI enabled.
locale object <optional>
 navigator.language UI language.
singleClickForPlayAndPause object <optional>
 true UI single click for play/pause. Disabled on VR mode.
doubleClickForFullscreen object <optional>
 true UI double click for fullscreen. Disabled on VR mode.
useiOSFullScreen object <optional>
 true Use native fullscreen on iOS. Disabled on VR mode.
autoHide object <optional>
 true Auto hide the UI.
showMetadata object <optional>
 false Show ID3 metadata (eg: TIT2, TPE1).
showButtons object <optional>
 true Show the buttons in the UI.
options object <optional>
 UI options.
Properties
Name Type Attributes Default Description
hideTimes boolean <optional>
 false Hide times in the UI.
hideSeekBar boolean <optional>
 false Hide seek bar in the UI.
hideVolume boolean <optional>
 false Hide volume icon in the UI.
hideRewind boolean <optional>
 false Hide rewind icon in the UI.
hidePlay boolean <optional>
 false Hide play icon in the UI.
hideForward boolean <optional>
 false Hide forward icon in the UI.
hideLoop boolean <optional>
 true Hide loop icon in the UI.
hidePlaybackRates boolean <optional>
 true Hide playback rates icon in the UI.
playbackRates boolean <optional>
 [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2] Playback rates values in the UI.
hideQualityLevels boolean <optional>
 false Hide quality levels icon in the UI.
hideChapters boolean <optional>
 false Hide chapters icon in the UI. Only SmartTVs and Consoles.
hideAudios boolean <optional>
 false Hide audio icon in the UI.
hideSubtitles boolean <optional>
 false Hide subtitle icon in the UI.
hideAirPlay boolean <optional>
 true Hide AirPlay icon in the UI.
hideStereoVR boolean <optional>
 false Hide Stereo VR icon in the UI.
hideResetVR boolean <optional>
 false Hide Reset VR icon in the UI.
hideVRControl boolean <optional>
 false Hide VR Control icon in the UI. Only SmartTVs and Consoles.
hidePip boolean <optional>
 false Hide pip icon in the UI.
hideFullscreen boolean <optional>
 false Hide fullscreen icon in the UI.

SubtitleTrack

SubtitleTrack definition
Properties:
Name Type Description
id string The id of the track.
language string The subtile language.
forced boolean Indicates if the subtitle is forced.

Thumbnail

Thumbnail definition
Properties:
Name Type Description
imageHeight number The image height in px. The image height could be different to height if the layout is different to 1x1.
imageWidth number The image width in px. The image width could be different to width if the layout is different to 1x1.
height number The thumbnail height in px.
positionX number The thumbnail left position in px.
positionY number The thumbnail top position in px.
startTime number The start time of the thumbnail in the presentation timeline, in seconds.
duration number The duration of the thumbnail, in seconds.
uris Array.<string> An array of URIs to attempt. They will be tried in the order they are given.
width number The thumbnail width in px.

Track

Track definition
Properties:
Name Type Attributes Description
id string The id of the track.
width number <nullable>
 The track width in px.
height number <nullable>
 The track height in px.
bitrate number <nullable>
 The track bitrate.
framerate number <nullable>
 The track framerate.