Constructor Detail

• SocketListener

  SocketListener()

Method Detail

• getDeliverOnMainThread

   Boolean getDeliverOnMainThread()

  The callbacks are by default delivered on the main thread. Changing this property to false will deliver the callbacks on their originating threads.

  Set to false for faster callback delivery on the original thread (no unnecessary context switching).

• onCreated

   Unit onCreated()

  Called when the socket is created.

• onConnecting

   Unit onConnecting()

  Invoked when the connection begins to establish and socket state changes to Connecting.

• onConnected

   Unit onConnected(ConnectedEventType event)

  Invoked when we receive the first ConnectedEventType in this connection.

  Note: This is not invoked when the ws connection is opened but when the ConnectedEventType is received.

  Parameters:

  event - ConnectedEventType sent by server as first event once the connection is established.

• onDisconnected

   Unit onDisconnected(DisconnectCause cause)

  Invoked when the web socket connection is disconnected.

  Parameters:

  cause - DisconnectCause reason of disconnection.

• onError

   Unit onError(StreamWebSocketEvent.Error error)

  Invoked when there is any error in this web socket connection.

  Parameters:

  error - Error object with the error details.

• onEvent

   Unit onEvent(EventType event)

  Invoked when we receive any successful event.

  Parameters:

  event - parsed VideoEvent received in this web socket connection.