whepclient

README

WHEP Client

A simple WHEP client.

Example

package main

import (
	"fmt"
	"os"

	whepclient "github.com/elixir-webrtc/whep-client"
	"github.com/pion/webrtc/v4"
)

func main() {
	url := os.Args[1]

	client, err := whepclient.New(url, webrtc.Configuration{})
	if err != nil {
		panic(err)
	}

	client.Pc.OnICEConnectionStateChange(func(connectionState webrtc.ICEConnectionState) {
		fmt.Printf("Connection State has changed %s \n", connectionState.String())
	})

	client.Pc.OnTrack(func(track *webrtc.TrackRemote, receiver *webrtc.RTPReceiver) {
		fmt.Printf("New track: %s\n", track.Codec().MimeType)
		for {
			_, _, err := track.ReadRTP()
			if err != nil {
				panic(err)
			}
		}
	})

	err = client.Connect()
	if err != nil {
		panic(err)
	}

	// block forever
	select {}
}

Then call:

go run main.go https://yourWhepEndpointURL

Documentation

Index

• Variables
• type Client
  • func New(urlString string, pcConfig webrtc.Configuration) (*Client, error)
  • func NewFromPc(urlString string, pc *webrtc.PeerConnection) (*Client, error)
  • func (client *Client) Connect() error
  • func (client *Client) Disconnect() error

Variables

var (
	ErrInvalidURL         = errors.New("Invalid server URL")
	ErrNoLocationHeader   = errors.New("No location header in the response")
	ErrFailedToDisconnect = errors.New("Failed to remove server resource")
)

Types

type Client

type Client struct {
	Pc *webrtc.PeerConnection
	// contains filtered or unexported fields
}

func New

func New(urlString string, pcConfig webrtc.Configuration) (*Client, error)

New creates a new WHEP client using default Pion codecs and interceptors.

func NewFromPc

func NewFromPc(urlString string, pc *webrtc.PeerConnection) (*Client, error)

NewFromPc creates a new WHEP client using provided peer connection. Can be used when you want to set custom codecs or interceptors.

func (*Client) Connect

func (client *Client) Connect() error

Connect tries to connect to the WHEP server.

func (*Client) Disconnect

func (client *Client) Disconnect() error

Disconnect closes local peer connection and removes server resource.