Events
List of events emitted by Conduit websocket
Conduit will emit multiple event types while you are connected to the websocket. Below is a list of the possible event types and when you may receive them.
Event | Description | Example |
---|---|---|
subscribe_event | This event is fired every time a client successfully subscribes to a stream. It will contain a list of all active stream subscriptions. | [{"stream_url": "https://www.twitch.tv/esfandtv", "content_type": ['all']},{"stream_url": "https://www.twitch.tv/shroud", "content_type": ['audio', 'video']}] |
unsubscribe_event | This event is fired every time a client successfully unsubscribes to a stream. It will contain a list of all active stream subscriptions. | [{"stream_url": "https://www.twitch.tv/esfandtv", "content_type": ['all']}] |
livestream_data_event | This event is fired when a new transcription or image chunk is processed by Conduit. | [{"stream_url": "https://www.twitch.tv/esfandtv","transcription": "Thanks for watching!","frame": "iVBORw0KGgoAAAANSUhEUgAAA1YAAAHgCAIAAAApMmt..."}] |
error_event | This event is fired when a client's request is invalid or there is an internal error. | [{"code": "InvalidRequest", "message": "Request did not follow the specification."}] |