LiveStreamApiClient

Contains all the endpoints needed to manage LiveStreams.

Constructors

Constructor

new LiveStreamApiClient(): LiveStreamApiClient

Returns

LiveStreamApiClient

Methods

changeCover()

static changeCover(id, data, config?): Promise<SCLiveStreamType>

This endpoint changes the LiveStream avatar

Parameters

Parameter	Type	Description
id	string | number
data	FormData
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamType>

---

close()

static close(id, config?): Promise<any>

This endpoint allows to close permanently a room

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

create()

static create(data, config?): Promise<SCLiveStreamType>

This endpoint creates an LiveStream.

Parameters

Parameter	Type	Description
data	LiveStreamCreateParams | FormData
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamType>

---

delete()

static delete(id, config?): Promise<any>

This endpoint deletes an LiveStream.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getMonthlyDuration()

static getMonthlyDuration(config?): Promise<SCLiveStreamMonthlyDurationType>

This endpoint retrieves LiveStream montlhy duration.

Parameters

Parameter	Type	Description
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamMonthlyDurationType>

---

getSpecificInfo()

static getSpecificInfo(id, config?): Promise<SCLiveStreamType>

This endpoint retrieves a specific LiveStream.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamType>

---

join()

static join(id, config?): Promise<SCLiveStreamConnectionDetailsType>

This endpoint allows to attend an LiveStream

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamConnectionDetailsType>

---

patch()

static patch(id, data, config?): Promise<SCLiveStreamType>

This endpoint patches an LiveStream.

Parameters

Parameter	Type	Description
id	string | number
data	SCLiveStreamType
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamType>

---

removeParticipant()

static removeParticipant(id, data, config?): Promise<any>

This endpoint remove participant from the specified live stream. If ban=true in the payload the user can no longer join the meet

Parameters

Parameter	Type	Description
id	string | number
data	LiveStreamRemoveParticipantParams | FormData
config?	AxiosRequestConfig

Returns

Promise<any>

---

search()

static search(params?, config?): Promise<SCPaginatedResponse<SCLiveStreamType>>

This endpoint performs LiveStreams search

Parameters

Parameter	Type	Description
params?	LiveStreamSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCLiveStreamType>>

---

update()

static update(id, data, config?): Promise<SCLiveStreamType>

This endpoint updates an LiveStream.

Parameters

Parameter	Type	Description
id	string | number
data	SCLiveStreamType
config?	AxiosRequestConfig

Returns

Promise<SCLiveStreamType>