mStream/docs/API/jukebox_push-to-client.md
2017-03-03 15:43:43 -05:00

1.1 KiB

Push Message To Jukebox Instance

Send a message to a client running in Jukebox Mode

  • URL

    /jukebox/push-to-client

  • Method:

    POST

  • JSON Params

    Required:

    code - This is the code generated when starting Jukebox Mode
    command - Command to

    Optional:

    file - filepath for adding files to playlist

  • JSON Example

    {
      'code': '59305',
      'command': 'addSong',
      file: '/path/to/file.flac'
    }
    
  • List Of Commands

    If the command does not match one of the following, the server will return an error

    • next
    • previous,
    • playPause,
    • addSong,
    • getPlaylist,
    • removeSong,

    Users with Guest Codes will only have access to addSong and getPlaylist

  • Success Response:

    • Code: 200
      Content:

      {
        'id': 'UUID_SRING',
        'token': 'TOKEN_STRING',
        'experiationdate':'TODO'
      }
      
  • NOTES:

    • The getPlaylist command not yet implemented
    • Additional functions to limit guest access will be added in the future