diff --git a/API.md b/API.md index 58d2f90..22ad8e1 100644 --- a/API.md +++ b/API.md @@ -108,17 +108,18 @@ Creates and initializes the player. | --- | --- | --- | | key | string | NexPlayer key to validates the playback. | | div | HTMLDivElement | the div container of the player. | -| src | string | relevant src of the video to be played. | +| src | string | of the video to be played. | | 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 | sets 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 | sets if the UI must hide when the user does not interact with the video. By default is set to true.. | +| seekUI | number | establish the number of seconds the UI buttons will seek forwards or backwards. By default is set to 10s. | +| 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 | sets a callback to be executed when the corresponding button is clicked. | -| callbackForLogger | function | function to be called when the logger shows a message. | +| 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 | determines if dynamic thumbnails are used. By default this values is set to false. | | showingFullUI | boolean | determines if the UI is hidden or not. |