Live iOS v1
Live iOS
Live
iOS
Home
/
Live
/
iOS
/
SDK

List live events

A user can get a list of ongoing live events using the LiveEventListQuery object. The user can filter their search by creation 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:).

var params = LiveEventListQueryParams()
params.limit = 10
params.participantCountRange = 10..<1000
let query = SendbirdLive.createLiveEventListQuery(params: params)
query.next { liveEvents, error in
    guard error == nil else { return }
    // Show the list of live events to users in a list view.
}

LiveEventListQueryParams

Property nameTypeDescription

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.