Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,17 +108,18 @@ Creates and initializes the player.
| --- | --- | --- |
| key | <code>string</code> | NexPlayer key to validates the playback. |
| div | <code>HTMLDivElement</code> | the div container of the player. |
| src | <code>string</code> | relevant src of the video to be played. |
| src | <code>string</code> | of the video to be played. |
| autoplay | <code>boolean</code> | determines if the video must start playing or paused. By default it's set to true. |
| drm | <code>Array.<NexDRMInformation></code> | contains an array of DRM information. By default it's set to null. |
| seekUI | <code>number</code> | sets the number of seconds the UI buttons will seek forwards or backwards. By default is set to 10s. |
| mutedAtStart | <code>boolean</code> | determine if the video will start playing muted or not. By default this value is set to false. |
| debug | <code>boolean</code> | determine if log information is showed. By default is set to true. |
| type_360 | <code>string</code> | select the 360 video format to play. Possible values are 'equirectangular', 'cubemap' and 'topdown'. |
| autohide | <code>boolean</code> | sets if the UI must hide when the user does not interact with the video. By default is set to true.. |
| seekUI | <code>number</code> | establish the number of seconds the UI buttons will seek forwards or backwards. By default is set to 10s. |
| mutedAtStart | <code>boolean</code> | determines if the video will start playing muted or not. By default this value is set to false. |
| debug | <code>boolean</code> | determines if log information is showed. By default is set to true. |
| type_360 | <code>string</code> | selects the 360 video format to play. Possible values are 'equirectangular', 'cubemap' and 'topdown'. |
| autohide | <code>boolean</code> | establishes if the UI must hide when the user does not interact with the video. By default is set to true.. |
| callbacksForPlayer | <code>function</code> | used for retrieving the nexplayer instance and video element. This is necessary for getting the instance and use the NexPlayer API. |
| callbackForReturn | <code>function</code> | sets a callback to be executed when the corresponding button is clicked. |
| callbackForLogger | <code>function</code> | function to be called when the logger shows a message. |
| callbackForReturn | <code>function</code> | establishes a callback to be executed when the corresponding button is clicked. |
| callbackForLogger | <code>function</code> | function to be called when the logger show a message. |

| vast | <code>string</code> | advertisement url that is going to be played. VAST, VPAID, VMAP are supported. |
| useDynamicThumbnails | <code>boolean</code> | determines if dynamic thumbnails are used. By default this values is set to false. |
| showingFullUI | <code>boolean</code> | determines if the UI is hidden or not. |
Expand Down