Skip to main content

Class: ApiClient

Convenience class to call the public available endpoints of the Vindral Live CDN.

Methods​

connect()​

connect(options): Promise<ConnectResponse>

Returns everything needed to setup the connection of Vindral instance.

Parameters​

• options: ConnectOptions

Returns​

Promise<ConnectResponse>

getChannel()​

getChannel(channelId): Promise<Channel>

Fetches information regarding a single channel.

Parameters​

• channelId: string

the channel to fetch

Returns​

Promise<Channel>

a [[Channel]] containing information about the requested channel.

getChannels()​

getChannels(channelGroupId): Promise<Channel[]>

Fetches channels within a channel group

Note: The returned list includes inactive channels - check isLive to filter out only active channels

Parameters​

• channelGroupId: string

Returns​

Promise<Channel[]>

an array of [[Channel]] that belong to the channel group