Websocket

Introduction

The episerver provides a read-only websocket connection at the base address. If the server is running in secure mode then the websocket is also secure.

Provides

The websocket provides periodic updates in the same format as the /x-epi/status and /x-epi/info endpoints.

It also provides a message whenever a resource is added, deleted or modified

/x-epi/status

A message is sent on any status change with the player and also every 300ms or so when a file is being played.

/x-epi-info

A message is sent every 2s with the system information.

Resource message

This is sent whenever one or more resources are added, deleted or modified. It has the following format

[
    {
        "uid" : string - the unique id of the resource,
        "type" : string - the resource type. One of "file", "playlist" or "schedule",
        "modification" : string - the modification type. One of "added", "deleted" or "modified"
    },...
]