1. References
  2. VoxEngine
  3. VoxEngine
  4. createURLPlayer
Rate this page:

createURLPlayer

Copy URL
createURLPlayer(url: 
string
, urlPlayerOptions: 
VoxEngine.URLPlayerOptions
): 
Player

Creates a new audio player with specified audio file URL.After the very first playback, a file is cached; each 'createURLPlayer' instance stores the cache data up to 2 weeks. Note that cache addresses only the URL, without additional headers. The cached file is available for all applications and further sessions.

File downloading has a timeout of 12 seconds. Reaching this timeout causes the "Timeout is reached" error.

Media streams can later be attached using the Call.sendMediaTo method etc. IMPORTANT: each call object can send media to any number of other calls (media units), but can receive only one audio stream. A new incoming stream always replaces the previous one. Add the following line to your scenario code to use the function:

Parameters

  • url:

    string

    Url of an audio file. Supported formats are: mp3, ogg & flac (mp3, speex, vorbis and flac codecs respectively). Maximum file size is 10 Mb.

  • urlPlayerOptions:

    VoxEngine.URLPlayerOptions

    Optional

    Optional parameters: progressive playback, loop, onPause, etc.

Returns