Class WhipResource

WHIP ingress — vsdk.whip (WebRTC-HTTP publish into a room).

create() builds the publish URL and token locally (no network call). delete() tears the publisher down.

Index

Constructors

Methods

Constructors

constructor

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

Methods

create

create(roomId: string, options?: CreateWhipOptions): WhipIngress
Build a WHIP publish credential (URL + token). Synchronous — no network call.
Parameters
- roomId: string
- options: CreateWhipOptions = {}
Returns WhipIngress

delete

delete(
    target:
        | WhipIngress
        | {
            displayName?: string;
            participantId: string;
            roomId: string;
            sessionId?: string;
        },
): Promise<unknown>
Tear down a WHIP publisher. Pass the WhipIngress returned by create (or { roomId, participantId }); provide an explicit sessionId to target a specific session directly (e.g. from the publish response's Location header).
Parameters
- target:
      | WhipIngress
      | {
          displayName?: string;
          participantId: string;
          roomId: string;
          sessionId?: string;
      }
Returns Promise<unknown>