whip

Documentation

Overview

Package whip contains WebRTC / WHIP utilities.

Index

• func GetICEServers(ctx context.Context, hc *http.Client, ur string) ([]webrtc.ICEServer, error)
• func ICEFragmentMarshal(offer string, candidates []*webrtc.ICECandidateInit) ([]byte, error)
• func ICEFragmentUnmarshal(buf []byte) ([]*webrtc.ICECandidateInit, error)
• func LinkHeaderMarshal(iceServers []webrtc.ICEServer) []string
• func LinkHeaderUnmarshal(link []string) ([]webrtc.ICEServer, error)
• func PostCandidate(ctx context.Context, hc *http.Client, ur string, ...) error
• type PostOfferResponse
  • func PostOffer(ctx context.Context, hc *http.Client, ur string, ...) (*PostOfferResponse, error)

Functions

func GetICEServers

func GetICEServers(
	ctx context.Context,
	hc *http.Client,
	ur string,
) ([]webrtc.ICEServer, error)

GetICEServers posts a WHIP/WHEP request for ICE servers.

func ICEFragmentMarshal

func ICEFragmentMarshal(offer string, candidates []*webrtc.ICECandidateInit) ([]byte, error)

ICEFragmentMarshal encodes an ICE fragment.

func ICEFragmentUnmarshal

func ICEFragmentUnmarshal(buf []byte) ([]*webrtc.ICECandidateInit, error)

ICEFragmentUnmarshal decodes an ICE fragment.

func LinkHeaderMarshal

func LinkHeaderMarshal(iceServers []webrtc.ICEServer) []string

LinkHeaderMarshal encodes a link header.

func LinkHeaderUnmarshal

func LinkHeaderUnmarshal(link []string) ([]webrtc.ICEServer, error)

LinkHeaderUnmarshal decodes a link header.

func PostCandidate

func PostCandidate(
	ctx context.Context,
	hc *http.Client,
	ur string,
	offer *webrtc.SessionDescription,
	etag string,
	candidate *webrtc.ICECandidateInit,
) error

PostCandidate posts a WHIP/WHEP candidate.

Types

type PostOfferResponse

type PostOfferResponse struct {
	Answer   *webrtc.SessionDescription
	Location string
	ETag     string
}

PostOfferResponse is the response to a post offer.

func PostOffer

func PostOffer(
	ctx context.Context,
	hc *http.Client,
	ur string,
	offer *webrtc.SessionDescription,
) (*PostOfferResponse, error)

PostOffer posts a WHIP/WHEP offer.