Class WhepResource

WHEP egress — vsdk.whep (standards-based WebRTC pull from a room). Requires an already-active session in the room.

Index

Constructors

Methods

Constructors

constructor

new WhepResource(config: IngressResourceConfig): WhepResource
Parameters
- config: IngressResourceConfig
Returns WhepResource

Methods

create

create(roomId: string, options?: CreateWhepOptions): WhepPlayback
Build a WHEP playback credential (URL + token). Synchronous — no network call.
Parameters
- roomId: string
- options: CreateWhepOptions = {}
Returns WhepPlayback

delete

delete(
    target:
        | WhepPlayback
        | {
            participantId: string;
            remotePeerId?: string;
            roomId: string;
            sessionId?: string;
        },
): Promise<unknown>
Tear down a WHEP subscriber. Pass the WhepPlayback returned by create (or { roomId, participantId }); provide an explicit sessionId to target a specific session directly.
Parameters
- target:
      | WhepPlayback
      | {
          participantId: string;
          remotePeerId?: string;
          roomId: string;
          sessionId?: string;
      }
Returns Promise<unknown>