Start your first live
Sendbird Live SDK for iOS offers a variety of functionalities for hosting and watching live events. As a live event's host, a user can create, share their media stream, and use the chat to communicate with other users watching the live event. Users can enter a live event as participants to watch the live event and use the chat to communicate with the live event's host as well as other users.
The minimum requirements for the Live for Android are:
- Xcode 14.1 and later
- A device running iOS 11.0 and later
- Swift 5.0 and later
Before you start
Sendbird Live SDK provides live streaming feature and uses open channels from Sendbird Chat SDK for chat. Installing Sendbird Live SDK will automatically install the Chat SDK as well.
Before installing the Live SDK, create a Sendbird account to acquire an application ID which you will need to initialize the Live SDK. Go to Sendbird Dashboard and create an application by selecting Calls+Live in product type. Once you've created an application, go to Overview and you will see the Application ID.
You can start building your a live event by installing the Live SDK first.
Step 1 Create a project
To get started, open
Xcode and create a new project. The Live SDK for iOS only supports
Step 2 Install the Live SDK
You can install the Live SDK through either Swift Package Manager or CocoaPods. When you install the Live SDK, Sendbird Chat SDK will be installed as a dependency. The names of the framework and the main class in the Live SDK are
Note: If you have already been using Sendbird Chat or want to know the minimum version of the Chat SDK to use the Live SDK, you can check the information in Sendbird Live SDK repository.
Go to your Swift Package Manager's File tab and select Swift Packages. Then choose Add package dependency....
Package Repositoryas below:
- To add the package, select Version Rules, enter Up to Next Major, 1.0.0, and click Next.
- Install the
- Update the
Step 3 Request permission to access camera and microphone
Users need to grant the client app the permission to access camera and microphone to stream media. They also need to grant permission to access the photo library to send and download images and videos.
Step 4 Initialize the SendbirdLiveSDK instance
To integrate the Live SDK in the client app, you need to initialize it first. But, prior to initializing the Live SDK, you must initialize Sendbird Chat SDK first. Refer to the following documentation to understand how to initialize Sendbird Chat SDK.
After initializing Sendbird Chat SDK, initialize the
SendbirdLive instance using the
SendbirdLive.initialize() method. Initialization requires your Sendbird application's Application ID, which can be found on the Sendbird Dashboard.
SendbirdLive.initialize(applicationId:)method must be called across the client app at least once. It is recommended to initialize the Live SDK through the
application:didFinishLaunchingWithOptions:method of the
Step 5 Authenticate a user
To start or enter a live streaming, you need to authenticate a user with the Sendbird server using their user ID through the
Authenticating a user with the Live SDK will also authenticate the user in the Chat SDK if you haven't authenticated the user in the Chat SDK yet. After authenticating the user, you can start broadcast or watch live events.
Step 6 Create a live event
To start a live event, you need to create one first. A live event can be created using the
SendbirdLive.createLiveEvent() method, and you can configure information about the live event through the
Step 7 Start your first live
When a live event is created, you can choose to enter as a host or a participant.
If you've entered as a host, you can start the live event by making the following call.
Step 8 Watch your first live
When a host and participants enter the live event, you can stream the first live event for participants to watch with Sendbird Live. The host and participants also can actively engage in the live event by chatting with each other.