Skip to main content

LiveStreamApiClientInterface

Methods

changeCover()

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

Parameters

ParameterType
idstring | number
dataFormData
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>


close()

close(id, config?): Promise<SCLiveStreamType>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>


create()

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

Parameters

ParameterType
dataLiveStreamCreateParams | FormData
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>


delete()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


getMonthlyDuration()

getMonthlyDuration(config?): Promise<SCLiveStreamMonthlyDurationType>

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamMonthlyDurationType>


getSpecificInfo()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>


join()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamConnectionDetailsType>


patch()

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

Parameters

ParameterType
idstring | number
dataSCLiveStreamType
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>


removeParticipant()

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

Parameters

ParameterType
idstring | number
dataLiveStreamRemoveParticipantParams | FormData
config?AxiosRequestConfig

Returns

Promise<any>


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

Parameters

ParameterType
params?LiveStreamSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCLiveStreamType>>


update()

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

Parameters

ParameterType
idstring | number
dataSCLiveStreamType
config?AxiosRequestConfig

Returns

Promise<SCLiveStreamType>