List live events
A user can get a list of ongoing live events using the LiveEventListQuery
object. The user can filter their search by host type, created date, participant count, duration, live event ID, and more by using LiveEventListQueryParams
. If the user knows the URL of the live event, the user can directly find the live event through SendbirdLive.getLiveEvent(id:completionHandler:)
.
LiveEventListQueryParams
Property name | Type | Description |
---|---|---|
types | [LiveEvent.Type] | Filters query results to include live events with the specified live event types. |
state | LiveEventState | Filters query results to include live events with the specified live event state. |
createdAtRange | Range | Filters query results to include live events that were created within the specified range in Unix milliseconds. |
participantCountRange | Range | Filters query results to include live events where the number of current participants is within the specified range. |
durationRange | Range | Filters query results to include live events whose duration is within the specified range. |
liveEventIds | String | Filters query results to include live events with the specified live event IDs. |
createdByUserIds | String | Filters query results to include live events that were created by the specified user IDs. |
limit | int | Sets the number of rooms to be retrieved at once. |
An open channel should be available when a live event is retrieved. In case the open channel isn't available, call fetchOpenChannel()
to fetch the open channel.