Class WhepClient

Index

Constructors

Methods

connect disconnect

Constructors

constructor

new WhepClient(
    configurationOptions: WhepConfigurationOptions,
    preferredVideoCodecs?: ReceiverVideoCodecName[],
    preferredAudioCodecs?: ReceiverAudioCodecName[],
): WhepClient
Parameters
- configurationOptions: WhepConfigurationOptions
- preferredVideoCodecs: ReceiverVideoCodecName[] = []
- preferredAudioCodecs: ReceiverAudioCodecName[] = []
Returns WhepClient
- Defined in ReactNativeMobileWhepClientModule.ts:167

Methods

connect

connect(connectOptions: ConnectOptions): Promise<void>
Connects to the WHEP server defined while creating WHEP client. Allows user to receive video and audio stream.
Parameters
- connectOptions: ConnectOptions
Returns Promise<void>
- Defined in ReactNativeMobileWhepClientModule.ts:190

disconnect

disconnect(): Promise<void>
Disconnects from the WHEP server defined while creating WHEP client. Frees the resources.

Returns Promise<void>
- Defined in ReactNativeMobileWhepClientModule.ts:202