Interface WebSocketRemoteControlConfig

Configuration interface for WebSocket-based player remote control. Requires a running WebSocket server available at https://github.com/bitmovin/bitmovin-player-remote-websocketserver.

Example:

{
  type: 'websocket',
  url: 'ws://your-server-ip:29100',
  customReceiverConfig: {
    receiverStylesheetUrl: 'https://mycdn.com/mycustomreceiverstyle.css',
  },
}
interface WebSocketRemoteControlConfig {
    customReceiverConfig?: RemoteControlCustomReceiverConfig;
    type: "websocket";
    url: string;
}

Hierarchy (view full)

Properties

customReceiverConfig? type url

Properties

Optional customReceiverConfig

customReceiverConfig?: RemoteControlCustomReceiverConfig

An arbitrary configuration object that is sent to the receiver when a connection is established. This object can carry configuration values that are of no concern to and are handled outside of the RemoteControl/ RemoteControlReceiver architecture.

type

type: "websocket"

url

url: string

The URL of the WebSocket server managing communication between WebSocket remote controls and WebSocket remote receivers.

Settings

Member Visibility

Theme

On This Page

customReceiverConfigtypeurl