From 739e88686820841f09766e2d2e1be862a8a23f11 Mon Sep 17 00:00:00 2001 From: benNexPlayer <68052536+benNexPlayer@users.noreply.github.com> Date: Thu, 9 Jul 2020 12:53:17 +0200 Subject: [PATCH] Added table changes --- API.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/API.md b/API.md index da3dfd5..3d6c3ec 100644 --- a/API.md +++ b/API.md @@ -109,20 +109,20 @@ Creates and initializes the player. | key | string | that validates the playback. | | div | HTMLDivElement | the div container of the player. | | src | string | of the video to be played. | -| autoplay | boolean | determine if the video must start playing or paused. By default it's set to true. | +| autoplay | boolean | determines if the video must start playing or paused. By default it's set to true. | | drm | Array. | contains an array of DRM information. By default it's set to null. | | seekUI | number | establish the number of seconds the UI buttons will seek forwards or backwards. By default is set to 10s. | -| mutedAtStart | boolean | determine if the video will start playing muted or not. By default this value is set to false. | -| debug | boolean | determine if log information is showed. By default is set to true. | -| type_360 | string | select the 360 video format to play. Possible values are 'equirectangular', 'cubemap' and 'topdown'. | -| autohide | boolean | establish if the UI must hide when the user does not interact with the video. By default is set to true.. | +| mutedAtStart | boolean | determines if the video will start playing muted or not. By default this value is set to false. | +| debug | boolean | determines if log information is showed. By default is set to true. | +| type_360 | string | selects the 360 video format to play. Possible values are 'equirectangular', 'cubemap' and 'topdown'. | +| autohide | boolean | establishes if the UI must hide when the user does not interact with the video. By default is set to true.. | | callbacksForPlayer | function | used for retrieving the nexplayer instance and video element. This is necessary for getting the instance and use the NexPlayer API. | -| callbackForReturn | function | establish a callback to be executed when the corresponding button is clicked. | +| callbackForReturn | function | establishes a callback to be executed when the corresponding button is clicked. | | callbackForLogger | function | function to be called when the logger show a message. | | vast | string | advertisement url that is going to be played. VAST, VPAID, VMAP are supported. | -| useDynamicThumbnails | boolean | determine if dynamic thumbnails are used. By default this values is set to false. | -| showingFullUI | boolean | determine if the UI is hidden or not. | -| disableKeyEvents | boolean | determine if the keyboard keys can be used to control the video (play/pause, forward/backward and volume up/down). | +| useDynamicThumbnails | boolean | determines if dynamic thumbnails are used. By default this values is set to false. | +| showingFullUI | boolean | determines if the UI is hidden or not. | +| disableKeyEvents | boolean | determines if the keyboard keys can be used to control the video (play/pause, forward/backward and volume up/down). | #### player.getTracks() ⇒ Array.< Track >