Overview
A host is able to run a live event where participants can watch the host's media stream and interact with each other using the chat. This document explains how you can retrieve information on the host in a Sendbird application using Live Platform API.
Resource representation
The following tables show the list of properties in a host resource.
| Property name | Type | Description |
|---|---|---|
host_id | string | A unique ID of the host. |
entered_at | long | The timestamp of when the host entered the live event, in Unix milliseconds. |
connected_at | long | The timestamp of when the host was connected and media streaming of the host started, in Unix milliseconds. |
disconnected_at | long | The timestamp of when the host was disconnected and media streaming of the host stopped, in Unix milliseconds. |
exited_at | long | The timestamp of when the host exited the live event, in Unix milliseconds. |
duration | int | The period from when the host entered the live event to when the host left the live event, in milliseconds. |
user | The user who can access features of a host in the live event. | |
client_id | string | The unique ID of the client. |
state | string | The state of the host. Valid values are the following: |
has_audio_on | boolean | Indicates whether the host has turned on their audio. |
has_video_on | boolean | Indicates whether the host has turned on their video. |
live_event_id | string | The unique ID of the live event. |
Actions
- API endpoints are relative to the base URL allocated to your application. In this page, the
/live-eventsendpoint refers tohttps://api-{application_id}.calls.sendbird.com/v1.
Note: To get your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
- It's recommended that the parameter values in API URLs be URL encoded, such as
{live_event_id}.
List of actions
| Action | HTTP request |
|---|---|
|