Package nl.harm27.obs.websocket.listener

Class GeneralEventListener

java.lang.Object

nl.harm27.obs.websocket.listener.GeneralEventListener

All Implemented Interfaces:

EventListener

public abstract class GeneralEventListener
extends Object
implements EventListener

The EventListener for the events that are part of the General category.

Constructor Summary

Constructors

Constructor	Description
GeneralEventListener()

Method Summary

Modifier and Type	Method	Description
void	broadcastCustomMessage(BroadcastCustomMessage broadcastCustomMessage)	A custom broadcast message, sent by the server, requested by one of the websocket clients.
void	callEvent(BaseEvent baseEvent)
List<EventType>	getSupportedEvents()
void	heartbeat(Heartbeat heartbeat)	Emitted every 2 seconds after enabling it by calling SetHeartbeat.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeneralEventListener

public GeneralEventListener()

Method Detail

heartbeat

public void heartbeat(Heartbeat heartbeat)

Emitted every 2 seconds after enabling it by calling SetHeartbeat.

Parameters:

heartbeat - The received event.

Since:

v0.3

See Also:

OBS WebSocket Documentation

broadcastCustomMessage

public void broadcastCustomMessage(BroadcastCustomMessage broadcastCustomMessage)

A custom broadcast message, sent by the server, requested by one of the websocket clients.

Parameters:

broadcastCustomMessage - The received event.

Since:

4.7.0

See Also:

OBS WebSocket Documentation

callEvent

public final void callEvent(BaseEvent baseEvent)

Specified by:

callEvent in interface EventListener

getSupportedEvents

public final List<EventType> getSupportedEvents()

Specified by:

getSupportedEvents in interface EventListener