From d3cd74718ff88374e999929100496aea32411e50 Mon Sep 17 00:00:00 2001 From: Yair Ansbacher Date: Sun, 9 Dec 2018 15:08:53 +0200 Subject: [PATCH] fix(FEC-8726): kalturaPlayer.config api is broken while casting (#185) remove `get config` override --- docs/api.md | 992 +++++++++++++------------- src/common/cast/base-remote-player.js | 9 - src/common/cast/remote-player.js | 7 - 3 files changed, 490 insertions(+), 518 deletions(-) diff --git a/docs/api.md b/docs/api.md index cc0a914d9..dd3bf87e3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -101,208 +101,206 @@ - [Examples][97] - [streamType][98] - [Examples][99] - - [config][100] - - [type][101] - - [Examples][102] - - [defaultConfig][103] - - [Examples][104] - - [Type][105] - - [Examples][106] - - [isSupported][107] - - [Examples][108] -- [CastEventType][109] - - [Examples][110] -- [PlayerSnapshot][111] - - [Parameters][112] - - [startTime][113] - - [autoplay][114] - - [audioLanguage][115] - - [textLanguage][116] - - [mediaInfo][117] - - [textStyle][118] - - [advertising][119] - - [volume][120] - - [muted][121] -- [RemoteControl][122] - - [Parameters][123] - - [getPlayerSnapshot][124] - - [getUIWrapper][125] - - [onRemoteDeviceDisconnected][126] - - [Parameters][127] - - [onRemoteDeviceConnected][128] - - [Parameters][129] - - [onRemoteDeviceAvailable][130] - - [Parameters][131] - - [onRemoteDeviceConnecting][132] - - [onRemoteDeviceDisconnecting][133] - - [onRemoteDeviceConnectFailed][134] -- [RemotePayload][135] - - [Parameters][136] - - [player][137] -- [RemoteConnectedPayload][138] - - [Parameters][139] - - [ui][140] - - [session][141] -- [RemoteDisconnectedPayload][142] - - [Parameters][143] - - [snapshot][144] -- [RemoteAvailablePayload][145] - - [Parameters][146] - - [available][147] -- [RemotePlayerUI][148] - - [playbackUI][149] - - [Parameters][150] - - [idleUI][151] - - [Parameters][152] - - [adsUI][153] - - [Parameters][154] - - [liveUI][155] - - [Parameters][156] - - [errorUI][157] - - [Parameters][158] - - [uis][159] -- [IRemotePlayer][160] - - [textStyle][161] - - [muted][162] - - [playbackRate][163] - - [volume][164] - - [currentTime][165] - - [buffered][166] - - [duration][167] - - [paused][168] - - [ended][169] - - [seeking][170] - - [src][171] - - [poster][172] - - [config][173] - - [engineType][174] - - [streamType][175] - - [type][176] - - [ads][177] - - [addEventListener][178] + - [type][100] + - [Examples][101] + - [defaultConfig][102] + - [Examples][103] + - [Type][104] + - [Examples][105] + - [isSupported][106] + - [Examples][107] +- [CastEventType][108] + - [Examples][109] +- [PlayerSnapshot][110] + - [Parameters][111] + - [startTime][112] + - [autoplay][113] + - [audioLanguage][114] + - [textLanguage][115] + - [mediaInfo][116] + - [textStyle][117] + - [advertising][118] + - [volume][119] + - [muted][120] +- [RemoteControl][121] + - [Parameters][122] + - [getPlayerSnapshot][123] + - [getUIWrapper][124] + - [onRemoteDeviceDisconnected][125] + - [Parameters][126] + - [onRemoteDeviceConnected][127] + - [Parameters][128] + - [onRemoteDeviceAvailable][129] + - [Parameters][130] + - [onRemoteDeviceConnecting][131] + - [onRemoteDeviceDisconnecting][132] + - [onRemoteDeviceConnectFailed][133] +- [RemotePayload][134] + - [Parameters][135] + - [player][136] +- [RemoteConnectedPayload][137] + - [Parameters][138] + - [ui][139] + - [session][140] +- [RemoteDisconnectedPayload][141] + - [Parameters][142] + - [snapshot][143] +- [RemoteAvailablePayload][144] + - [Parameters][145] + - [available][146] +- [RemotePlayerUI][147] + - [playbackUI][148] + - [Parameters][149] + - [idleUI][150] + - [Parameters][151] + - [adsUI][152] + - [Parameters][153] + - [liveUI][154] + - [Parameters][155] + - [errorUI][156] + - [Parameters][157] + - [uis][158] +- [IRemotePlayer][159] + - [textStyle][160] + - [muted][161] + - [playbackRate][162] + - [volume][163] + - [currentTime][164] + - [buffered][165] + - [duration][166] + - [paused][167] + - [ended][168] + - [seeking][169] + - [src][170] + - [poster][171] + - [engineType][172] + - [streamType][173] + - [type][174] + - [ads][175] + - [addEventListener][176] + - [Parameters][177] + - [removeEventListener][178] - [Parameters][179] - - [removeEventListener][180] + - [dispatchEvent][180] - [Parameters][181] - - [dispatchEvent][182] + - [loadMedia][182] - [Parameters][183] - - [loadMedia][184] + - [setMedia][184] - [Parameters][185] - - [setMedia][186] - - [Parameters][187] - - [getMediaInfo][188] - - [configure][189] - - [Parameters][190] - - [ready][191] - - [load][192] - - [play][193] - - [pause][194] - - [reset][195] - - [destroy][196] - - [isLive][197] - - [isDvr][198] - - [seekToLiveEdge][199] - - [getStartTimeOfDvrWindow][200] - - [getTracks][201] - - [Parameters][202] - - [getActiveTracks][203] - - [selectTrack][204] - - [Parameters][205] - - [hideTextTrack][206] - - [enableAdaptiveBitrate][207] - - [isAdaptiveBitrateEnabled][208] - - [setTextDisplaySettings][209] - - [Parameters][210] - - [startCasting][211] - - [stopCasting][212] - - [isCasting][213] - - [isCastAvailable][214] - - [getCastSession][215] - - [isVr][216] - - [toggleVrStereoMode][217] - - [isInVrStereoMode][218] - - [Type][219] - - [isSupported][220] -- [RemoteSession][221] - - [Parameters][222] - - [deviceFriendlyName][223] - - [id][224] - - [resuming][225] -- [PlaylistEventType][226] - - [Examples][227] -- [PlaylistItem][228] - - [Parameters][229] - - [sources][230] - - [config][231] - - [isPlayable][232] -- [PlaylistManager][233] - - [Parameters][234] - - [playNext][235] - - [playPrev][236] - - [playItem][237] - - [Parameters][238] - - [items][239] - - [next][240] - - [prev][241] - - [id][242] - - [metadata][243] - - [countdown][244] - - [options][245] -- [getPlayers][246] -- [getPlayer][247] - - [Parameters][248] + - [getMediaInfo][186] + - [configure][187] + - [Parameters][188] + - [ready][189] + - [load][190] + - [play][191] + - [pause][192] + - [reset][193] + - [destroy][194] + - [isLive][195] + - [isDvr][196] + - [seekToLiveEdge][197] + - [getStartTimeOfDvrWindow][198] + - [getTracks][199] + - [Parameters][200] + - [getActiveTracks][201] + - [selectTrack][202] + - [Parameters][203] + - [hideTextTrack][204] + - [enableAdaptiveBitrate][205] + - [isAdaptiveBitrateEnabled][206] + - [setTextDisplaySettings][207] + - [Parameters][208] + - [startCasting][209] + - [stopCasting][210] + - [isCasting][211] + - [isCastAvailable][212] + - [getCastSession][213] + - [isVr][214] + - [toggleVrStereoMode][215] + - [isInVrStereoMode][216] + - [Type][217] + - [isSupported][218] +- [RemoteSession][219] + - [Parameters][220] + - [deviceFriendlyName][221] + - [id][222] + - [resuming][223] +- [PlaylistEventType][224] + - [Examples][225] +- [PlaylistItem][226] + - [Parameters][227] + - [sources][228] + - [config][229] + - [isPlayable][230] +- [PlaylistManager][231] + - [Parameters][232] + - [playNext][233] + - [playPrev][234] + - [playItem][235] + - [Parameters][236] + - [items][237] + - [next][238] + - [prev][239] + - [id][240] + - [metadata][241] + - [countdown][242] + - [options][243] +- [getPlayers][244] +- [getPlayer][245] + - [Parameters][246] ## KalturaPlayers a map of player instances by player ids -Type: [Object][249]<[string][250], KalturaPlayer> +Type: [Object][247]<[string][248], KalturaPlayer> ## KPPlaylistConfigObject -Type: [Object][249] +Type: [Object][247] ### Parameters -- `id` **[string][250]** The playlist id -- `metadata` **[KPPlaylistMetadata][251]** The playlist metadata -- `options` **[KPPlaylistOptions][252]** The playlist options -- `countdown` **[KPPlaylistCountdownOptions][253]** The playlist countdown config -- `items` **[Array][254]<[PlaylistItem][255]>** The playlist items +- `id` **[string][248]** The playlist id +- `metadata` **[KPPlaylistMetadata][249]** The playlist metadata +- `options` **[KPPlaylistOptions][250]** The playlist options +- `countdown` **[KPPlaylistCountdownOptions][251]** The playlist countdown config +- `items` **[Array][252]<[PlaylistItem][253]>** The playlist items ## KPPlaylistCountdownOptions -Type: [Object][249] +Type: [Object][247] ### Parameters -- `timeToShow` **[number][256]?** When the countdown will appear (by default is towards the end) -- `duration` **[number][256]** How match time the countdown will appear (optional, default `10`) -- `showing` **[boolean][257]** Whether to show the countdown (optional, default `true`) +- `timeToShow` **[number][254]?** When the countdown will appear (by default is towards the end) +- `duration` **[number][254]** How match time the countdown will appear (optional, default `10`) +- `showing` **[boolean][255]** Whether to show the countdown (optional, default `true`) ## KPPlaylistItemConfigObject -Type: [Object][249] +Type: [Object][247] ### Properties -- `countdown` **[KPPlaylistCountdownOptions][253]?** Countdown options +- `countdown` **[KPPlaylistCountdownOptions][251]?** Countdown options ## KPPlaylistMetadata -Type: [Object][249] +Type: [Object][247] ### Properties -- `name` **[string][250]** The playlist name -- `description` **[string][250]** The playlist description +- `name` **[string][248]** The playlist name +- `description` **[string][248]** The playlist description ## KPPlaylistOptions -Type: [Object][249] +Type: [Object][247] ### Properties -- `autoContinue` **[boolean][257]** Whether to continue to the next item automatically +- `autoContinue` **[boolean][255]** Whether to continue to the next item automatically ## BaseRemotePlayer @@ -314,9 +312,9 @@ Remote players should extend this class and implement the needed API. ### Parameters -- `name` **[string][250]** Remote player name. -- `config` **[Object][249]** Cast configuration. -- `remoteControl` **[RemoteControl][258]** Remote control. +- `name` **[string][248]** Remote player name. +- `config` **[Object][247]** Cast configuration. +- `remoteControl` **[RemoteControl][256]** Remote control. ### loadMedia @@ -324,9 +322,9 @@ Loads a media to the receiver application. #### Parameters -- `mediaInfo` **[Object][249]** The entry media info. +- `mediaInfo` **[Object][247]** The entry media info. -Returns **[Promise][259]<void>** Promise to indicate load succeed or failed. +Returns **[Promise][257]<void>** Promise to indicate load succeed or failed. ### setMedia @@ -334,7 +332,7 @@ Sets a media to the remote player.. #### Parameters -- `mediaConfig` **[Object][249]** Media configuration to set. +- `mediaConfig` **[Object][247]** Media configuration to set. Returns **void** @@ -342,7 +340,7 @@ Returns **void** Gets the media Info. -Returns **[Object][249]?** The media info. +Returns **[Object][247]?** The media info. ### configure @@ -350,7 +348,7 @@ Configure the remote player #### Parameters -- `config` **[Object][249]** Configuration to set. (optional, default `{}`) +- `config` **[Object][247]** Configuration to set. (optional, default `{}`) Returns **void** @@ -358,7 +356,7 @@ Returns **void** The remote player readiness. -Returns **[Promise][259]<any>** Promise which resolved when the remote player is ready. +Returns **[Promise][257]<any>** Promise which resolved when the remote player is ready. ### load @@ -398,7 +396,7 @@ Returns **void** BaseRemotePlayer.prototype.isLive(); // false ``` -Returns **[boolean][257]** Whether the current playback is a live playback. +Returns **[boolean][255]** Whether the current playback is a live playback. ### isDvr @@ -408,7 +406,7 @@ Returns **[boolean][257]** Whether the current playback is a live playback. BaseRemotePlayer.prototype.isDvr(); // false ``` -Returns **[boolean][257]** Whether the current live playback has DVR window. In case of non-live playback will return false. +Returns **[boolean][255]** Whether the current live playback has DVR window. In case of non-live playback will return false. ### seekToLiveEdge @@ -424,13 +422,13 @@ Returns **void** BaseRemotePlayer.prototype.getStartTimeOfDvrWindow(); // 0 ``` -Returns **[number][256]** The start time of the DVR window. +Returns **[number][254]** The start time of the DVR window. ### getTracks #### Parameters -- `type` **[string][250]?** Track type. +- `type` **[string][248]?** Track type. #### Examples @@ -438,7 +436,7 @@ Returns **[number][256]** The start time of the DVR window. BaseRemotePlayer.prototype.getTracks(); // [] ``` -Returns **[Array][254]<Track>** The remote player tracks. +Returns **[Array][252]<Track>** The remote player tracks. ### getActiveTracks @@ -448,7 +446,7 @@ Returns **[Array][254]<Track>** The remote player tracks. BaseRemotePlayer.prototype.getTracks(); // {audio: undefined, video: undefined, text: undefined} ``` -Returns **[Object][249]** The remote player active tracks. +Returns **[Object][247]** The remote player active tracks. ### selectTrack @@ -480,7 +478,7 @@ Returns **void** BaseRemotePlayer.prototype.isAdaptiveBitrateEnabled(); // true ``` -Returns **[boolean][257]** Whether adaptive bitrate is enabled. +Returns **[boolean][255]** Whether adaptive bitrate is enabled. ### setTextDisplaySettings @@ -488,7 +486,7 @@ Sets the text display settings. #### Parameters -- `settings` **[Object][249]** Text settings. +- `settings` **[Object][247]** Text settings. Returns **void** @@ -496,7 +494,7 @@ Returns **void** Start casting. -Returns **[Promise][259]<any>** A promise to indicate session is starting, or failed +Returns **[Promise][257]<any>** A promise to indicate session is starting, or failed ### stopCasting @@ -512,7 +510,7 @@ Returns **void** BaseRemotePlayer.prototype.isCasting(); // true ``` -Returns **[boolean][257]** Whether casting is currently active. +Returns **[boolean][255]** Whether casting is currently active. ### isCastAvailable @@ -522,7 +520,7 @@ Returns **[boolean][257]** Whether casting is currently active. BaseRemotePlayer.prototype.isCastAvailable(); // true ``` -Returns **[boolean][257]** Whether casting is available. +Returns **[boolean][255]** Whether casting is available. ### getCastSession @@ -534,7 +532,7 @@ Gets the current remote session. BaseRemotePlayer.prototype.getCastSession(); // new RemoteSession('', '') ``` -Returns **[RemoteSession][260]** The remote session. +Returns **[RemoteSession][258]** The remote session. ### isVr @@ -544,7 +542,7 @@ Returns **[RemoteSession][260]** The remote session. BaseRemotePlayer.prototype.isVr(); // false ``` -Returns **[boolean][257]** Whether the current media is of VR type (360 content). +Returns **[boolean][255]** Whether the current media is of VR type (360 content). ### toggleVrStereoMode @@ -560,13 +558,13 @@ Returns **void** BaseRemotePlayer.prototype.isInVrStereoMode(); // false ``` -Returns **[boolean][257]** Whether the current content displayed in VR mode. +Returns **[boolean][255]** Whether the current content displayed in VR mode. ### ads The remote player ads controller. -Type: [Object][249]? +Type: [Object][247]? #### Examples @@ -574,7 +572,7 @@ Type: [Object][249]? BaseRemotePlayer.prototype.ads; // null ``` -Returns **[Object][249]?** +Returns **[Object][247]?** ### textStyle @@ -608,7 +606,7 @@ Gets the first buffered range of the remote player. BaseRemotePlayer.prototype.buffered; // [] ``` -Returns **[Array][254]<any>** First buffered range in seconds. +Returns **[Array][252]<any>** First buffered range in seconds. ### currentTime @@ -616,7 +614,7 @@ Setter. #### Parameters -- `to` **[number][256]** The number to set in seconds. +- `to` **[number][254]** The number to set in seconds. Returns **void** @@ -630,7 +628,7 @@ Getter. BaseRemotePlayer.prototype.currentTime; // 0 ``` -Returns **[number][256]** The current time in seconds. +Returns **[number][254]** The current time in seconds. ### duration @@ -640,7 +638,7 @@ Returns **[number][256]** The current time in seconds. BaseRemotePlayer.prototype.duration; // 0 ``` -Returns **[number][256]** The duration in seconds. +Returns **[number][254]** The duration in seconds. ### volume @@ -648,7 +646,7 @@ Setter. #### Parameters -- `vol` **[number][256]** The volume to set in the range of 0-1. +- `vol` **[number][254]** The volume to set in the range of 0-1. Returns **void** @@ -662,7 +660,7 @@ Getter. BaseRemotePlayer.prototype.volume; // 1 ``` -Returns **[number][256]** The current volume in the range of 0-1. +Returns **[number][254]** The current volume in the range of 0-1. ### paused @@ -672,7 +670,7 @@ Returns **[number][256]** The current volume in the range of 0-1. BaseRemotePlayer.prototype.paused; // false ``` -Returns **[boolean][257]** Whether the cast player is in paused state. +Returns **[boolean][255]** Whether the cast player is in paused state. ### ended @@ -682,7 +680,7 @@ Returns **[boolean][257]** Whether the cast player is in paused state. BaseRemotePlayer.prototype.ended; // false ``` -Returns **[boolean][257]** Whether the cast player is in ended state. +Returns **[boolean][255]** Whether the cast player is in ended state. ### seeking @@ -692,7 +690,7 @@ Returns **[boolean][257]** Whether the cast player is in ended state. BaseRemotePlayer.prototype.seeking; // false ``` -Returns **[boolean][257]** Whether the cast player is in seeking state. +Returns **[boolean][255]** Whether the cast player is in seeking state. ### muted @@ -700,7 +698,7 @@ Setter. #### Parameters -- `mute` **[boolean][257]** The mute value to set. +- `mute` **[boolean][255]** The mute value to set. Returns **void** @@ -714,7 +712,7 @@ Getter. BaseRemotePlayer.prototype.muted; // false ``` -Returns **[boolean][257]** The muted state. +Returns **[boolean][255]** The muted state. ### src @@ -724,7 +722,7 @@ Returns **[boolean][257]** The muted state. BaseRemotePlayer.prototype.src; // '' ``` -Returns **[string][250]** The current playing source url. +Returns **[string][248]** The current playing source url. ### poster @@ -734,7 +732,7 @@ Returns **[string][250]** The current playing source url. BaseRemotePlayer.prototype.poster; // '' ``` -Returns **[string][250]** The current poster url. +Returns **[string][248]** The current poster url. ### playbackRate @@ -742,7 +740,7 @@ Setter. #### Parameters -- `rate` **[number][256]** The playback rate to set. +- `rate` **[number][254]** The playback rate to set. Returns **void** @@ -754,7 +752,7 @@ Returns **void** BaseRemotePlayer.prototype.playbackRate; // 1 ``` -Returns **[string][250]** The current playback rate. +Returns **[string][248]** The current playback rate. ### engineType @@ -764,7 +762,7 @@ Returns **[string][250]** The current playback rate. BaseRemotePlayer.prototype.engineType; // '' ``` -Returns **[string][250]** The active engine type. +Returns **[string][248]** The active engine type. ### streamType @@ -774,11 +772,7 @@ Returns **[string][250]** The active engine type. BaseRemotePlayer.prototype.streamType; // '' ``` -Returns **[string][250]** The active stream type. - -### config - -Returns **[Object][249]** The runtime cast config. +Returns **[string][248]** The active stream type. ### type @@ -788,13 +782,13 @@ Returns **[Object][249]** The runtime cast config. BaseRemotePlayer.prototype.type; // BaseRemotePlayer.Type ``` -Returns **[string][250]** The remote player type. +Returns **[string][248]** The remote player type. ### defaultConfig Default configuration of the remote player. -Type: [Object][249] +Type: [Object][247] #### Examples @@ -806,7 +800,7 @@ BaseRemotePlayer.defaultConfig; // {} Remote player type. -Type: [string][250] +Type: [string][248] #### Examples @@ -822,11 +816,11 @@ BaseRemotePlayer.Type; // 'BaseRemotePlayer' BaseRemotePlayer.isSupported(); // true ``` -Returns **[boolean][257]** Whether the remote player is supported in the current environment. +Returns **[boolean][255]** Whether the remote player is supported in the current environment. ## CastEventType -Type: [Object][249] +Type: [Object][247] ### Examples @@ -854,19 +848,19 @@ player.addEventListener(KalturaPlayer.cast.CastEventType.CAST_SESSION_STARTED, e ### startTime -Type: [number][256] +Type: [number][254] ### autoplay -Type: [boolean][257] +Type: [boolean][255] ### audioLanguage -Type: [string][250] +Type: [string][248] ### textLanguage -Type: [string][250] +Type: [string][248] ### mediaInfo @@ -878,15 +872,15 @@ Type: TextStyle ### advertising -Type: [Object][249] +Type: [Object][247] ### volume -Type: [number][256] +Type: [number][254] ### muted -Type: [boolean][257] +Type: [boolean][255] ## RemoteControl @@ -898,15 +892,15 @@ Type: [boolean][257] Gets the player snapshot. -Type: [Function][261] +Type: [Function][259] -Returns **[PlayerSnapshot][262]** player snapshot. +Returns **[PlayerSnapshot][260]** player snapshot. ### getUIWrapper Gets the UI wrapper. -Type: [Function][261] +Type: [Function][259] Returns **UIWrapper** The UI wrapper. @@ -914,11 +908,11 @@ Returns **UIWrapper** The UI wrapper. On remote device disconnected handler. -Type: [Function][261] +Type: [Function][259] #### Parameters -- `payload` **[RemoteDisconnectedPayload][263]** disconnected payload. +- `payload` **[RemoteDisconnectedPayload][261]** disconnected payload. Returns **void** @@ -926,11 +920,11 @@ Returns **void** On remote device connected handler. -Type: [Function][261] +Type: [Function][259] #### Parameters -- `payload` **[RemoteConnectedPayload][264]** connected payload. +- `payload` **[RemoteConnectedPayload][262]** connected payload. Returns **void** @@ -938,11 +932,11 @@ Returns **void** On remote device available handler. -Type: [Function][261] +Type: [Function][259] #### Parameters -- `payload` **[RemoteAvailablePayload][265]** available payload. +- `payload` **[RemoteAvailablePayload][263]** available payload. Returns **void** @@ -950,7 +944,7 @@ Returns **void** On remote device connecting handler. -Type: [Function][261] +Type: [Function][259] Returns **void** @@ -958,7 +952,7 @@ Returns **void** On remote device disconnecting handler. -Type: [Function][261] +Type: [Function][259] Returns **void** @@ -966,7 +960,7 @@ Returns **void** On remote device connect failed handler. -Type: [Function][261] +Type: [Function][259] Returns **void** @@ -974,15 +968,15 @@ Returns **void** ### Parameters -- `player` **[BaseRemotePlayer][266]** The active remote player. +- `player` **[BaseRemotePlayer][264]** The active remote player. ### player The active remote player. -Type: [BaseRemotePlayer][266] +Type: [BaseRemotePlayer][264] -Returns **[BaseRemotePlayer][266]** +Returns **[BaseRemotePlayer][264]** ## RemoteConnectedPayload @@ -990,25 +984,25 @@ Returns **[BaseRemotePlayer][266]** ### Parameters -- `player` **[BaseRemotePlayer][266]** The active remote player. -- `session` **[RemoteSession][260]** The remote session. -- `ui` **[RemotePlayerUI][267]?** Optional remote player UI preset. +- `player` **[BaseRemotePlayer][264]** The active remote player. +- `session` **[RemoteSession][258]** The remote session. +- `ui` **[RemotePlayerUI][265]?** Optional remote player UI preset. ### ui Remote player UI preset. -Type: [RemotePlayerUI][267]? +Type: [RemotePlayerUI][265]? -Returns **[RemotePlayerUI][267]?** +Returns **[RemotePlayerUI][265]?** ### session Remote session. -Type: [RemoteSession][260] +Type: [RemoteSession][258] -Returns **[RemoteSession][260]?** +Returns **[RemoteSession][258]?** ## RemoteDisconnectedPayload @@ -1016,16 +1010,16 @@ Returns **[RemoteSession][260]?** ### Parameters -- `player` **[BaseRemotePlayer][266]** The active remote player. -- `snapshot` **[PlayerSnapshot][262]** The remote player snapshot. +- `player` **[BaseRemotePlayer][264]** The active remote player. +- `snapshot` **[PlayerSnapshot][260]** The remote player snapshot. ### snapshot Remote player snapshot. -Type: [PlayerSnapshot][262] +Type: [PlayerSnapshot][260] -Returns **[PlayerSnapshot][262]** +Returns **[PlayerSnapshot][260]** ## RemoteAvailablePayload @@ -1033,16 +1027,16 @@ Returns **[PlayerSnapshot][262]** ### Parameters -- `player` **[BaseRemotePlayer][266]** The active remote player. -- `available` **[boolean][257]** Remote player availability. +- `player` **[BaseRemotePlayer][264]** The active remote player. +- `available` **[boolean][255]** Remote player availability. ### available Remote player availability. -Type: [boolean][257] +Type: [boolean][255] -Returns **[boolean][257]** +Returns **[boolean][255]** ## RemotePlayerUI @@ -1052,7 +1046,7 @@ Playback UI of the remote player. #### Parameters -- `props` **[Object][249]** UI creation parameters. +- `props` **[Object][247]** UI creation parameters. Returns **React$Element<any>** Component. @@ -1062,7 +1056,7 @@ Idle UI of the remote player. #### Parameters -- `props` **[Object][249]** UI creation parameters. +- `props` **[Object][247]** UI creation parameters. Returns **React$Element<any>** Component. @@ -1072,7 +1066,7 @@ Idle UI of the remote player. #### Parameters -- `props` **[Object][249]** UI creation parameters. +- `props` **[Object][247]** UI creation parameters. Returns **React$Element<any>** Component. @@ -1082,7 +1076,7 @@ Live UI of the remote player. #### Parameters -- `props` **[Object][249]** UI creation parameters. +- `props` **[Object][247]** UI creation parameters. Returns **React$Element<any>** Component. @@ -1092,7 +1086,7 @@ Error UI of the remote player. #### Parameters -- `props` **[Object][249]** UI creation parameters. +- `props` **[Object][247]** UI creation parameters. Returns **React$Element<any>** Component. @@ -1100,9 +1094,9 @@ Returns **React$Element<any>** Component. UI presets. -Type: [Array][254]<UIPreset> +Type: [Array][252]<UIPreset> -Returns **[Array][254]<UIPreset>** +Returns **[Array][252]<UIPreset>** ## IRemotePlayer @@ -1112,81 +1106,77 @@ Type: TextStyle ### muted -Type: [boolean][257] +Type: [boolean][255] ### playbackRate -Type: [number][256] +Type: [number][254] ### volume -Type: [number][256] +Type: [number][254] ### currentTime -Type: [number][256] +Type: [number][254] ### buffered -Type: [number][256] +Type: [number][254] ### duration -Type: [number][256] +Type: [number][254] ### paused -Type: [boolean][257] +Type: [boolean][255] ### ended -Type: [boolean][257] +Type: [boolean][255] ### seeking -Type: [boolean][257] +Type: [boolean][255] ### src -Type: [string][250] +Type: [string][248] ### poster -Type: [string][250] - -### config - -Type: [Object][249] +Type: [string][248] ### engineType -Type: [string][250] +Type: [string][248] ### streamType -Type: [string][250] +Type: [string][248] ### type -Type: [string][250] +Type: [string][248] ### ads -Type: [Object][249] +Type: [Object][247] ### addEventListener #### Parameters -- `type` **[string][250]** -- `listener` **[Function][261]** +- `type` **[string][248]** +- `listener` **[Function][259]** ### removeEventListener #### Parameters -- `type` **[string][250]** -- `listener` **[Function][261]** +- `type` **[string][248]** +- `listener` **[Function][259]** ### dispatchEvent @@ -1198,27 +1188,27 @@ Type: [Object][249] #### Parameters -- `mediaInfo` **[Object][249]** +- `mediaInfo` **[Object][247]** ### setMedia #### Parameters -- `mediaConfig` **[Object][249]** +- `mediaConfig` **[Object][247]** ### getMediaInfo -Returns **[Object][249]** +Returns **[Object][247]** ### configure #### Parameters -- `config` **[Object][249]** +- `config` **[Object][247]** ### ready -Returns **[Promise][259]<any>** +Returns **[Promise][257]<any>** ### load @@ -1232,29 +1222,29 @@ Returns **[Promise][259]<any>** ### isLive -Returns **[boolean][257]** +Returns **[boolean][255]** ### isDvr -Returns **[boolean][257]** +Returns **[boolean][255]** ### seekToLiveEdge ### getStartTimeOfDvrWindow -Returns **[number][256]** +Returns **[number][254]** ### getTracks #### Parameters -- `type` **[string][250]?** +- `type` **[string][248]?** -Returns **[Array][254]<Track>** +Returns **[Array][252]<Track>** ### getActiveTracks -Returns **[Object][249]** +Returns **[Object][247]** ### selectTrack @@ -1268,13 +1258,13 @@ Returns **[Object][249]** ### isAdaptiveBitrateEnabled -Returns **[boolean][257]** +Returns **[boolean][255]** ### setTextDisplaySettings #### Parameters -- `settings` **[Object][249]** +- `settings` **[Object][247]** ### startCasting @@ -1282,69 +1272,69 @@ Returns **[boolean][257]** ### isCasting -Returns **[boolean][257]** +Returns **[boolean][255]** ### isCastAvailable -Returns **[boolean][257]** +Returns **[boolean][255]** ### getCastSession -Returns **[RemoteSession][260]** +Returns **[RemoteSession][258]** ### isVr -Returns **[boolean][257]** +Returns **[boolean][255]** ### toggleVrStereoMode ### isInVrStereoMode -Returns **[boolean][257]** +Returns **[boolean][255]** ### Type -Type: [string][250] +Type: [string][248] ### isSupported -Returns **[boolean][257]** +Returns **[boolean][255]** ## RemoteSession ### Parameters -- `id` **[string][250]** Session ID. -- `friendlyName` **[string][250]** Receiver friendly name. -- `resuming` **[boolean][257]?** Whether the session is resuming. +- `id` **[string][248]** Session ID. +- `friendlyName` **[string][248]** Receiver friendly name. +- `resuming` **[boolean][255]?** Whether the session is resuming. ### deviceFriendlyName Receiver friendly name. -Type: [string][250] +Type: [string][248] -Returns **[string][250]** +Returns **[string][248]** ### id Session ID. -Type: [string][250] +Type: [string][248] -Returns **[string][250]** +Returns **[string][248]** ### resuming Whether the session is resuming. -Type: [boolean][257]? +Type: [boolean][255]? -Returns **[boolean][257]?** +Returns **[boolean][255]?** ## PlaylistEventType -Type: [Object][249] +Type: [Object][247] ### Examples @@ -1367,7 +1357,7 @@ player.addEventListener(KalturaPlayer.playlist.PlaylistEventType.PLAYLIST_LOADED ### Parameters - `sources` **ProviderMediaConfigSourcesObject?** The item sources -- `config` **[KPPlaylistItemConfigObject][268]?** The item config +- `config` **[KPPlaylistItemConfigObject][266]?** The item config ### sources @@ -1381,13 +1371,13 @@ Returns **ProviderMediaConfigSourcesObject?** Playlist item config -Type: [KPPlaylistItemConfigObject][268]? +Type: [KPPlaylistItemConfigObject][266]? -Returns **[KPPlaylistItemConfigObject][268]?** +Returns **[KPPlaylistItemConfigObject][266]?** ### isPlayable -Returns **[boolean][257]** = Whether the playlist item has sources to play +Returns **[boolean][255]** = Whether the playlist item has sources to play ## PlaylistManager @@ -1414,7 +1404,7 @@ Play a specific item #### Parameters -- `index` **[number][256]** The index of the item to play +- `index` **[number][254]** The index of the item to play Returns **void** @@ -1422,63 +1412,63 @@ Returns **void** Playlist items -Type: [Array][254]<[PlaylistItem][255]> +Type: [Array][252]<[PlaylistItem][253]> -Returns **[Array][254]<[PlaylistItem][255]>** +Returns **[Array][252]<[PlaylistItem][253]>** ### next Next item -Type: [PlaylistItem][255]? +Type: [PlaylistItem][253]? -Returns **[PlaylistItem][255]?** +Returns **[PlaylistItem][253]?** ### prev Previous item -Type: [PlaylistItem][255]? +Type: [PlaylistItem][253]? -Returns **[PlaylistItem][255]?** +Returns **[PlaylistItem][253]?** ### id Playlist id -Type: [string][250] +Type: [string][248] -Returns **[string][250]** +Returns **[string][248]** ### metadata Playlist metadata -Type: [KPPlaylistMetadata][251] +Type: [KPPlaylistMetadata][249] -Returns **[KPPlaylistMetadata][251]** +Returns **[KPPlaylistMetadata][249]** ### countdown Playlist countdown -Type: [KPPlaylistCountdownOptions][253] +Type: [KPPlaylistCountdownOptions][251] -Returns **[KPPlaylistCountdownOptions][253]** +Returns **[KPPlaylistCountdownOptions][251]** ### options Playlist options -Type: [KPPlaylistOptions][252] +Type: [KPPlaylistOptions][250] -Returns **[KPPlaylistOptions][252]** +Returns **[KPPlaylistOptions][250]** ## getPlayers get all instantiated players -Returns **[KalturaPlayers][269]** map of player ids and their respective instantiated player +Returns **[KalturaPlayers][267]** map of player ids and their respective instantiated player ## getPlayer @@ -1486,7 +1476,7 @@ get a player instance by id ### Parameters -- `id` **[string][250]** the player ID +- `id` **[string][248]** the player ID Returns **(KalturaPlayer | null)** the player if found by the supplied ID or null if key doesn't exist @@ -1589,173 +1579,171 @@ Returns **(KalturaPlayer | null)** the player if found by the supplied ID or nul [97]: #examples-24 [98]: #streamtype [99]: #examples-25 -[100]: #config -[101]: #type -[102]: #examples-26 -[103]: #defaultconfig -[104]: #examples-27 -[105]: #type-1 -[106]: #examples-28 -[107]: #issupported -[108]: #examples-29 -[109]: #casteventtype -[110]: #examples-30 -[111]: #playersnapshot -[112]: #parameters-14 -[113]: #starttime -[114]: #autoplay -[115]: #audiolanguage -[116]: #textlanguage -[117]: #mediainfo -[118]: #textstyle-2 -[119]: #advertising -[120]: #volume-2 -[121]: #muted-2 -[122]: #remotecontrol -[123]: #parameters-15 -[124]: #getplayersnapshot -[125]: #getuiwrapper -[126]: #onremotedevicedisconnected -[127]: #parameters-16 -[128]: #onremotedeviceconnected -[129]: #parameters-17 -[130]: #onremotedeviceavailable -[131]: #parameters-18 -[132]: #onremotedeviceconnecting -[133]: #onremotedevicedisconnecting -[134]: #onremotedeviceconnectfailed -[135]: #remotepayload -[136]: #parameters-19 -[137]: #player -[138]: #remoteconnectedpayload -[139]: #parameters-20 -[140]: #ui -[141]: #session -[142]: #remotedisconnectedpayload -[143]: #parameters-21 -[144]: #snapshot -[145]: #remoteavailablepayload -[146]: #parameters-22 -[147]: #available -[148]: #remoteplayerui -[149]: #playbackui -[150]: #parameters-23 -[151]: #idleui -[152]: #parameters-24 -[153]: #adsui -[154]: #parameters-25 -[155]: #liveui -[156]: #parameters-26 -[157]: #errorui -[158]: #parameters-27 -[159]: #uis -[160]: #iremoteplayer -[161]: #textstyle-3 -[162]: #muted-3 -[163]: #playbackrate-2 -[164]: #volume-3 -[165]: #currenttime-2 -[166]: #buffered-1 -[167]: #duration-1 -[168]: #paused-1 -[169]: #ended-1 -[170]: #seeking-1 -[171]: #src-1 -[172]: #poster-1 -[173]: #config-1 -[174]: #enginetype-1 -[175]: #streamtype-1 -[176]: #type-2 -[177]: #ads-1 -[178]: #addeventlistener -[179]: #parameters-28 -[180]: #removeeventlistener -[181]: #parameters-29 -[182]: #dispatchevent -[183]: #parameters-30 -[184]: #loadmedia-1 -[185]: #parameters-31 -[186]: #setmedia-1 -[187]: #parameters-32 -[188]: #getmediainfo-1 -[189]: #configure-1 -[190]: #parameters-33 -[191]: #ready-1 -[192]: #load-1 -[193]: #play-1 -[194]: #pause-1 -[195]: #reset-1 -[196]: #destroy-1 -[197]: #islive-1 -[198]: #isdvr-1 -[199]: #seektoliveedge-1 -[200]: #getstarttimeofdvrwindow-1 -[201]: #gettracks-1 -[202]: #parameters-34 -[203]: #getactivetracks-1 -[204]: #selecttrack-1 -[205]: #parameters-35 -[206]: #hidetexttrack-1 -[207]: #enableadaptivebitrate-1 -[208]: #isadaptivebitrateenabled-1 -[209]: #settextdisplaysettings-1 -[210]: #parameters-36 -[211]: #startcasting-1 -[212]: #stopcasting-1 -[213]: #iscasting-1 -[214]: #iscastavailable-1 -[215]: #getcastsession-1 -[216]: #isvr-1 -[217]: #togglevrstereomode-1 -[218]: #isinvrstereomode-1 -[219]: #type-3 -[220]: #issupported-1 -[221]: #remotesession -[222]: #parameters-37 -[223]: #devicefriendlyname -[224]: #id -[225]: #resuming -[226]: #playlisteventtype -[227]: #examples-31 -[228]: #playlistitem -[229]: #parameters-38 -[230]: #sources -[231]: #config-2 -[232]: #isplayable -[233]: #playlistmanager -[234]: #parameters-39 -[235]: #playnext -[236]: #playprev -[237]: #playitem -[238]: #parameters-40 -[239]: #items -[240]: #next -[241]: #prev -[242]: #id-1 -[243]: #metadata -[244]: #countdown -[245]: #options -[246]: #getplayers -[247]: #getplayer -[248]: #parameters-41 -[249]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[250]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[251]: #kpplaylistmetadata -[252]: #kpplaylistoptions -[253]: #kpplaylistcountdownoptions -[254]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[255]: #playlistitem -[256]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[257]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[258]: #remotecontrol -[259]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise -[260]: #remotesession -[261]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function -[262]: #playersnapshot -[263]: #remotedisconnectedpayload -[264]: #remoteconnectedpayload -[265]: #remoteavailablepayload -[266]: #baseremoteplayer -[267]: #remoteplayerui -[268]: #kpplaylistitemconfigobject -[269]: #kalturaplayers +[100]: #type +[101]: #examples-26 +[102]: #defaultconfig +[103]: #examples-27 +[104]: #type-1 +[105]: #examples-28 +[106]: #issupported +[107]: #examples-29 +[108]: #casteventtype +[109]: #examples-30 +[110]: #playersnapshot +[111]: #parameters-14 +[112]: #starttime +[113]: #autoplay +[114]: #audiolanguage +[115]: #textlanguage +[116]: #mediainfo +[117]: #textstyle-2 +[118]: #advertising +[119]: #volume-2 +[120]: #muted-2 +[121]: #remotecontrol +[122]: #parameters-15 +[123]: #getplayersnapshot +[124]: #getuiwrapper +[125]: #onremotedevicedisconnected +[126]: #parameters-16 +[127]: #onremotedeviceconnected +[128]: #parameters-17 +[129]: #onremotedeviceavailable +[130]: #parameters-18 +[131]: #onremotedeviceconnecting +[132]: #onremotedevicedisconnecting +[133]: #onremotedeviceconnectfailed +[134]: #remotepayload +[135]: #parameters-19 +[136]: #player +[137]: #remoteconnectedpayload +[138]: #parameters-20 +[139]: #ui +[140]: #session +[141]: #remotedisconnectedpayload +[142]: #parameters-21 +[143]: #snapshot +[144]: #remoteavailablepayload +[145]: #parameters-22 +[146]: #available +[147]: #remoteplayerui +[148]: #playbackui +[149]: #parameters-23 +[150]: #idleui +[151]: #parameters-24 +[152]: #adsui +[153]: #parameters-25 +[154]: #liveui +[155]: #parameters-26 +[156]: #errorui +[157]: #parameters-27 +[158]: #uis +[159]: #iremoteplayer +[160]: #textstyle-3 +[161]: #muted-3 +[162]: #playbackrate-2 +[163]: #volume-3 +[164]: #currenttime-2 +[165]: #buffered-1 +[166]: #duration-1 +[167]: #paused-1 +[168]: #ended-1 +[169]: #seeking-1 +[170]: #src-1 +[171]: #poster-1 +[172]: #enginetype-1 +[173]: #streamtype-1 +[174]: #type-2 +[175]: #ads-1 +[176]: #addeventlistener +[177]: #parameters-28 +[178]: #removeeventlistener +[179]: #parameters-29 +[180]: #dispatchevent +[181]: #parameters-30 +[182]: #loadmedia-1 +[183]: #parameters-31 +[184]: #setmedia-1 +[185]: #parameters-32 +[186]: #getmediainfo-1 +[187]: #configure-1 +[188]: #parameters-33 +[189]: #ready-1 +[190]: #load-1 +[191]: #play-1 +[192]: #pause-1 +[193]: #reset-1 +[194]: #destroy-1 +[195]: #islive-1 +[196]: #isdvr-1 +[197]: #seektoliveedge-1 +[198]: #getstarttimeofdvrwindow-1 +[199]: #gettracks-1 +[200]: #parameters-34 +[201]: #getactivetracks-1 +[202]: #selecttrack-1 +[203]: #parameters-35 +[204]: #hidetexttrack-1 +[205]: #enableadaptivebitrate-1 +[206]: #isadaptivebitrateenabled-1 +[207]: #settextdisplaysettings-1 +[208]: #parameters-36 +[209]: #startcasting-1 +[210]: #stopcasting-1 +[211]: #iscasting-1 +[212]: #iscastavailable-1 +[213]: #getcastsession-1 +[214]: #isvr-1 +[215]: #togglevrstereomode-1 +[216]: #isinvrstereomode-1 +[217]: #type-3 +[218]: #issupported-1 +[219]: #remotesession +[220]: #parameters-37 +[221]: #devicefriendlyname +[222]: #id +[223]: #resuming +[224]: #playlisteventtype +[225]: #examples-31 +[226]: #playlistitem +[227]: #parameters-38 +[228]: #sources +[229]: #config +[230]: #isplayable +[231]: #playlistmanager +[232]: #parameters-39 +[233]: #playnext +[234]: #playprev +[235]: #playitem +[236]: #parameters-40 +[237]: #items +[238]: #next +[239]: #prev +[240]: #id-1 +[241]: #metadata +[242]: #countdown +[243]: #options +[244]: #getplayers +[245]: #getplayer +[246]: #parameters-41 +[247]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[248]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[249]: #kpplaylistmetadata +[250]: #kpplaylistoptions +[251]: #kpplaylistcountdownoptions +[252]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[253]: #playlistitem +[254]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[255]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[256]: #remotecontrol +[257]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise +[258]: #remotesession +[259]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function +[260]: #playersnapshot +[261]: #remotedisconnectedpayload +[262]: #remoteconnectedpayload +[263]: #remoteavailablepayload +[264]: #baseremoteplayer +[265]: #remoteplayerui +[266]: #kpplaylistitemconfigobject +[267]: #kalturaplayers diff --git a/src/common/cast/base-remote-player.js b/src/common/cast/base-remote-player.js index 9ddebec0d..6e1f3bdb3 100644 --- a/src/common/cast/base-remote-player.js +++ b/src/common/cast/base-remote-player.js @@ -558,15 +558,6 @@ class BaseRemotePlayer extends FakeEventTarget implements IRemotePlayer { return ''; } - /** - * @returns {Object} - The runtime cast config. - * @instance - * @memberof BaseRemotePlayer - */ - get config(): Object { - return this._config; - } - /** * @returns {string} - The remote player type. * @instance diff --git a/src/common/cast/remote-player.js b/src/common/cast/remote-player.js index 49b29c1fa..84fc47039 100644 --- a/src/common/cast/remote-player.js +++ b/src/common/cast/remote-player.js @@ -86,13 +86,6 @@ export interface IRemotePlayer { * @memberof IRemotePlayer */ +poster: string; - /** - * @readonly - * @type {Object} - * @instance - * @memberof IRemotePlayer - */ - +config: Object; /** * @readonly * @type {string}