Class VideoSdkClient<ReceiverType, OptionsType>

Type Parameters

ReceiverType extends Receiver = HttpReceiver
OptionsType extends CommonClientOptions<JwtAuth, ReceiverType> = VideoSdkOptions<ReceiverType>

Hierarchy

ProductClient<
    JwtAuth,
    VideoSdkEndpoints,
    VideoSdkEventProcessor,
    OptionsType,
    ReceiverType,
>
- VideoSdkClient

Index

Constructors

Properties

endpoints webEventConsumer

Methods

Constructors

constructor

new VideoSdkClient<
    ReceiverType extends Receiver = HttpReceiver,
    OptionsType extends
        CommonClientOptions<JwtAuth, ReceiverType> = VideoSdkOptions<
        ReceiverType,
    >,
>(
    options: ClientConstructorOptions<JwtAuth, OptionsType, ReceiverType>,
): VideoSdkClient<ReceiverType, OptionsType>
Type Parameters
- ReceiverType extends Receiver = HttpReceiver
- OptionsType extends CommonClientOptions<JwtAuth, ReceiverType> = VideoSdkOptions<ReceiverType>
Parameters
- options: ClientConstructorOptions<JwtAuth, OptionsType, ReceiverType>
Returns VideoSdkClient<ReceiverType, OptionsType>
Inherited from ProductClient<JwtAuth, VideoSdkEndpoints, VideoSdkEventProcessor, OptionsType, ReceiverType>.constructor

Properties

`Readonly`endpoints

endpoints: VideoSdkEndpoints

`Readonly`webEventConsumer

webEventConsumer: VideoSdkEventProcessor

Methods

start

start(
    this: IsReceiverDisabled<OptionsType> extends true
        ? never
        : VideoSdkClient<ReceiverType, OptionsType>,
): Promise<ReturnType<ReceiverType["start"]>>
Parameters
- this: IsReceiverDisabled<OptionsType> extends true
  ? never
  : VideoSdkClient<ReceiverType, OptionsType>
Returns Promise<ReturnType<ReceiverType["start"]>>
Inherited from ProductClient.start