Type: Object
url Array<string> List of urls, each one specifies the ad tag url that is requested from the ad server. The player will request the first url, if failed, it will request the second url and so on (aka waterfalling).response Array<string> List of XMLs, each one specifies a VAST 2.0 document to be used as the ads response instead of making a request via an ad tag url. The player will use the first XML, if failed, it will use the second and so on (aka waterfalling).bumper boolean Specifies whether this is a bumper.prebid KPAdPrebidConfig Specifies whether this is a prebid ad and add the relevant config for prebid request.Type: Array<KPAdObject>
Type: Object
position number The position, in seconds, to show the ad break.percentage number Alternative parameter to position. The position, in percentage of the media length, to show the ad break (optional).every number Alternative parameter to position. Play ad break every X seconds (optional).ads KPAdPod An array of ads to play (Ad pod).Type: Object
prebid KPPrebidConfig The prebid config.adBreaks Array<KPAdBreakObject> The ad breaks scheme.playAdsAfterTime number? Only play ad breaks scheduled after this time (in seconds). This setting is strictly after - e.g. setting playAdsAfterTime to 15 will cause the player to ignore an ad break scheduled to play at 15s.showAdBreakCuePoint boolean? Whether to show the ad breaks cue points.adBreakCuePointStyle Object? Style options for the ad breaks cue points - See the options Here.a map of player instances by player ids
Type: Object<string, KalturaPlayer>
Type: Object
width number Optional width of the videoheight number Optional height of the videobitrate number Optional number of bits used to encode a second of videoframerate number Optional number of frames used in one secondType: Object
isHEVCSupported number Specifies HEVC supported option by the browserisPowerEfficient number Specifies power efficiency supported optionType: Object
isDRMSupported number Specifies DRM supported option by the browsersupportedDRMs Array<string> List of supported DRMs (optional values: widevine, playready, fairplay)Type: Object
Type: Object
sources ProviderMediaConfigSourcesObjectsession ProviderMediaConfigSessionObjectType: Object
autoContinue boolean? Determines whether to continue to the next item automatically.loop boolean? Determines whether to play the playlist in a loop. When selected, the playlist will play automatically even if autoContinue is set to false.Type: Object
timeToShow number? Shows when the countdown is scheduled to appear (by default, this is towards the end).duration number? Shows for how long the countdown will appear.showing boolean? Determines whether to show the countdown.Type: Object
options KPPlaylistOptions Sets the playlist options.countdown KPPlaylistCountdownOptions Configures the playlist countdown.items Array<PlaylistItem> Lists the available playlist items.Type: Object
id string This is playlist’s ID.metadata ProviderPlaylistMetadataObject This is the playlist metadata.options KPPlaylistOptions These are the playlist options.countdown KPPlaylistCountdownOptions This is the playlist countdown configuration.items Array<PlaylistItem> These are the playlist items.Type: Object
countdown KPPlaylistCountdownOptions? Countdown optionsType: Object
options PKAdBreakOptions Ad break data options.Type: string?
Returns string Ad break type - pre/mid/post.
Type: number?
Returns string Ad break position on the playback timeline.
Type: number?
Returns string The number of ads inside the ad break.
id string Ad ID.options PKAdOptions Ad data options.Type: string
Returns string Ad ID.
Type: string?
Returns string? Ad system.
Type: string?
Returns string Ad content type.
Type: string?
Returns string Ad URL.
Type: string?
Returns string Ad title.
Type: number?
Returns string Ad position inside the ad break.
Type: number?
Returns string Ad duration.
Type: string?
Returns string Ad click through URL.
Type: string?
Returns string Ad poster URL.
Type: number?
Returns string Ad skip offset.
Type: boolean
Returns boolean Whether the ad is linear.
Type: number
Returns string Ad width.
Type: number
Returns string Ad height.
Type: number
Returns string Ad bitrate.
Type: boolean
Returns boolean Whether the ad is bumper.
Type: boolean
Returns boolean Whether the ad is imadai.
Type: boolean
Returns string Whether the ad is skippable or not.
Type: boolean
Returns boolean Whether the ad is vpaid or not.
Type: string
Returns string The ad streamId.
Returns string The ad wrapperAdIds.
Returns string The ad wrapperCreativeIds.
Returns string The ad wrapperAdSystems.
Manager for prebid lib.
context PrebidManager The prebid lib context.load the prebid
config KPAdPrebidConfig The prebid config.Returns void
Extends FakeEventTarget
Basic remote player. Implements the Kaltura Player playback, ads, tracks,vr and cast APIs. Remote players should extend this class and implement the needed API.
name string Remote player name.config Object Cast configuration.remoteControl RemoteControl Remote control.Loads a media to the receiver application.
mediaInfo Object The entry media info.Returns Promise<void> Promise to indicate load succeed or failed.
Sets a media to the remote player..
mediaConfig Object Media configuration to set.Returns void
Gets the media Info.
Returns Object? The media info.
Gets the media config.
Returns Object? The media config.
Configure the remote player
config Object Configuration to set. (optional, default {})Returns void
The remote player readiness.
Returns Promise<any> Promise which resolved when the remote player is ready.
Load the remote player.
Returns void
Play/resume the remote player.
Returns void
Pause the remote player.
Returns void
Reset the remote player.
Returns void
Destroy the remote player.
Returns void
BaseRemotePlayer.prototype.isLive(); // false
Returns boolean Whether the current playback is a live playback.
BaseRemotePlayer.prototype.isDvr(); // false
Returns boolean Whether the current live playback has DVR window. In case of non-live playback will return false.
Seeks to the live edge.
Returns void
BaseRemotePlayer.prototype.getStartTimeOfDvrWindow(); // 0
Returns number The start time of the DVR window.
type string? Track type.BaseRemotePlayer.prototype.getTracks(); // []
Returns Array<Track> The remote player tracks.
BaseRemotePlayer.prototype.getTracks(); // {audio: undefined, video: undefined, text: undefined}
Returns Object The remote player active tracks.
Select a certain track to be active.
track Track The track to activate.Returns void
Hides the active text track.
Returns void
Enables automatic adaptive bitrate switching.
Returns void
BaseRemotePlayer.prototype.isAdaptiveBitrateEnabled(); // true
Returns boolean Whether adaptive bitrate is enabled.
Sets the text display settings.
settings Object Text settings.Returns void
Start casting.
Returns Promise<any> A promise to indicate session is starting, or failed
Stops the current cast session.
Returns void
BaseRemotePlayer.prototype.isCasting(); // true
Returns boolean Whether casting is currently active.
BaseRemotePlayer.prototype.isCastAvailable(); // true
Returns boolean Whether casting is available.
Gets the current remote session.
BaseRemotePlayer.prototype.getCastSession(); // new RemoteSession('', '')
Returns RemoteSession The remote session.
BaseRemotePlayer.prototype.isVr(); // false
Returns boolean Whether the current media is of VR type (360 content).
Toggles VR mode on the current content.
Returns void
BaseRemotePlayer.prototype.isInVrStereoMode(); // false
Returns boolean Whether the current content displayed in VR mode.
The remote player ads controller.
Type: Object?
BaseRemotePlayer.prototype.ads; // null
Returns Object?
Setter.
Type: TextStyle
style TextStyle The text style to set.Returns void
Getter.
Type: TextStyle
BaseRemotePlayer.prototype.textStyle; // new TextStyle()
Returns TextStyle The current text style.
Gets the first buffered range of the remote player.
Type: Array<any>
BaseRemotePlayer.prototype.buffered; // []
Returns Array<any> First buffered range in seconds.
Setter.
Type: number
to number The number to set in seconds.Returns void
Getter.
Type: number
BaseRemotePlayer.prototype.currentTime; // 0
Returns number The current time in seconds.
Type: number
BaseRemotePlayer.prototype.duration; // 0
Returns number The duration in seconds.
Type: number
BaseRemotePlayer.prototype.liveDuration; // NaN
Returns number The live duration in seconds.
Setter.
Type: number
vol number The volume to set in the range of 0-1.Returns void
Getter.
Type: number
BaseRemotePlayer.prototype.volume; // 1
Returns number The current volume in the range of 0-1.
Type: boolean
BaseRemotePlayer.prototype.paused; // false
Returns boolean Whether the cast player is in paused state.
Type: boolean
BaseRemotePlayer.prototype.ended; // false
Returns boolean Whether the cast player is in ended state.
Type: boolean
BaseRemotePlayer.prototype.seeking; // false
Returns boolean Whether the cast player is in seeking state.
Setter.
Type: boolean
mute boolean The mute value to set.Returns void
Getter.
Type: boolean
BaseRemotePlayer.prototype.muted; // false
Returns boolean The muted state.
Type: string
BaseRemotePlayer.prototype.src; // ''
Returns string The current playing source url.
Type: string
BaseRemotePlayer.prototype.poster; // ''
Returns string The current poster url.
Setter.
Type: number
rate number The playback rate to set.Returns void
Type: number
BaseRemotePlayer.prototype.playbackRate; // 1
Returns string The current playback rate.
Type: string
BaseRemotePlayer.prototype.engineType; // ''
Returns string The active engine type.
Type: string
BaseRemotePlayer.prototype.streamType; // ''
Returns string The active stream type.
Type: string
BaseRemotePlayer.prototype.type; // BaseRemotePlayer.Type
Returns string The remote player type.
Type: Object
Returns KPOptionsObject The runtime remote player config.
Default configuration of the remote player.
Type: Object
BaseRemotePlayer.defaultConfig; // {}
Remote player type.
Type: string
BaseRemotePlayer.Type; // 'BaseRemotePlayer'
BaseRemotePlayer.isSupported(); // true
Returns boolean Whether the remote player is supported in the current environment.
Type: Object
// Events lifecycle
1. CAST_AVAILABLE
2. CAST_SESSION_STARTING
3. CAST_SESSION_STARTED || CAST_SESSION_START_FAILED -> X
4. CAST_SESSION_ENDING
5. CAST_SESSION_ENDED
// How to use
player.addEventListener(KalturaPlayer.cast.CastEventType.CAST_SESSION_STARTED, e => {
console.log(e.session);
};
Fires when cast session start failed.
Fires when cast session starting.
Fires when cast session started.
Fires when cast session ending.
Fires when cast session ended.
Fires when cast is available.
player KalturaPlayer The Kaltura player.Type: TextStyle
Type: Object
Type: Object
player KalturaPlayer The Kaltura player.Gets the player snapshot.
Type: Function
Returns PlayerSnapshot player snapshot.
Gets the UI wrapper.
Type: Function
Returns UIWrapper The UI wrapper.
On remote device disconnected handler.
Type: Function
payload RemoteDisconnectedPayload disconnected payload.Returns void
On remote device connected handler.
Type: Function
payload RemoteConnectedPayload connected payload.Returns void
On remote device available handler.
Type: Function
payload RemoteAvailablePayload available payload.Returns void
On remote device connecting handler.
Type: Function
Returns void
On remote device disconnecting handler.
Type: Function
Returns void
On remote device connect failed handler.
Type: Function
Returns void
player BaseRemotePlayer The active remote player.The active remote player.
Type: BaseRemotePlayer
Returns BaseRemotePlayer
Extends RemotePayload
player BaseRemotePlayer The active remote player.session RemoteSession The remote session.ui RemotePlayerUI? Optional remote player UI preset.Remote player UI preset.
Type: RemotePlayerUI?
Returns RemotePlayerUI?
Remote session.
Type: RemoteSession
Returns RemoteSession?
Extends RemotePayload
player BaseRemotePlayer The active remote player.snapshot PlayerSnapshot The remote player snapshot.Remote player snapshot.
Type: PlayerSnapshot
Returns PlayerSnapshot
Extends RemotePayload
player BaseRemotePlayer The active remote player.available boolean Remote player availability.Remote player availability.
Type: boolean
Returns boolean
Playback UI of the remote player.
props Object UI creation parameters.Returns React$Element<any> Component.
Idle UI of the remote player.
props Object UI creation parameters.Returns React$Element<any> Component.
Idle UI of the remote player.
props Object UI creation parameters.Returns React$Element<any> Component.
Live UI of the remote player.
props Object UI creation parameters.Returns React$Element<any> Component.
Error UI of the remote player.
props Object UI creation parameters.Returns React$Element<any> Component.
UI presets.
Type: Array<UIPreset>
Returns Array<UIPreset>
Type: TextStyle
Type: boolean
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: boolean
Type: boolean
Type: boolean
Type: string
Type: string
Type: string
Type: string
Type: string
Type: Object
Type: KPOptionsObject
Returns void
Returns void
event FakeEventReturns void
mediaInfo ObjectReturns Promise<any>
mediaConfig ObjectReturns void
Returns Object
Returns Object
config ObjectReturns void
Returns Promise<any>
Returns void
Returns void
Returns void
Returns void
Returns void
Returns boolean
Returns boolean
Returns void
Returns number
type string?Returns Array<Track>
Returns Object
track TrackReturns void
Returns void
Returns void
Returns boolean
settings ObjectReturns void
Returns void
Returns void
Returns boolean
Returns boolean
Returns RemoteSession
Returns boolean
Returns void
Returns boolean
id string Session ID.friendlyName string Receiver friendly name.resuming boolean? Whether the session is resuming.Receiver friendly name.
Type: string
Returns string
Session ID.
Type: string
Returns string
Whether the session is resuming.
Type: boolean?
Returns boolean?
player Player The player.adsPluginController IAdsController The controller of the current ads plugin instance.Type: boolean
Returns boolean Whether all ads completed.
Returns boolean Whether an ad is playing.
Returns boolean Whether we’re in an ad break.
| Returns **Array<(number | string)>** The ad breaks layout (cue points). |
Returns AdBreak? Gets the current ad break data.
Returns Ad? Gets the current ad data.
Skip on an ad.
Returns void
Play an ad on demand.
adPod KPAdPod The ad pod play.Returns void
Controller provider
pluginManager PluginManager the plugin managerGet the ads controller of the all ads plugins.
Returns Array<IAdsPluginController> the ads controllers.
Type: Object
// Events lifecycle
1. PLAYLIST_LOADED
2. PLAYLIST_ITEM_CHANGED (multiple)
3. PLAYLIST_ENDED
// How to use
player.addEventListener(KalturaPlayer.playlist.PlaylistEventType.PLAYLIST_LOADED, e => {
console.log(e.payload.playlist.metadata.name);
};
Fires when the playlist has been loaded.
Fires when a playlist item start to changed.
Fires when the playlist has finished.
sources PKSourcesConfigObject? The item sourcesconfig KPPlaylistItemConfigObject? The item configUpdate the playlist item sources
sourcesObject PKSourcesConfigObject The sourcesReturns void
Update the playlist item plugins (e.g. bumper from BE)
pluginsObject KPPluginsConfigObject The pluginsReturns void
Playlist item sources
Type: PKSourcesConfigObject?
Returns PKSourcesConfigObject?
Playlist item config
Type: KPPlaylistItemConfigObject?
Returns KPPlaylistItemConfigObject?
Playlist item plugins
Type: KPPluginsConfigObject
Returns KPPluginsConfigObject
Playlist item index
Type: number
Returns number
Returns boolean = Whether the playlist item has sources to play
player KalturaPlayer The player instanceoptions KPOptionsObject The player config objectConfig the playlist
config KPPlaylistObject? The playlist configentryList ProviderEntryListObject? Entry listReturns void
Load a playlist
playlistData KPPlaylistObject The playlist dataplaylistConfig KPPlaylistConfigObject? The playlist configentryList ProviderEntryListObject? Entry listReturns void
Reset the playlist
Returns void
Play the next item
Returns void
Play the previous item
Returns void
Play a specific item
index number The index of the item to playReturns void
Playlist items
Type: Array<PlaylistItem>
Returns Array<PlaylistItem>
Current item
Type: PlaylistItem?
Returns PlaylistItem?
Next item
Type: PlaylistItem?
Returns PlaylistItem?
Previous item
Type: PlaylistItem?
Returns PlaylistItem?
Playlist id
Type: string
Returns string
Playlist metadata
Type: ProviderPlaylistMetadataObject
Returns ProviderPlaylistMetadataObject
Playlist poster
Type: string?
Returns string?
Playlist countdown
Type: KPPlaylistCountdownOptions
Returns KPPlaylistCountdownOptions
Playlist options
Type: KPPlaylistOptions
Returns KPPlaylistOptions
The BasePlugin responsible to implement the plugin interface. Contains several default implementations. Other plugins should extend this class.
name string The plugin nameplayer Object The player referenceconfig Object The plugin configurationThe runtime configuration of the plugin.
Type: Object
The name of the plugin.
Type: string
The logger of the plugin.
Type: Object
Reference to the actual player.
Type: Object
The event manager of the plugin.
Type: EventManager
Getter for the configuration of the plugin.
attr string The key in the plugin configuration (optional).Returns any If attribute is provided, returns its value. Else, Returns the config of the plugin.
Getter for the ready promise of the plugin.
Type: Promise<any>
Returns Promise<any> returns a resolved promise unless the plugin overrides this ready getter.
Updates the config of the plugin.
update Object The updated configuration.Returns void
Runs the loadMedia logic of the plugin. plugin must implement this method.
Returns void
Runs the destroy logic of the plugin. plugin must implement this method.
Returns void
Runs the reset logic of the plugin. plugin must implement this method.
Returns void
Getter for the plugin’s name.
Returns string The name of the plugin.
Dispatch an event via the plugin.
name string The event name.payload any The event payload.Returns void
The default configuration of the plugin. Inherited plugins should override this property.
Type: Object
Factory method to create the actual plugin.
name string The plugin nameplayer Object The player referenceconfig Object The plugin configuration (optional, default {})Returns BasePlugin New runtime plugin instance
Returns under what conditions the plugin is valid. Plugin must implement this method.
Returns boolean Whether the plugin is valid and can be initiated. Default implementation is true
The PluginManager responsible for register plugins definitions and store plugins instances.
Creates and store new instance of the plugin in case isValid() of the plugin returns true.
name string The plugin nameplayer Object The player referenceconfig Object The plugin configuration (optional, default {})Returns boolean Whether the plugin load was successful
Iterates over all the plugins and calls loadMedia().
Returns void
Iterates over all the plugins and calls destroy().
Returns void
Iterates over all the plugins and calls reset() method of the plugin’s impl.
Returns void
Returns the plugin’s instance.
name string The plugin name.Returns BasePlugin The plugin instance.
Returns all plugins.
Returns Object All plugins.
Writes the plugin in the registry. Maps: plugin name -> plugin class.
Returns boolean If the registration request succeeded
Removes the plugin from the registry.
name string The plugin nameReturns void
Export the register method.
Type: function
Load middleware handler.
next Function The load handler in the middleware chain.Returns void
Play middleware handler.
next Function The play handler in the middleware chain.Returns void
constructor
return the token store object
| Returns **(any | any)** token store object |
recalculate the token store data, if new config with token is passed then add it to the data store, and if an existing token needs to be removed then remove it
pluginsConfig dataStoreType? the new config objectReturns void
reset the config store to its initial state
Returns void
constructor
options KPPluginsConfigObject plugins optionsconfig KPOptionsObject player configReturns void
Returns void
name string the service nameReturns Object the service object
name string the service nameReturns boolean if the service exist
Returns void
Returns void
Get the redirect external stream handler.
playerOptions KPOptionsObject The player config.mediaOptions KPOptionsObject The media config. (optional, default {})Returns void
enum for supported options
Type: Object
get the media capabilities
hevcConfig HEVCConfigObject The HEVC configuration to check (optional).Returns Promise<MediaCapabilitiesObject> The media capabilities object.
get the media capabilities
hevcConfig HEVCConfigObject The HEVC configuration to check (optional).Returns Promise<MediaCapabilitiesObject> The media capabilities object.
set stream priority according to playerConfig
player Player playersources PKSourcesConfigObject sourcesReturns void
returns true if sources contain youtube video source
sources PKSourcesConfigObject thr sources objectReturns boolean true if sources contain youtube source
returns true if sources contain image source
returns true if sources contain document source
sources PKSourcesConfigObject thr sources objectReturns boolean true if sources contain image source
Merge the provider plugins config (e.g. bumper) into the app config and returns it and the respective app config to restore in change media
providerPluginsConfig KPPluginsConfigObject the provider plugins configappPluginsConfig KPOptionsObject the entire app plugins configReturns Array<KPPluginsConfigObject> the merged plugins config and the partial respective app plugins config
A service class to observe viewability of elements in the view port.
viewabilityConfig number the configuration needed to create the manager (optional, default {})target HTMLElement the targeted element to check its visibilitylistener Function the callback to be invoked when visibility is changed (and when starting to observe). The callback is called with a boolean param representing the visibility stateoptionalThreshold number? a number between 0 to 100 that represents the minimum visible percentage considered as visibleReturns void
Remove the listener from the target
target HTMLElement the targeted element to remove the listenerlistener Function the callback function to be removedReturns void
cleans all memory allocations.
Loads a media.
mediaInfo ProviderMediaInfoObject The media info.mediaOptions PKSourcesConfigObject? The media options.kalturaPlayer.loadMedia({entryId: 'entry123'}, {startTime: 5, poster: 'my/poster/url'});
Returns Promise<any> Promise which resolves when the media is loaded, or rejected if error occurs.
sets a media.
mediaConfig KPMediaConfig The media config.Returns void
Loads a playlist by id.
playlistInfo ProviderPlaylistInfoObject The playlist info.playlistConfig KPPlaylistConfigObject? The playlist config.kalturaPlayer.loadPlaylist({playlistId: '123456'}, {options: {autoContinue: false}});
Returns Promise<ProviderPlaylistObject> The playlist data from the provider.
Loads a playlist by entry list.
entryList ProviderEntryListObject The playlist info.playlistConfig KPPlaylistConfigObject? The playlist config.kalturaPlayer.loadPlaylistByEntryList({entries: [{entryId: '01234'}, {entryId: '56789'}]}, {options: {autoContinue: false}});
Returns Promise<ProviderPlaylistObject> The playlist data from the provider.
returns the media drm info.
Returns PKDrmDataObject the drm info
Config the player.
sourcesMetadata PKMetadataConfigObject The player sources metadata config.kalturaPlayer.setSourcesMetadata({epgId: '1234'});
Returns void
Config the player.
config Object The player config. (optional, default {})kalturaPlayer.configure({playback: {autoplay: true}});
Returns void
Is the current media a live media.
KalturaPlayer.isLive();
Returns boolean boolean if isLive
Does the current media contain a DVR window.
KalturaPlayer.isDvr();
Returns boolean boolean if isDvr
Is in full screen mode.
KalturaPlayer.isFullscreen();
Returns boolean boolean if isFullscreen
Enter full screen mode.
fullScreenElementId string fullScreenElementId is optional will use targetId if not providedKalturaPlayer.enterFullscreen();
Returns void
Exit full screen mode.
KalturaPlayer.exitFullscreen();
Returns void
Enter picture in picture mode.
KalturaPlayer.enterPictureInPicture();
Returns void
Exit picture in picture mode.
KalturaPlayer.exitPictureInPicture();
Returns void
Is in picture in picture mode.
KalturaPlayer.isInPictureInPicture();
Returns boolean boolean if isInPictureInPicture
Is in picture in picture mode supported.
KalturaPlayer.isPictureInPictureSupported();
Returns boolean boolean if isPictureInPictureSupported
In VOD playback this setter is like the regular currentTime setter.
In live playback this setter normalizes the seek point to be relative to the start of the DVR window.
This setter is useful to display a seekbar presents the available seek range only.
Type: number
to Number The number to set in seconds (from 0 to the normalized duration).Returns void
In VOD playback this getter is like the regular currentTime getter.
In live playback this getter normalizes the current time to be relative to the start of the DVR window.
This getter is useful to display a seekbar presents the available seek range only.
Type: number
Returns number
In VOD playback this getter is like the regular duration getter.
In live playback this getter normalizes the duration to be relative to the start of the DVR window.
This getter is useful to display a seekbar presents the available seek range only.
Type: number
Returns number
The playlist controller.
Type: PlaylistManager
KalturaPlayer.playlist.playNext();
Returns PlaylistManager
Set crossOrigin attribute.
Type: string?
crossOrigin string? ‘anonymous’, ‘use-credentials’ or null to remove attribute
anonymous: CORS requests for this element will not have the credentials flag set.
use-credentials: CORS requests for this element will have the credentials flag set; this means the request will provide credentials.Returns void
Get crossOrigin attribute.
Type: string?
Returns string? ‘anonymous’ or ‘use-credentials’
Gets the player visibility state
Type: boolean
Returns boolean whether the player is in the active browser tab and visible in the view port
Gets the player viewability manager service
Type: ViewabilityManager
Returns ViewabilityManager player viewability manager
Gets a registered service of that name
name string the service nameReturns Object the service object
Checks if a service of that name has been registered
name string the service nameReturns boolean if the service exist
Registers a service to be used across the player
Returns void
Add text track
kind string Specifies the kind of text track.label string? A string specifying the label for the text track.Returns TextTrack? A TextTrack Object, which represents the new text track.
get the native text tracks
Returns Array<TextTrack> The native TextTracks array.
get the default config for forcing external stream redirect.
playerOptions KPOptionsObject The player config.mediaOptions KPOptionsObject The media config. (optional, default {})Returns Object config object
get the default config for forcing external stream redirect.
playerOptions KPOptionsObject The player config.mediaOptions KPOptionsObject The media config. (optional, default {})Returns Object config object
get all instantiated players
Returns KalturaPlayers map of player ids and their respective instantiated player
get a player instance by id
id string the player ID| Returns **(KalturaPlayer | null)** the player if found by the supplied ID or null if key doesn’t exist |