Skip to main content

Broadcast

publish_broadcast​

Event received after a broadcast has been successfully published to the specified streaming platform. This event contains the playerUrl parameter which provides access to the broadcast stream.

{
  type: 'publish_broadcast',
  playerUrl
}

broadcasts_update​

Event that provides updates about the current broadcast status. This event contains a broadcasts array with detailed information about active broadcasts, including platform information, player URLs, and associated user and room data.

{
  type: 'broadcasts_update',
  broadcasts: [
    {
      id,
      platform: 'generic',
      player_url,
      user: { /* ... */ },
      room: { /* ... */ }
    }
  ]
}

start_rtmp​

Initiates an RTMP live stream broadcast to the specified streaming destination. This function requires both the RTMP URL and stream key parameters to successfully connect to the streaming service.

eyeson.send({
  type: 'start_rtmp',
  url,
  key
});

stop_rtmp​

Terminates an active RTMP live stream broadcast that was previously initiated. This function requires no additional parameters and will stop the current streaming session to the configured service.

eyeson.send({ type: 'stop_rtmp' });

stop_broadcasts​

Terminates all active broadcast streams that are currently running. This function stops all broadcasts associated with the session without requiring specific stream identifiers.

eyeson.send({ type: 'stop_broadcasts' });