Stream live content to viewers
Overview
A Live Event object represents an instance of a live stream that viewers can watch on a FanHero channel in real time.
To run a live event on the FanHero platform, you must ingest video and audio using RTMP from a source and stream it to the RTMP URL available in the admin portal. Viewers are able to access the live stream on a FanHero channel.
Every live event gets recorded. After a live event is over, it becomes available as a post on the channel.
Go live on the FanHero platform
Owners of FanHero channels can create and run live events using the FanHero video portal.
To learn how to stream a live event using the portal, read the Live Events page in our portal user guides.
Live Event object properties
Live Event objects returned by the endpoints in this section can have some or all of these properties:
| Name | Type | Description |
|---|---|---|
id | String | The live event ID |
account | String | The account ID of the user who created the event |
organization | String | The ID of the organization that owns the channel |
channel | String | The channel ID |
description | String | The description of the live event. The viewers will see this description on the channel page. |
allowComments | Boolean | If True, viewers can comment while the live event is in progress. |
tags | String Array | An array of tag IDs. |
category | String | Category ID. |
access | String Enum | Describes the access restriction if any. Possible values: AVAILABLE indicates that the stream is free and accessible from anywhere in the world. REDACTED indicates that the viewers must pay to access the stream. GEOLOCKED indicates that the access is restricted based on the geographical location of the viewer. |
slug | String | A slug is created by formatting the live event title so that all letters are lower case and all spaces are replaced with dashes. |
thumbnail | String | The ID of a media object representing the thumbnail image. |
orientation | String Enum | The video orientation. Can be LANDSCAPE or PORTRAIT. |
scheduledStartAt | DateTime String | The date and time when the live event is scheduled to begin. The channel owner can begin the stream on, before or after this time. |
startedAt | DateTime String | The date and time when the live event actually started. |
endedAt | DateTime String | The date and time when the live event ended. |
usersCount | Number | The total number of viewers who watched the live event. |
reactionsCount | Number | The number of reactions viewers left. |
commentsCount | Number | The number of comments viewers left. |
presenceEnabled | Boolean | If True, the current number of viewers will be displayed during the live event. |
commentsEnabled | Boolean | If True, the viewers can comment on the live event. |
reactionsEnabled | Boolean | If True, the viewers can leave reactions to the live event. |
status | String Enum | The current status of the event. Can be: SCHEDULED - the event has just been created. READY - the event is ready to be started. LIVE - the event is happening now. FINISHED - the live event is over. The status of the event will change from SCHEDULED to READY as soon as the RTMP URL is available. |
geoFence | Object | A geofence object that describes geographical restrictions on viewing the live event. |
title | String | The live event title |
deleted | Boolean | If True, the live event has been deleted. |
kind | String Enum | Describes the audience for this event. Possible values: PUBLIC - the event is freely available to the public. EXCLUSIVE - viewers need to log in to watch the event. PAYWALL - viewers need to log in and pay to watch the event. PRIVATE - viewers need a password to access the event. GEOLOCKED - the event has geographical descriptions determined by a geofence object. AUTO - the audience is determined by the kind property of the channel on which the event is hosted. |
isStudio | Boolean | If True, the live event is hosted using the FanHero Studio. |
createdAt | DateTime String | Date and time when the live event was created. |
updatedAt | DateTime String | Date and time when the live event was last edited. |
isLive | Boolean | If True, the event is currently live. |