A socket client to communicate with the companion servers socket API

Implements

Constructors

Accessors

  • get socket(): undefined | Socket<DefaultEventsMap, DefaultEventsMap>
  • Get the whole socket object. Use with caution! Useful for custom things that are not implemented in this class

    Returns undefined | Socket<DefaultEventsMap, DefaultEventsMap>

    The socket object

Methods

  • Register a listener for connection state changes

    Parameters

    • listener: ((state) => void)

      The listener to register

        • (state): void
        • Parameters

          • state: any

          Returns void

    Returns void

  • Register a listener for errors

    Parameters

    • listener: ((error) => void)

      The listener to register

        • (error): void
        • Parameters

          • error: any

          Returns void

    Returns void

  • Register a listener for playlist created events

    Parameters

    • listener: ((playlist) => void)

      The listener to register

    Returns void

  • Register a listener for playlist deleted events

    Parameters

    • listener: ((playlist) => void)

      The listener to register

        • (playlist): void
        • Parameters

          • playlist: string

          Returns void

    Returns void

  • Register a listener for state changes

    Parameters

    • listener: ((state) => void)

      The listener to register

    Returns void

  • Remove all listeners for connection state changes

    Returns void

  • Remove all listeners for playlist created events

    Returns void

  • Remove all listeners for playlist deleted events

    Returns void

  • Remove a listener for connection state changes

    Parameters

    • listener: ((state) => void)

      The listener to remove

        • (state): void
        • Parameters

          • state: any

          Returns void

    Returns void

  • Remove a listener for errors

    Parameters

    • listener: ((error) => void)

      The listener to remove

        • (error): void
        • Parameters

          • error: any

          Returns void

    Returns void

  • Remove a listener for playlist created events

    Parameters

    • listener: ((playlist) => void)

      The listener to remove

    Returns void

  • Remove a listener for playlist deleted events

    Parameters

    • listener: ((playlist) => void)

      The listener to remove

        • (playlist): void
        • Parameters

          • playlist: string

          Returns void

    Returns void

  • Remove a listener for state changes

    Parameters

    • listener: ((state) => void)

      The listener to remove

    Returns void

  • Set the authentication token, so it can be used for further requests and reconnects automatically if token changed.

    We recommend to use the setAuthToken method in the CompanionConnector class instead of this method because it sets the token for both clients and also reconnects the socket client if the token changed.

    Parameters

    • token: string

      The token to set

    Returns void