diff --git a/docs/api.md b/docs/api.md index e1c5d85af..80d31de38 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,4 +1,4 @@ -# API + ### Table of Contents @@ -110,120 +110,126 @@ - [mediaInfo][106] - [textStyle][107] - [advertising][108] -- [RemoteControl][109] - - [Parameters][110] - - [getPlayerSnapshot][111] - - [getUIWrapper][112] - - [onRemoteDeviceDisconnected][113] - - [Parameters][114] - - [onRemoteDeviceConnected][115] + - [volume][109] + - [muted][110] +- [RemoteControl][111] + - [Parameters][112] + - [getPlayerSnapshot][113] + - [getUIWrapper][114] + - [onRemoteDeviceDisconnected][115] - [Parameters][116] - - [onRemoteDeviceAvailable][117] + - [onRemoteDeviceConnected][117] - [Parameters][118] - - [onRemoteDeviceConnecting][119] - - [onRemoteDeviceDisconnecting][120] - - [onRemoteDeviceConnectFailed][121] -- [RemotePayload][122] - - [Parameters][123] - - [player][124] -- [RemoteConnectedPayload][125] - - [Parameters][126] - - [ui][127] - - [session][128] -- [RemoteDisconnectedPayload][129] - - [Parameters][130] - - [snapshot][131] -- [RemoteAvailablePayload][132] - - [Parameters][133] - - [available][134] -- [RemotePlayerUI][135] - - [playbackUI][136] - - [Parameters][137] - - [idleUI][138] + - [onRemoteDeviceAvailable][119] + - [Parameters][120] + - [onRemoteDeviceConnecting][121] + - [onRemoteDeviceDisconnecting][122] + - [onRemoteDeviceConnectFailed][123] +- [RemotePayload][124] + - [Parameters][125] + - [player][126] +- [RemoteConnectedPayload][127] + - [Parameters][128] + - [ui][129] + - [session][130] +- [RemoteDisconnectedPayload][131] + - [Parameters][132] + - [snapshot][133] +- [RemoteAvailablePayload][134] + - [Parameters][135] + - [available][136] +- [RemotePlayerUI][137] + - [playbackUI][138] - [Parameters][139] - - [adsUI][140] + - [idleUI][140] - [Parameters][141] - - [liveUI][142] + - [adsUI][142] - [Parameters][143] - - [errorUI][144] + - [liveUI][144] - [Parameters][145] - - [uis][146] -- [IRemotePlayer][147] - - [textStyle][148] - - [muted][149] - - [playbackRate][150] - - [volume][151] - - [currentTime][152] - - [buffered][153] - - [duration][154] - - [paused][155] - - [ended][156] - - [seeking][157] - - [src][158] - - [poster][159] - - [config][160] - - [engineType][161] - - [streamType][162] - - [type][163] - - [ads][164] - - [addEventListener][165] - - [Parameters][166] - - [removeEventListener][167] + - [errorUI][146] + - [Parameters][147] + - [uis][148] +- [IRemotePlayer][149] + - [textStyle][150] + - [muted][151] + - [playbackRate][152] + - [volume][153] + - [currentTime][154] + - [buffered][155] + - [duration][156] + - [paused][157] + - [ended][158] + - [seeking][159] + - [src][160] + - [poster][161] + - [config][162] + - [engineType][163] + - [streamType][164] + - [type][165] + - [ads][166] + - [addEventListener][167] - [Parameters][168] - - [dispatchEvent][169] + - [removeEventListener][169] - [Parameters][170] - - [loadMedia][171] + - [dispatchEvent][171] - [Parameters][172] - - [setMedia][173] + - [loadMedia][173] - [Parameters][174] - - [getMediaInfo][175] - - [configure][176] - - [Parameters][177] - - [ready][178] - - [load][179] - - [play][180] - - [pause][181] - - [reset][182] - - [destroy][183] - - [isLive][184] - - [isDvr][185] - - [seekToLiveEdge][186] - - [getStartTimeOfDvrWindow][187] - - [getTracks][188] - - [Parameters][189] - - [getActiveTracks][190] - - [selectTrack][191] - - [Parameters][192] - - [hideTextTrack][193] - - [enableAdaptiveBitrate][194] - - [isAdaptiveBitrateEnabled][195] - - [setTextDisplaySettings][196] - - [Parameters][197] - - [startCasting][198] - - [stopCasting][199] - - [isCasting][200] - - [isCastAvailable][201] - - [getCastSession][202] - - [isVr][203] - - [toggleVrStereoMode][204] - - [isInVrStereoMode][205] - - [Type][206] - - [isSupported][207] -- [RemoteSession][208] - - [Parameters][209] - - [deviceFriendlyName][210] - - [id][211] - - [resuming][212] + - [setMedia][175] + - [Parameters][176] + - [getMediaInfo][177] + - [configure][178] + - [Parameters][179] + - [ready][180] + - [load][181] + - [play][182] + - [pause][183] + - [reset][184] + - [destroy][185] + - [isLive][186] + - [isDvr][187] + - [seekToLiveEdge][188] + - [getStartTimeOfDvrWindow][189] + - [getTracks][190] + - [Parameters][191] + - [getActiveTracks][192] + - [selectTrack][193] + - [Parameters][194] + - [hideTextTrack][195] + - [enableAdaptiveBitrate][196] + - [isAdaptiveBitrateEnabled][197] + - [setTextDisplaySettings][198] + - [Parameters][199] + - [startCasting][200] + - [stopCasting][201] + - [isCasting][202] + - [isCastAvailable][203] + - [getCastSession][204] + - [isVr][205] + - [toggleVrStereoMode][206] + - [isInVrStereoMode][207] + - [Type][208] + - [isSupported][209] +- [RemoteSession][210] + - [Parameters][211] + - [deviceFriendlyName][212] + - [id][213] + - [resuming][214] ## BaseRemotePlayer **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. + ### Parameters -- `name` **[string][213]** Remote player name. -- `config` **[Object][214]** Cast configuration. -- `remoteControl` **[RemoteControl][215]** Remote control. +- `name` **[string][215]** Remote player name. +- `config` **[Object][216]** Cast configuration. +- `remoteControl` **[RemoteControl][217]** Remote control. ### loadMedia @@ -231,9 +237,9 @@ Loads a media to the receiver application. #### Parameters -- `mediaInfo` **[Object][214]** The entry media info. +- `mediaInfo` **[Object][216]** The entry media info. -Returns **[Promise][216]<void>** Promise to indicate load succeed or failed. +Returns **[Promise][218]<void>** Promise to indicate load succeed or failed. ### setMedia @@ -241,7 +247,7 @@ Sets a media to the remote player.. #### Parameters -- `mediaConfig` **[Object][214]** Media configuration to set. +- `mediaConfig` **[Object][216]** Media configuration to set. Returns **void** @@ -249,7 +255,7 @@ Returns **void** Gets the media Info. -Returns **[Object][214]?** The media info. +Returns **[Object][216]?** The media info. ### configure @@ -257,7 +263,7 @@ Configure the remote player #### Parameters -- `config` **[Object][214]** Configuration to set. (optional, default `{}`) +- `config` **[Object][216]** Configuration to set. (optional, default `{}`) Returns **void** @@ -265,7 +271,7 @@ Returns **void** The remote player readiness. -Returns **[Promise][216]<any>** Promise which resolved when the remote player is ready. +Returns **[Promise][218]<any>** Promise which resolved when the remote player is ready. ### load @@ -305,7 +311,7 @@ Returns **void** BaseRemotePlayer.prototype.isLive(); // false ``` -Returns **[boolean][217]** Whether the current playback is a live playback. +Returns **[boolean][219]** Whether the current playback is a live playback. ### isDvr @@ -315,7 +321,7 @@ Returns **[boolean][217]** Whether the current playback is a live playback. BaseRemotePlayer.prototype.isDvr(); // false ``` -Returns **[boolean][217]** Whether the current live playback has DVR window. In case of non-live playback will return false. +Returns **[boolean][219]** Whether the current live playback has DVR window. In case of non-live playback will return false. ### seekToLiveEdge @@ -331,13 +337,13 @@ Returns **void** BaseRemotePlayer.prototype.getStartTimeOfDvrWindow(); // 0 ``` -Returns **[number][218]** The start time of the DVR window. +Returns **[number][220]** The start time of the DVR window. ### getTracks #### Parameters -- `type` **[string][213]?** Track type. +- `type` **[string][215]?** Track type. #### Examples @@ -345,7 +351,7 @@ Returns **[number][218]** The start time of the DVR window. BaseRemotePlayer.prototype.getTracks(); // [] ``` -Returns **[Array][219]<Track>** The remote player tracks. +Returns **[Array][221]<Track>** The remote player tracks. ### getActiveTracks @@ -355,7 +361,7 @@ Returns **[Array][219]<Track>** The remote player tracks. BaseRemotePlayer.prototype.getTracks(); // {audio: undefined, video: undefined, text: undefined} ``` -Returns **[Object][214]** The remote player active tracks. +Returns **[Object][216]** The remote player active tracks. ### selectTrack @@ -387,7 +393,7 @@ Returns **void** BaseRemotePlayer.prototype.isAdaptiveBitrateEnabled(); // true ``` -Returns **[boolean][217]** Whether adaptive bitrate is enabled. +Returns **[boolean][219]** Whether adaptive bitrate is enabled. ### setTextDisplaySettings @@ -395,7 +401,7 @@ Sets the text display settings. #### Parameters -- `settings` **[Object][214]** Text settings. +- `settings` **[Object][216]** Text settings. Returns **void** @@ -403,7 +409,7 @@ Returns **void** Start casting. -Returns **[Promise][216]<any>** A promise to indicate session is starting, or failed +Returns **[Promise][218]<any>** A promise to indicate session is starting, or failed ### stopCasting @@ -419,7 +425,7 @@ Returns **void** BaseRemotePlayer.prototype.isCasting(); // true ``` -Returns **[boolean][217]** Whether casting is currently active. +Returns **[boolean][219]** Whether casting is currently active. ### isCastAvailable @@ -429,7 +435,7 @@ Returns **[boolean][217]** Whether casting is currently active. BaseRemotePlayer.prototype.isCastAvailable(); // true ``` -Returns **[boolean][217]** Whether casting is available. +Returns **[boolean][219]** Whether casting is available. ### getCastSession @@ -441,7 +447,7 @@ Gets the current remote session. BaseRemotePlayer.prototype.getCastSession(); // new RemoteSession('', '') ``` -Returns **[RemoteSession][220]** The remote session. +Returns **[RemoteSession][222]** The remote session. ### isVr @@ -451,7 +457,7 @@ Returns **[RemoteSession][220]** The remote session. BaseRemotePlayer.prototype.isVr(); // false ``` -Returns **[boolean][217]** Whether the current media is of VR type (360 content). +Returns **[boolean][219]** Whether the current media is of VR type (360 content). ### toggleVrStereoMode @@ -467,13 +473,13 @@ Returns **void** BaseRemotePlayer.prototype.isInVrStereoMode(); // false ``` -Returns **[boolean][217]** Whether the current content displayed in VR mode. +Returns **[boolean][219]** Whether the current content displayed in VR mode. ### ads The remote player ads controller. -Type: [Object][214]? +Type: [Object][216]? #### Examples @@ -481,7 +487,7 @@ Type: [Object][214]? BaseRemotePlayer.prototype.ads; // null ``` -Returns **[Object][214]?** +Returns **[Object][216]?** ### textStyle @@ -515,7 +521,7 @@ Gets the first buffered range of the remote player. BaseRemotePlayer.prototype.buffered; // [] ``` -Returns **[Array][219]<any>** First buffered range in seconds. +Returns **[Array][221]<any>** First buffered range in seconds. ### currentTime @@ -523,7 +529,7 @@ Setter. #### Parameters -- `to` **[number][218]** The number to set in seconds. +- `to` **[number][220]** The number to set in seconds. Returns **void** @@ -537,7 +543,7 @@ Getter. BaseRemotePlayer.prototype.currentTime; // 0 ``` -Returns **[number][218]** The current time in seconds. +Returns **[number][220]** The current time in seconds. ### duration @@ -547,7 +553,7 @@ Returns **[number][218]** The current time in seconds. BaseRemotePlayer.prototype.duration; // 0 ``` -Returns **[number][218]** The duration in seconds. +Returns **[number][220]** The duration in seconds. ### volume @@ -555,7 +561,7 @@ Setter. #### Parameters -- `vol` **[number][218]** The volume to set in the range of 0-1. +- `vol` **[number][220]** The volume to set in the range of 0-1. Returns **void** @@ -569,7 +575,7 @@ Getter. BaseRemotePlayer.prototype.volume; // 1 ``` -Returns **[number][218]** The current volume in the range of 0-1. +Returns **[number][220]** The current volume in the range of 0-1. ### paused @@ -579,7 +585,7 @@ Returns **[number][218]** The current volume in the range of 0-1. BaseRemotePlayer.prototype.paused; // false ``` -Returns **[boolean][217]** Whether the cast player is in paused state. +Returns **[boolean][219]** Whether the cast player is in paused state. ### ended @@ -589,7 +595,7 @@ Returns **[boolean][217]** Whether the cast player is in paused state. BaseRemotePlayer.prototype.ended; // false ``` -Returns **[boolean][217]** Whether the cast player is in ended state. +Returns **[boolean][219]** Whether the cast player is in ended state. ### seeking @@ -599,7 +605,7 @@ Returns **[boolean][217]** Whether the cast player is in ended state. BaseRemotePlayer.prototype.seeking; // false ``` -Returns **[boolean][217]** Whether the cast player is in seeking state. +Returns **[boolean][219]** Whether the cast player is in seeking state. ### muted @@ -607,7 +613,7 @@ Setter. #### Parameters -- `mute` **[boolean][217]** The mute value to set. +- `mute` **[boolean][219]** The mute value to set. Returns **void** @@ -621,7 +627,7 @@ Getter. BaseRemotePlayer.prototype.muted; // false ``` -Returns **[boolean][217]** The muted state. +Returns **[boolean][219]** The muted state. ### src @@ -631,7 +637,7 @@ Returns **[boolean][217]** The muted state. BaseRemotePlayer.prototype.src; // '' ``` -Returns **[string][213]** The current playing source url. +Returns **[string][215]** The current playing source url. ### poster @@ -641,7 +647,7 @@ Returns **[string][213]** The current playing source url. BaseRemotePlayer.prototype.poster; // '' ``` -Returns **[string][213]** The current poster url. +Returns **[string][215]** The current poster url. ### playbackRate @@ -649,7 +655,7 @@ Setter. #### Parameters -- `rate` **[number][218]** The playback rate to set. +- `rate` **[number][220]** The playback rate to set. Returns **void** @@ -661,7 +667,7 @@ Returns **void** BaseRemotePlayer.prototype.playbackRate; // 1 ``` -Returns **[string][213]** The current playback rate. +Returns **[string][215]** The current playback rate. ### engineType @@ -671,7 +677,7 @@ Returns **[string][213]** The current playback rate. BaseRemotePlayer.prototype.engineType; // '' ``` -Returns **[string][213]** The active engine type. +Returns **[string][215]** The active engine type. ### streamType @@ -681,11 +687,11 @@ Returns **[string][213]** The active engine type. BaseRemotePlayer.prototype.streamType; // '' ``` -Returns **[string][213]** The active stream type. +Returns **[string][215]** The active stream type. ### config -Returns **[Object][214]** The runtime cast config. +Returns **[Object][216]** The runtime cast config. ### type @@ -695,13 +701,13 @@ Returns **[Object][214]** The runtime cast config. BaseRemotePlayer.prototype.type; // BaseRemotePlayer.Type ``` -Returns **[string][213]** The remote player type. +Returns **[string][215]** The remote player type. ### defaultConfig Default configuration of the remote player. -Type: [Object][214] +Type: [Object][216] #### Examples @@ -713,7 +719,7 @@ BaseRemotePlayer.defaultConfig; // {} Remote player type. -Type: [string][213] +Type: [string][215] #### Examples @@ -729,11 +735,11 @@ BaseRemotePlayer.Type; // 'BaseRemotePlayer' BaseRemotePlayer.isSupported(); // true ``` -Returns **[boolean][217]** Whether the remote player is supported in the current environment. +Returns **[boolean][219]** Whether the remote player is supported in the current environment. ## CastEventType -Type: [Object][214] +Type: [Object][216] ### Examples @@ -761,19 +767,19 @@ player.addEventListener(KalturaPlayer.cast.CastEventType.CAST_SESSION_STARTED, e ### startTime -Type: [number][218] +Type: [number][220] ### autoplay -Type: [boolean][217] +Type: [boolean][219] ### audioLanguage -Type: [string][213] +Type: [string][215] ### textLanguage -Type: [string][213] +Type: [string][215] ### mediaInfo @@ -785,7 +791,15 @@ Type: TextStyle ### advertising -Type: [Object][214] +Type: [Object][216] + +### volume + +Type: [number][220] + +### muted + +Type: [boolean][219] ## RemoteControl @@ -797,15 +811,15 @@ Type: [Object][214] Gets the player snapshot. -Type: [Function][221] +Type: [Function][223] -Returns **[PlayerSnapshot][222]** player snapshot. +Returns **[PlayerSnapshot][224]** player snapshot. ### getUIWrapper Gets the UI wrapper. -Type: [Function][221] +Type: [Function][223] Returns **UIWrapper** The UI wrapper. @@ -813,11 +827,11 @@ Returns **UIWrapper** The UI wrapper. On remote device disconnected handler. -Type: [Function][221] +Type: [Function][223] #### Parameters -- `payload` **[RemoteDisconnectedPayload][223]** disconnected payload. +- `payload` **[RemoteDisconnectedPayload][225]** disconnected payload. Returns **void** @@ -825,11 +839,11 @@ Returns **void** On remote device connected handler. -Type: [Function][221] +Type: [Function][223] #### Parameters -- `payload` **[RemoteConnectedPayload][224]** connected payload. +- `payload` **[RemoteConnectedPayload][226]** connected payload. Returns **void** @@ -837,11 +851,11 @@ Returns **void** On remote device available handler. -Type: [Function][221] +Type: [Function][223] #### Parameters -- `payload` **[RemoteAvailablePayload][225]** available payload. +- `payload` **[RemoteAvailablePayload][227]** available payload. Returns **void** @@ -849,7 +863,7 @@ Returns **void** On remote device connecting handler. -Type: [Function][221] +Type: [Function][223] Returns **void** @@ -857,7 +871,7 @@ Returns **void** On remote device disconnecting handler. -Type: [Function][221] +Type: [Function][223] Returns **void** @@ -865,7 +879,7 @@ Returns **void** On remote device connect failed handler. -Type: [Function][221] +Type: [Function][223] Returns **void** @@ -873,15 +887,15 @@ Returns **void** ### Parameters -- `player` **[BaseRemotePlayer][226]** The active remote player. +- `player` **[BaseRemotePlayer][228]** The active remote player. ### player The active remote player. -Type: [BaseRemotePlayer][226] +Type: [BaseRemotePlayer][228] -Returns **[BaseRemotePlayer][226]** +Returns **[BaseRemotePlayer][228]** ## RemoteConnectedPayload @@ -889,25 +903,25 @@ Returns **[BaseRemotePlayer][226]** ### Parameters -- `player` **[BaseRemotePlayer][226]** The active remote player. -- `session` **[RemoteSession][220]** The remote session. -- `ui` **[RemotePlayerUI][227]?** Optional remote player UI preset. +- `player` **[BaseRemotePlayer][228]** The active remote player. +- `session` **[RemoteSession][222]** The remote session. +- `ui` **[RemotePlayerUI][229]?** Optional remote player UI preset. ### ui Remote player UI preset. -Type: [RemotePlayerUI][227]? +Type: [RemotePlayerUI][229]? -Returns **[RemotePlayerUI][227]?** +Returns **[RemotePlayerUI][229]?** ### session Remote session. -Type: [RemoteSession][220] +Type: [RemoteSession][222] -Returns **[RemoteSession][220]?** +Returns **[RemoteSession][222]?** ## RemoteDisconnectedPayload @@ -915,16 +929,16 @@ Returns **[RemoteSession][220]?** ### Parameters -- `player` **[BaseRemotePlayer][226]** The active remote player. -- `snapshot` **[PlayerSnapshot][222]** The remote player snapshot. +- `player` **[BaseRemotePlayer][228]** The active remote player. +- `snapshot` **[PlayerSnapshot][224]** The remote player snapshot. ### snapshot Remote player snapshot. -Type: [PlayerSnapshot][222] +Type: [PlayerSnapshot][224] -Returns **[PlayerSnapshot][222]** +Returns **[PlayerSnapshot][224]** ## RemoteAvailablePayload @@ -932,16 +946,16 @@ Returns **[PlayerSnapshot][222]** ### Parameters -- `player` **[BaseRemotePlayer][226]** The active remote player. -- `available` **[boolean][217]** Remote player availability. +- `player` **[BaseRemotePlayer][228]** The active remote player. +- `available` **[boolean][219]** Remote player availability. ### available Remote player availability. -Type: [boolean][217] +Type: [boolean][219] -Returns **[boolean][217]** +Returns **[boolean][219]** ## RemotePlayerUI @@ -951,7 +965,7 @@ Playback UI of the remote player. #### Parameters -- `props` **[Object][214]** UI creation parameters. +- `props` **[Object][216]** UI creation parameters. Returns **React$Element<any>** Component. @@ -961,7 +975,7 @@ Idle UI of the remote player. #### Parameters -- `props` **[Object][214]** UI creation parameters. +- `props` **[Object][216]** UI creation parameters. Returns **React$Element<any>** Component. @@ -971,7 +985,7 @@ Idle UI of the remote player. #### Parameters -- `props` **[Object][214]** UI creation parameters. +- `props` **[Object][216]** UI creation parameters. Returns **React$Element<any>** Component. @@ -981,7 +995,7 @@ Live UI of the remote player. #### Parameters -- `props` **[Object][214]** UI creation parameters. +- `props` **[Object][216]** UI creation parameters. Returns **React$Element<any>** Component. @@ -991,7 +1005,7 @@ Error UI of the remote player. #### Parameters -- `props` **[Object][214]** UI creation parameters. +- `props` **[Object][216]** UI creation parameters. Returns **React$Element<any>** Component. @@ -999,9 +1013,9 @@ Returns **React$Element<any>** Component. UI presets. -Type: [Array][219]<UIPreset> +Type: [Array][221]<UIPreset> -Returns **[Array][219]<UIPreset>** +Returns **[Array][221]<UIPreset>** ## IRemotePlayer @@ -1011,81 +1025,81 @@ Type: TextStyle ### muted -Type: [boolean][217] +Type: [boolean][219] ### playbackRate -Type: [number][218] +Type: [number][220] ### volume -Type: [number][218] +Type: [number][220] ### currentTime -Type: [number][218] +Type: [number][220] ### buffered -Type: [number][218] +Type: [number][220] ### duration -Type: [number][218] +Type: [number][220] ### paused -Type: [boolean][217] +Type: [boolean][219] ### ended -Type: [boolean][217] +Type: [boolean][219] ### seeking -Type: [boolean][217] +Type: [boolean][219] ### src -Type: [string][213] +Type: [string][215] ### poster -Type: [string][213] +Type: [string][215] ### config -Type: [Object][214] +Type: [Object][216] ### engineType -Type: [string][213] +Type: [string][215] ### streamType -Type: [string][213] +Type: [string][215] ### type -Type: [string][213] +Type: [string][215] ### ads -Type: [Object][214] +Type: [Object][216] ### addEventListener #### Parameters -- `type` **[string][213]** -- `listener` **[Function][221]** +- `type` **[string][215]** +- `listener` **[Function][223]** ### removeEventListener #### Parameters -- `type` **[string][213]** -- `listener` **[Function][221]** +- `type` **[string][215]** +- `listener` **[Function][223]** ### dispatchEvent @@ -1097,27 +1111,27 @@ Type: [Object][214] #### Parameters -- `mediaInfo` **[Object][214]** +- `mediaInfo` **[Object][216]** ### setMedia #### Parameters -- `mediaConfig` **[Object][214]** +- `mediaConfig` **[Object][216]** ### getMediaInfo -Returns **[Object][214]** +Returns **[Object][216]** ### configure #### Parameters -- `config` **[Object][214]** +- `config` **[Object][216]** ### ready -Returns **[Promise][216]<any>** +Returns **[Promise][218]<any>** ### load @@ -1131,29 +1145,29 @@ Returns **[Promise][216]<any>** ### isLive -Returns **[boolean][217]** +Returns **[boolean][219]** ### isDvr -Returns **[boolean][217]** +Returns **[boolean][219]** ### seekToLiveEdge ### getStartTimeOfDvrWindow -Returns **[number][218]** +Returns **[number][220]** ### getTracks #### Parameters -- `type` **[string][213]?** +- `type` **[string][215]?** -Returns **[Array][219]<Track>** +Returns **[Array][221]<Track>** ### getActiveTracks -Returns **[Object][214]** +Returns **[Object][216]** ### selectTrack @@ -1167,13 +1181,13 @@ Returns **[Object][214]** ### isAdaptiveBitrateEnabled -Returns **[boolean][217]** +Returns **[boolean][219]** ### setTextDisplaySettings #### Parameters -- `settings` **[Object][214]** +- `settings` **[Object][216]** ### startCasting @@ -1181,65 +1195,65 @@ Returns **[boolean][217]** ### isCasting -Returns **[boolean][217]** +Returns **[boolean][219]** ### isCastAvailable -Returns **[boolean][217]** +Returns **[boolean][219]** ### getCastSession -Returns **[RemoteSession][220]** +Returns **[RemoteSession][222]** ### isVr -Returns **[boolean][217]** +Returns **[boolean][219]** ### toggleVrStereoMode ### isInVrStereoMode -Returns **[boolean][217]** +Returns **[boolean][219]** ### Type -Type: [string][213] +Type: [string][215] ### isSupported -Returns **[boolean][217]** +Returns **[boolean][219]** ## RemoteSession ### Parameters -- `id` **[string][213]** Session ID. -- `friendlyName` **[string][213]** Receiver friendly name. -- `resuming` **[boolean][217]?** Whether the session is resuming. +- `id` **[string][215]** Session ID. +- `friendlyName` **[string][215]** Receiver friendly name. +- `resuming` **[boolean][219]?** Whether the session is resuming. ### deviceFriendlyName Receiver friendly name. -Type: [string][213] +Type: [string][215] -Returns **[string][213]** +Returns **[string][215]** ### id Session ID. -Type: [string][213] +Type: [string][215] -Returns **[string][213]** +Returns **[string][215]** ### resuming Whether the session is resuming. -Type: [boolean][217]? +Type: [boolean][219]? -Returns **[boolean][217]?** +Returns **[boolean][219]?** [1]: #baseremoteplayer [2]: #parameters @@ -1349,122 +1363,124 @@ Returns **[boolean][217]?** [106]: #mediainfo [107]: #textstyle-2 [108]: #advertising -[109]: #remotecontrol -[110]: #parameters-13 -[111]: #getplayersnapshot -[112]: #getuiwrapper -[113]: #onremotedevicedisconnected -[114]: #parameters-14 -[115]: #onremotedeviceconnected -[116]: #parameters-15 -[117]: #onremotedeviceavailable -[118]: #parameters-16 -[119]: #onremotedeviceconnecting -[120]: #onremotedevicedisconnecting -[121]: #onremotedeviceconnectfailed -[122]: #remotepayload -[123]: #parameters-17 -[124]: #player -[125]: #remoteconnectedpayload -[126]: #parameters-18 -[127]: #ui -[128]: #session -[129]: #remotedisconnectedpayload -[130]: #parameters-19 -[131]: #snapshot -[132]: #remoteavailablepayload -[133]: #parameters-20 -[134]: #available -[135]: #remoteplayerui -[136]: #playbackui -[137]: #parameters-21 -[138]: #idleui -[139]: #parameters-22 -[140]: #adsui -[141]: #parameters-23 -[142]: #liveui -[143]: #parameters-24 -[144]: #errorui -[145]: #parameters-25 -[146]: #uis -[147]: #iremoteplayer -[148]: #textstyle-3 -[149]: #muted-2 -[150]: #playbackrate-2 -[151]: #volume-2 -[152]: #currenttime-2 -[153]: #buffered-1 -[154]: #duration-1 -[155]: #paused-1 -[156]: #ended-1 -[157]: #seeking-1 -[158]: #src-1 -[159]: #poster-1 -[160]: #config-1 -[161]: #enginetype-1 -[162]: #streamtype-1 -[163]: #type-2 -[164]: #ads-1 -[165]: #addeventlistener -[166]: #parameters-26 -[167]: #removeeventlistener -[168]: #parameters-27 -[169]: #dispatchevent -[170]: #parameters-28 -[171]: #loadmedia-1 -[172]: #parameters-29 -[173]: #setmedia-1 -[174]: #parameters-30 -[175]: #getmediainfo-1 -[176]: #configure-1 -[177]: #parameters-31 -[178]: #ready-1 -[179]: #load-1 -[180]: #play-1 -[181]: #pause-1 -[182]: #reset-1 -[183]: #destroy-1 -[184]: #islive-1 -[185]: #isdvr-1 -[186]: #seektoliveedge-1 -[187]: #getstarttimeofdvrwindow-1 -[188]: #gettracks-1 -[189]: #parameters-32 -[190]: #getactivetracks-1 -[191]: #selecttrack-1 -[192]: #parameters-33 -[193]: #hidetexttrack-1 -[194]: #enableadaptivebitrate-1 -[195]: #isadaptivebitrateenabled-1 -[196]: #settextdisplaysettings-1 -[197]: #parameters-34 -[198]: #startcasting-1 -[199]: #stopcasting-1 -[200]: #iscasting-1 -[201]: #iscastavailable-1 -[202]: #getcastsession-1 -[203]: #isvr-1 -[204]: #togglevrstereomode-1 -[205]: #isinvrstereomode-1 -[206]: #type-3 -[207]: #issupported-1 -[208]: #remotesession -[209]: #parameters-35 -[210]: #devicefriendlyname -[211]: #id -[212]: #resuming -[213]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[214]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[215]: #remotecontrol -[216]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise -[217]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[218]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[219]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[220]: #remotesession -[221]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function -[222]: #playersnapshot -[223]: #remotedisconnectedpayload -[224]: #remoteconnectedpayload -[225]: #remoteavailablepayload -[226]: #baseremoteplayer -[227]: #remoteplayerui +[109]: #volume-2 +[110]: #muted-2 +[111]: #remotecontrol +[112]: #parameters-13 +[113]: #getplayersnapshot +[114]: #getuiwrapper +[115]: #onremotedevicedisconnected +[116]: #parameters-14 +[117]: #onremotedeviceconnected +[118]: #parameters-15 +[119]: #onremotedeviceavailable +[120]: #parameters-16 +[121]: #onremotedeviceconnecting +[122]: #onremotedevicedisconnecting +[123]: #onremotedeviceconnectfailed +[124]: #remotepayload +[125]: #parameters-17 +[126]: #player +[127]: #remoteconnectedpayload +[128]: #parameters-18 +[129]: #ui +[130]: #session +[131]: #remotedisconnectedpayload +[132]: #parameters-19 +[133]: #snapshot +[134]: #remoteavailablepayload +[135]: #parameters-20 +[136]: #available +[137]: #remoteplayerui +[138]: #playbackui +[139]: #parameters-21 +[140]: #idleui +[141]: #parameters-22 +[142]: #adsui +[143]: #parameters-23 +[144]: #liveui +[145]: #parameters-24 +[146]: #errorui +[147]: #parameters-25 +[148]: #uis +[149]: #iremoteplayer +[150]: #textstyle-3 +[151]: #muted-3 +[152]: #playbackrate-2 +[153]: #volume-3 +[154]: #currenttime-2 +[155]: #buffered-1 +[156]: #duration-1 +[157]: #paused-1 +[158]: #ended-1 +[159]: #seeking-1 +[160]: #src-1 +[161]: #poster-1 +[162]: #config-1 +[163]: #enginetype-1 +[164]: #streamtype-1 +[165]: #type-2 +[166]: #ads-1 +[167]: #addeventlistener +[168]: #parameters-26 +[169]: #removeeventlistener +[170]: #parameters-27 +[171]: #dispatchevent +[172]: #parameters-28 +[173]: #loadmedia-1 +[174]: #parameters-29 +[175]: #setmedia-1 +[176]: #parameters-30 +[177]: #getmediainfo-1 +[178]: #configure-1 +[179]: #parameters-31 +[180]: #ready-1 +[181]: #load-1 +[182]: #play-1 +[183]: #pause-1 +[184]: #reset-1 +[185]: #destroy-1 +[186]: #islive-1 +[187]: #isdvr-1 +[188]: #seektoliveedge-1 +[189]: #getstarttimeofdvrwindow-1 +[190]: #gettracks-1 +[191]: #parameters-32 +[192]: #getactivetracks-1 +[193]: #selecttrack-1 +[194]: #parameters-33 +[195]: #hidetexttrack-1 +[196]: #enableadaptivebitrate-1 +[197]: #isadaptivebitrateenabled-1 +[198]: #settextdisplaysettings-1 +[199]: #parameters-34 +[200]: #startcasting-1 +[201]: #stopcasting-1 +[202]: #iscasting-1 +[203]: #iscastavailable-1 +[204]: #getcastsession-1 +[205]: #isvr-1 +[206]: #togglevrstereomode-1 +[207]: #isinvrstereomode-1 +[208]: #type-3 +[209]: #issupported-1 +[210]: #remotesession +[211]: #parameters-35 +[212]: #devicefriendlyname +[213]: #id +[214]: #resuming +[215]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[216]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[217]: #remotecontrol +[218]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise +[219]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[220]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[221]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[222]: #remotesession +[223]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function +[224]: #playersnapshot +[225]: #remotedisconnectedpayload +[226]: #remoteconnectedpayload +[227]: #remoteavailablepayload +[228]: #baseremoteplayer +[229]: #remoteplayerui diff --git a/src/ovp/player-defaults.js b/src/ovp/player-defaults.js index 2bfc4d89b..d0e9511b1 100644 --- a/src/ovp/player-defaults.js +++ b/src/ovp/player-defaults.js @@ -4,6 +4,7 @@ import {Utils} from '@playkit-js/playkit-js'; /** * Sets the default analytics plugin for the ovp player. * @param {KPOptionsObject} options - The player config. + * @private * @returns {void} */ export function setDefaultAnalyticsPlugin(options: KPOptionsObject): void { diff --git a/src/ovp/poster.js b/src/ovp/poster.js index 621bee78c..8e2842266 100644 --- a/src/ovp/poster.js +++ b/src/ovp/poster.js @@ -4,6 +4,7 @@ * @param {PKSourcesConfigObject} playerSources - player sources container * @param {ProviderMediaConfigSourcesObject} mediaSources - media config sources container * @param {Object} dimensions - player dimensions object + * @private * @returns {void} */ function addKalturaPoster(playerSources: PKSourcesConfigObject, mediaSources: ProviderMediaConfigSourcesObject, dimensions: Object): void {