Pion WebRTC

https://pkg.go.dev/github.com/pion/webrtc/v4
Admin
Pion WebRTC is a pure Go implementation of the WebRTC API for building real-time communication...
Tokens:74,471
Snippets:841
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Simulcast Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/simulcast

Use the go install command to download and install the simulcast example binary.

```bash
go install github.com/pion/webrtc/v4/examples/simulcast@latest
```

--------------------------------

### Install play-from-disk Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk

Download and install the example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/play-from-disk@latest
```

--------------------------------

### Install Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/insertable-streams

Install the insertable-streams example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/insertable-streams@latest
```

--------------------------------

### Install Repacketize Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/repacketize

Command to download and install the repacketize example binary.

```bash
go install github.com/pion/webrtc/v4/examples/repacketize@latest
```

--------------------------------

### Install reflect example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/reflect

Use the go install command to download and install the reflect example binary from the Pion WebRTC repository.

```bash
go install github.com/pion/webrtc/v4/examples/reflect@latest
```

--------------------------------

### Install ortc-media example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ortc-media

Installs the latest version of the ortc-media example package.

```bash
go install github.com/pion/webrtc/v4/examples/ortc-media@latest
```

--------------------------------

### Install and Run the Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk-playlist-control

Commands to install the binary and execute the server, optionally specifying a custom address.

```bash
go install github.com/pion/webrtc/v4/examples/play-from-disk-playlist-control@latest
```

```bash
play-from-disk-playlist-control
# or
play-from-disk-playlist-control -addr :8080
```

--------------------------------

### Install save-to-disk-av1

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/save-to-disk-av1

Use the go install command to download and install the example application.

```bash
go install github.com/pion/webrtc/v4/examples/save-to-disk-av1@latest
```

--------------------------------

### Install bandwidth-estimation-from-disk

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/bandwidth-estimation-from-disk

Install the example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/bandwidth-estimation-from-disk@latest
```

--------------------------------

### Run the Example Server

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples

Commands to clone the repository and start the local example server.

```bash
git clone https://github.com/pion/webrtc.git webrtc
cd pion/webrtc/examples
go run examples.go
```

--------------------------------

### Install Broadcast Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/broadcast

Command to install the broadcast example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/broadcast@latest
```

--------------------------------

### Install play-from-disk-fec

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk-fec

Downloads and installs the example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/play-from-disk-fec@latest
```

--------------------------------

### Install custom-logger example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/custom-logger

Command to install the custom-logger example binary using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/custom-logger@latest
```

--------------------------------

### Install ORTC Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ortc

Command to install the ORTC example binary from the Pion WebRTC repository.

```bash
go install github.com/pion/webrtc/v4/examples/ortc@latest
```

--------------------------------

### Install the data-channels server

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels

Use the Go toolchain to download and install the latest version of the data-channels example server.

```bash
go install github.com/pion/webrtc/v4/examples/data-channels@latest
```

--------------------------------

### Install save-to-disk

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/save-to-disk

Command to install the save-to-disk example application using the Go toolchain.

```bash
go install github.com/pion/webrtc/v4/examples/save-to-disk@latest
```

--------------------------------

### Download ice-proxy

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ice-proxy

Install the ice-proxy example binary using the go install command.

```bash
go install github.com/pion/webrtc/v4/examples/ice-proxy@latest
```

--------------------------------

### Start example with Docker Compose

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/pion-to-pion

Use Docker Compose to orchestrate the communication between instances.

```bash
docker-compose up -d
```

--------------------------------

### Install data-channels-detach

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-detach

Command to install the data-channels-detach example binary.

```bash
go install github.com/pion/webrtc/v4/examples/data-channels-detach@latest
```

--------------------------------

### Download swap-tracks

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/swap-tracks

Use this command to install the swap-tracks example binary.

```bash
go install github.com/pion/webrtc/v4/examples/swap-tracks@latest
```

--------------------------------

### Download stats example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/stats

Command to install the stats example binary from the Pion WebRTC repository.

```bash
go install github.com/pion/webrtc/v4/examples/stats@latest
```

--------------------------------

### Run the offer instance

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/pion-to-pion

Install and execute the offer component to initiate the connection.

```bash
go install github.com/pion/webrtc/v4/examples/pion-to-pion/offer@latest
offer
```

--------------------------------

### Download the example repository

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-whip-whep-like

Commands to clone the Pion WebRTC repository and navigate to the specific example directory.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/data-channels-whip-whep-like
```

--------------------------------

### Download ice-restart example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ice-restart

Commands to clone the repository and navigate to the ice-restart example directory.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/ice-restart
```

--------------------------------

### Download the trickle-ice example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/trickle-ice

Commands to clone the repository and navigate to the trickle-ice example directory.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/trickle-ice
```

--------------------------------

### Download rtcp-processing

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtcp-processing

Command to install the rtcp-processing example binary.

```bash
go install github.com/pion/webrtc/v4/examples/rtcp-processing@latest
```

--------------------------------

### Download the whip-whep example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/whip-whep

Clone the Pion WebRTC repository to access the static HTML and Go source files required for the example.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/whip-whep
```

--------------------------------

### Install rtp-forwarder

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtp-forwarder

Use the go install command to download and install the rtp-forwarder binary.

```bash
go install github.com/pion/webrtc/v4/examples/rtp-forwarder@latest
```

--------------------------------

### Install rtp-to-webrtc

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtp-to-webrtc

Use the go install command to download and install the rtp-to-webrtc tool.

```bash
go install github.com/pion/webrtc/v4/examples/rtp-to-webrtc@latest
```

--------------------------------

### Download ice-tcp example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ice-tcp

Clone the repository to access the static HTML files required for the example.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/ice-tcp
```

--------------------------------

### Run ice-proxy

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ice-proxy

Execute the installed ice-proxy binary to start the TURN server, proxy HTTP server, and the offering/answering agents.

```bash
ice-proxy
```

--------------------------------

### Configure Example Server Address

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples

Commands to run the example server on specific network interfaces or ports.

```bash
go run examples.go --address localhost:8080
go run examples.go --address :8080            # listen on all available interfaces
```

--------------------------------

### Run Example on Linux/macOS

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/insertable-streams

Pipe the browser's SessionDescription into the insertable-streams binary.

```bash
echo $BROWSER_SDP | insertable-streams
```

--------------------------------

### Download ice-single-port example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ice-single-port

Commands to clone the Pion WebRTC repository and navigate to the ice-single-port example directory.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/ice-single-port
```

--------------------------------

### Run the answer instance

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/pion-to-pion

Install and execute the answer component which acts as the HTTP server.

```bash
go install github.com/pion/webrtc/v4/examples/pion-to-pion/answer@latest
answer
```

--------------------------------

### Compile Example to WebAssembly

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples

Command to build a Go file into a WebAssembly binary for browser use.

```bash
GOOS=js GOARCH=wasm go build -o demo.wasm
```

--------------------------------

### Clone the quick-switch repository

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/quick-switch

Commands to download the example source code from the Pion WebRTC repository.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/quick-switch
```

--------------------------------

### Example Output

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-detach-create

Expected console output upon successful connection and data exchange.

```text
Peer Connection State has changed: connecting
(Long base64 SDP that you should POST)
Peer Connection State has changed: connected
New DataChannel  1374394845054
Data channel ''-'1374394845054' open.
Message from DataChannel: kvmWkjYodyQcIlv
Sending aMDnwlTfDYnfoUy
Sending htqQtnbvygZKlmy
Message from DataChannel: CMjZiNtsmIBpCaN
```

--------------------------------

### Example output

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/custom-logger

Sample console output showing logs generated by the custom logger implementation.

```text
Creating logger for ice
Creating logger for dtls
Peer Connection State has changed: connected (answerer)
Peer Connection State has changed: connected (offerer)
customLogger Debug: Adding a new peer-reflexive candidate: 10.8.21.1:51196
```

--------------------------------

### Initialize RTPReceiver

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Initializes the track and starts all transports.

```go
func (r *RTPReceiver) Receive(parameters RTPReceiveParameters) error
```

--------------------------------

### Prepare Media Files with ffmpeg

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk

Generate IVF and Ogg files compatible with the play-from-disk example.

```bash
ffmpeg -i "$INPUT_FILE" -g 30 -b:v 2M output.ivf
ffmpeg -i "$INPUT_FILE" -vn -c:a libopus -ac 2 -frame_duration 20 -page_duration 20000 -map_metadata -1 output.ogg
```

--------------------------------

### Example quality switching output

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/bandwidth-estimation-from-disk

Sample console output showing the application switching between different quality levels.

```text
Switching from low.ivf to med.ivf
Switching from med.ivf to high.ivf
Switching from high.ivf to med.ivf
```

--------------------------------

### Prepare Video File

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/insertable-streams

Use ffmpeg to create an IVF file containing a VP8 track for the example.

```bash
ffmpeg -i $INPUT_FILE -g 30 output.ivf
```

--------------------------------

### Clone the Pion WebRTC repository

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk-renegotiation

Download the repository to access the example source code and static HTML files.

```bash
git clone https://github.com/pion/webrtc.git
cd webrtc/examples/play-from-disk-renegotiation
```

--------------------------------

### Access the Hosted UI

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/play-from-disk-playlist-control

The URL to access the local web interface after starting the server.

```text
http://localhost:8080
```

--------------------------------

### Example stats output

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/stats

Sample console output showing InboundRTPStreamStats and remote candidate details for a video stream.

```text
Stats for: video/VP8
InboundRTPStreamStats:
        PacketsReceived: 1255
        PacketsLost: 0
        Jitter: 588.9559641717999
        LastPacketReceivedTimestamp: 2023-04-26 13:16:16.63591134 -0400 EDT m=+18.317378921
        HeaderBytesReceived: 25100
        BytesReceived: 1361125
        FIRCount: 0
        PLICount: 0
        NACKCount: 0


remote-candidate IP(192.168.1.93) Port(59239)
remote-candidate IP(172.18.176.1) Port(59241)
remote-candidate IP(fd4d:d991:c340:6749:8c53:ee52:ae8c:14d4) Port(59238)
```

--------------------------------

### Run Data Channels Flow Control Example

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-flow-control

Command to execute the flow control demonstration, which establishes a peer-to-peer connection and measures throughput.

```bash
$ go run main.go
2019/08/31 14:56:41 OnOpen: data-824635025728. Start sending a series of 1024-byte packets as fast as it can
2019/08/31 14:56:41 OnOpen: data-824637171120. Start receiving data
2019/08/31 14:56:42 Throughput: 179.118 Mbps
2019/08/31 14:56:43 Throughput: 203.545 Mbps
2019/08/31 14:56:44 Throughput: 211.516 Mbps
2019/08/31 14:56:45 Throughput: 216.292 Mbps
2019/08/31 14:56:46 Throughput: 217.961 Mbps
2019/08/31 14:56:47 Throughput: 218.342 Mbps
 :
```

--------------------------------

### Get RTPSender Parameters

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Describes the current configuration for encoding and transmission.

```go
func (r *RTPSender) GetParameters() RTPSendParameters
```

--------------------------------

### func (*SCTPTransport) Start

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Starts the SCTPTransport using Simultaneous Open.

```APIDOC
## func (*SCTPTransport) Start(capabilities SCTPCapabilities)

### Description
Start the SCTPTransport. Since both local and remote parties must mutually create an SCTPTransport, SCTP SO (Simultaneous Open) is used to establish a connection over SCTP.

### Parameters
- **capabilities** (SCTPCapabilities) - Required - The capabilities to start the transport with.

### Returns
- **error** - Returns an error if the transport fails to start.
```

--------------------------------

### Get RTPReceiver Track

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the RtpTransceiver TrackRemote.

```go
func (r *RTPReceiver) Track() *TrackRemote
```

--------------------------------

### Get RTPReceiver Transport

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the configured DTLSTransport or nil.

```go
func (r *RTPReceiver) Transport() *DTLSTransport
```

--------------------------------

### Get DTLSTransport

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the underlying DTLSTransport instance used by the SCTPTransport.

```go
func (r *SCTPTransport) Transport() *DTLSTransport
```

--------------------------------

### Initialize OggReader with Options

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/oggreader

Creates a new Ogg reader with configurable options.

```go
func NewWithOptions(in io.Reader, options ...Option) (*OggReader, error)
```

--------------------------------

### Get PeerConnection ID

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the unique identifier for the PeerConnection instance.

```go
func (pc *PeerConnection) ID() string
```

--------------------------------

### Get SCTP transport

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the SCTPTransport instance used by the DataChannel.

```go
func (d *DataChannel) Transport() *SCTPTransport
```

--------------------------------

### Get DataChannel state

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the current state of the DataChannel object.

```go
func (d *DataChannel) ReadyState() DataChannelState
```

--------------------------------

### Get DataChannel protocol

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the name of the sub-protocol associated with the channel.

```go
func (d *DataChannel) Protocol() string
```

--------------------------------

### Construct a new SampleBuilder

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/samplebuilder

Initializes a new SampleBuilder with a specified depacketizer and configuration options.

```go
func New(maxLate uint16, depacketizer rtp.Depacketizer, sampleRate uint32, opts ...Option) *SampleBuilder
```

--------------------------------

### Get DataChannel label

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the label used to distinguish the DataChannel.

```go
func (d *DataChannel) Label() string
```

--------------------------------

### Initialize PeerConnection

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Creates a new PeerConnection with default codecs and interceptors.

```go
func NewPeerConnection(configuration Configuration) (*PeerConnection, error)
```

--------------------------------

### Create SDP Offers and Answers

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Generates local descriptions for SDP negotiation.

```go
func (pc *PeerConnection) CreateAnswer(options *AnswerOptions) (SessionDescription, error)
```

```go
func (pc *PeerConnection) CreateOffer(options *OfferOptions) (SessionDescription, error)
```

--------------------------------

### Get Signaling State

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the current signaling state of the PeerConnection instance.

```go
func (pc *PeerConnection) SignalingState() SignalingState
```

--------------------------------

### Get Connection Statistics

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns a report containing statistics about the overall connection.

```go
func (pc *PeerConnection) GetStats() StatsReport
```

--------------------------------

### Run WebRTC DataChannel Server

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-simple

Execute the Go signaling server to initiate the WebRTC DataChannel connection.

```bash
go run main.go
```

--------------------------------

### Create Data Channel

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Initializes a new DataChannel with a label and optional configuration.

```go
func (pc *PeerConnection) CreateDataChannel(label string, options *DataChannelInit) (*DataChannel, error)
```

--------------------------------

### Get Connection State

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Retrieves the current connection state of the PeerConnection instance.

```go
func (pc *PeerConnection) ConnectionState() PeerConnectionState
```

--------------------------------

### Initialize H265Reader

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/h265reader

Functions to create a new H265Reader instance, with or without additional configuration options.

```go
func NewReader(in io.Reader) (*H265Reader, error)
```

```go
func NewReaderWithOptions(in io.Reader, options ...Option) (*H265Reader, error)
```

--------------------------------

### Get RTPReceiver Tracks

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the RtpTransceiver tracks, supporting multiple tracks for simulcast.

```go
func (r *RTPReceiver) Tracks() []*TrackRemote
```

--------------------------------

### Get DataChannel ID

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the ID for the DataChannel, which may be null if not yet negotiated.

```go
func (d *DataChannel) ID() *uint16
```

--------------------------------

### Run rtp-forwarder on Linux/macOS

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtp-forwarder

Pipe the browser-generated Session Description Protocol (SDP) string directly into the rtp-forwarder command.

```bash
echo $BROWSER_SDP | rtp-forwarder
```

--------------------------------

### Define OfferOptions structure

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Use this structure to configure the offer creation process, specifically for controlling ICE gathering restarts.

```go
type OfferOptions struct {
	OfferAnswerOptions

	// ICERestart forces the underlying ice gathering process to be restarted.
	// When this value is true, the generated description will have ICE
	// credentials that are different from the current credentials
	ICERestart bool
}
```

--------------------------------

### NewWith

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/h264writer

Initializes a new H264Writer instance using an existing io.Writer.

```APIDOC
## func NewWith(w io.Writer) *H264Writer

### Description
Initializes a new H264 writer with a custom io.Writer output.

### Parameters
- **w** (io.Writer) - Required - The writer interface to output H264 data.

### Returns
- ***H264Writer** - A pointer to the initialized H264Writer.
```

--------------------------------

### Initialize a New Writer

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/rtpdump

Creates a new writer and writes the provided header to the output stream.

```go
func NewWriter(w io.Writer, hdr Header) (*Writer, error)
```

--------------------------------

### Create New ICECandidatePair

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Initializes a new ICECandidatePair instance.

```go
func NewICECandidatePair(local, remote *ICECandidate) *ICECandidatePair
```

--------------------------------

### Get SCTP Transport

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the SCTP transport for the connection. Returns nil if SCTP has not been negotiated.

```go
func (pc *PeerConnection) SCTP() *SCTPTransport
```

--------------------------------

### Configure WithPacketHeadHandler

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/samplebuilder

Sets a handler to inspect the head packet and return custom metadata.

```go
func WithPacketHeadHandler(h func(headPacket any) any) Option
```

--------------------------------

### Run rtcp-processing on Linux/macOS

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtcp-processing

Execute the binary by piping the browser-generated SDP string.

```bash
echo $BROWSER_SDP | rtcp-processing
```

--------------------------------

### Get Remote Description

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the active remote description, prioritizing the pending description if available.

```go
func (pc *PeerConnection) RemoteDescription() *SessionDescription
```

--------------------------------

### Get DataChannel max retransmits

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the maximum number of retransmissions allowed in unreliable mode.

```go
func (d *DataChannel) MaxRetransmits() *uint16
```

--------------------------------

### Architecture Overview

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels

A Mermaid flowchart illustrating the signaling process and data flow between the browser and the Pion Go peer.

```mermaid
flowchart TB
    Browser--Copy Offer from TextArea-->Pion
    Pion--Copy Text Print to Console-->Browser
    subgraph Pion[Go Peer]
        p1[Create PeerConnection]
        p2[OnConnectionState Handler]
        p3[Print Connection State]
        p2-->p3
        p4[OnDataChannel Handler]
        p5[OnDataChannel Open]
        p6[Send Random Message every 5 seconds to DataChannel]
        p4-->p5-->p6
        p7[OnDataChannel Message]
        p8[Log Incoming Message to Console]
        p4-->p7-->p8
        p9[Read Session Description from Standard Input]
        p10[SetRemoteDescription with Session Description from Standard Input]
        p11[Create Answer]
        p12[Block until ICE Gathering is Complete]
        p13[Print Answer with ICE Candidatens included to Standard Output]
    end
    subgraph Browser[Browser Peer]
        b1[Create PeerConnection]
        b2[Create DataChannel 'foo']
        b3[OnDataChannel Message]
        b4[Log Incoming Message to Console]
        b3-->b4
        b5[Create Offer]
        b6[SetLocalDescription with Offer]
        b7[Print Offer with ICE Candidates included]

    end
```

--------------------------------

### Get DataChannel buffered amount low threshold

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the threshold at which the bufferedAmount is considered low.

```go
func (d *DataChannel) BufferedAmountLowThreshold() uint64
```

--------------------------------

### Pop media samples

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/samplebuilder

Compiles pushed RTP packets and returns the next valid media sample.

```go
func (s *SampleBuilder) Pop() *media.Sample
```

--------------------------------

### Configuration Options

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/h264reader

Types and functions for configuring the H264Reader behavior.

```go
type Option func(*H264Reader) error
```

```go
func WithIncludeSEI(include bool) Option
```

--------------------------------

### ICETransport Lifecycle and Event Handlers

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods for starting, stopping, and handling state changes in the ICE transport.

```go
func (t *ICETransport) GracefulStop() error
```

```go
func (t *ICETransport) OnConnectionStateChange(f func(ICETransportState))
```

```go
func (t *ICETransport) OnSelectedCandidatePairChange(f func(*ICECandidatePair))
```

```go
func (t *ICETransport) Start(gatherer *ICEGatherer, params ICEParameters, role *ICERole) error
```

```go
func (t *ICETransport) StartContext(
	ctx context.Context,
	gatherer *ICEGatherer,
	params ICEParameters,
	role *ICERole,
) error
```

--------------------------------

### Configure Simulcast Extension Headers

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Enables RTP extension headers required for Simulcast.

```go
func ConfigureSimulcastExtensionHeaders(mediaEngine *MediaEngine) error
```

--------------------------------

### func (*ICEGatherer) GracefulClose

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Prunes all local candidates and closes the ports, waiting for started goroutines to complete.

```APIDOC
## func (*ICEGatherer) GracefulClose

### Description
GracefulClose prunes all local candidates, and closes the ports. It also waits for any goroutines it started to complete. This is only safe to call outside of ICEGatherer callbacks or if in a callback, in its own goroutine.

### Signature
`func (g *ICEGatherer) GracefulClose() error`
```

--------------------------------

### Define Packet Structure

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/rtpdump

Represents an RTP or RTCP packet with its associated time offset from the recording start.

```go
type Packet struct {
	// Offset is the time since the start of recording in milliseconds
	Offset time.Duration
	// IsRTCP is true if the payload is RTCP, false if the payload is RTP
	IsRTCP bool
	// Payload is the binary RTP or RTCP payload. The contents may not parse
	// as a valid packet if the contents have been truncated.
	Payload []byte
}
```

--------------------------------

### Initialize OggReader with NewWith

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/oggreader

Creates a new Ogg reader and header from an io.Reader. Note that this only parses the first OpusHead.

```go
func NewWith(in io.Reader) (*OggReader, *OggHeader, error)
```

--------------------------------

### RTP packet reception output

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ortc-media

Example output displayed when the client successfully receives an RTP packet.

```text
Got RTP Packet with SSRC 3097857772
```

--------------------------------

### Create a new PeerConnection

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Constructs a PeerConnection with default codecs and interceptors. Use WithMediaEngine and WithInterceptorRegistry in NewAPI to override defaults.

```go
func (api *API) NewPeerConnection(configuration Configuration) (*PeerConnection, error)
```

--------------------------------

### Get DataChannel buffered amount

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the number of bytes of application data queued using send().

```go
func (d *DataChannel) BufferedAmount() uint64
```

--------------------------------

### Reader Initialization Functions

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/h264reader

Functions to initialize a new H264Reader, with or without custom options.

```go
func NewReader(in io.Reader) (*H264Reader, error)
```

```go
func NewReaderWithOptions(in io.Reader, options ...Option) (*H264Reader, error)
```

--------------------------------

### Define Header Structure

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/rtpdump

Represents the binary header at the start of an RTPDump file containing source and timing information.

```go
type Header struct {
	// start of recording (GMT)
	Start time.Time
	// network source (multicast address)
	Source net.IP
	// UDP port
	Port uint16
}
```

--------------------------------

### Configure TWCC

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Sets up TWCC header extensions or report generation. Must be called after registering codecs with the MediaEngine.

```go
func ConfigureTWCCHeaderExtensionSender(mediaEngine *MediaEngine, interceptorRegistry *interceptor.Registry) error
```

```go
func ConfigureTWCCSender(mediaEngine *MediaEngine, interceptorRegistry *interceptor.Registry) error
```

```go
func ConfigureTWCCSenderWithOptions(mediaEngine *MediaEngine, interceptorRegistry *interceptor.Registry,
	opts ...twcc.Option,
) error
```

--------------------------------

### API Structure and Initialization

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Defines the API struct and its constructor for managing semi-global WebRTC settings.

```go
type API struct {
	// contains filtered or unexported fields
}
```

```go
func NewAPI(options ...func(*API)) *API
```

--------------------------------

### Initialize OggWriter

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/oggwriter

Functions to create a new single-track OGG Opus writer.

```go
func New(fileName string, sampleRate uint32, channelCount uint16) (*OggWriter, error)
```

```go
func NewWith(out io.Writer, sampleRate uint32, channelCount uint16) (*OggWriter, error)
```

--------------------------------

### RTPReceiver Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods for interacting with the RTPReceiver to get parameters, transceiver info, or read incoming RTCP packets.

```go
func (r *RTPReceiver) GetParameters() RTPParameters
```

```go
func (r *RTPReceiver) RTPTransceiver() *RTPTransceiver
```

```go
func (r *RTPReceiver) Read(b []byte) (n int, a interceptor.Attributes, err error)
```

```go
func (r *RTPReceiver) ReadRTCP() ([]rtcp.Packet, interceptor.Attributes, error)
```

--------------------------------

### WithWidthAndHeight configuration

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/ivfwriter

Sets the video dimensions for the IVF output.

```go
func WithWidthAndHeight(width, height uint16) Option
```

--------------------------------

### Get Pending Remote Description

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the remote description currently being negotiated. Returns null if in the stable state.

```go
func (pc *PeerConnection) PendingRemoteDescription() *SessionDescription
```

--------------------------------

### Define DataChannelParameters

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Configuration structure for initializing a DataChannel.

```go
type DataChannelParameters struct {
	Label             string  `json:"label"`
	Protocol          string  `json:"protocol"`
	ID                *uint16 `json:"id"`
	Ordered           bool    `json:"ordered"`
	MaxPacketLifeTime *uint16 `json:"maxPacketLifeTime"`
	MaxRetransmits    *uint16 `json:"maxRetransmits"`
	Negotiated        bool    `json:"negotiated"`
}
```

--------------------------------

### Get Pending Local Description

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the local description currently being negotiated. Returns null if in the stable state.

```go
func (pc *PeerConnection) PendingLocalDescription() *SessionDescription
```

--------------------------------

### SettingEngine Configuration Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods available on the SettingEngine struct to configure PeerConnection behavior.

```APIDOC
## func (*SettingEngine) DetachDataChannels()

### Description
Enables detaching data channels. When enabled, data channels must be detached in the OnOpen callback using the DataChannel.Detach method.

## func (*SettingEngine) DisableActiveTCP(isDisabled bool)

### Description
Disables using active TCP for ICE. Active TCP is enabled by default.

## func (*SettingEngine) DisableCertificateFingerprintVerification(isDisabled bool)

### Description
Disables fingerprint verification after the DTLS Handshake has finished.

## func (*SettingEngine) DisableCloseByDTLS(isEnabled bool)

### Description
Sets if the connection should be closed when the DTLS transport is closed. Setting this to true keeps the connection open when the DTLS transport is closed, relying on the ICE failed state to detect interruption.

## func (*SettingEngine) DisableMediaEngineCopy(isDisabled bool)

### Description
Stops the MediaEngine from being copied, allowing modification of the MediaEngine after the PeerConnection has been constructed.

## func (*SettingEngine) DisableMediaEngineMultipleCodecs(isDisabled bool)

### Description
Disables the MediaEngine negotiating different codecs. This setting is targeted to be removed in release 4.2.0 or later.

## func (*SettingEngine) DisableSRTCPReplayProtection(isDisabled bool)

### Description
Disables SRTCP replay protection.

## func (*SettingEngine) DisableSRTPReplayProtection(isDisabled bool)

### Description
Disables SRTP replay protection.

## func (*SettingEngine) EnableDataChannelBlockWrite(nonblockWrite bool)

### Description
Allows data channels to block on write. This only works if DetachDataChannels is enabled.

## func (*SettingEngine) EnableSCTPZeroChecksum(isEnabled bool)

### Description
Controls the zero checksum feature in SCTP to reduce latency and CPU usage. This feature is not backwards compatible and is disabled by default.

## func (*SettingEngine) EnableSctpSnap(isEnabled bool)

### Description
Enables the use of the SCTP SNAP connect optimization.

## func (*SettingEngine) SetAnsweringDTLSRole(role DTLSRole) error

### Description
Sets the DTLS role selected when offering. The role controls whether the WebRTC client acts as a client or server.
```

--------------------------------

### Get DataChannel max packet life time

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Returns the time window in milliseconds for transmissions in unreliable mode.

```go
func (d *DataChannel) MaxPacketLifeTime() *uint16
```

--------------------------------

### Configure RTCP Reports

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Sets up generation of Sender and Receiver Reports.

```go
func ConfigureRTCPReports(interceptorRegistry *interceptor.Registry) error
```

```go
func ConfigureRTCPReportsWithOptions(interceptorRegistry *interceptor.Registry, recvOpts []report.ReceiverOption,
	sendOpts ...report.SenderOption,
) error
```

--------------------------------

### Enable SCTP SNAP

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Enables the use of the SCTP SNAP connect optimization.

```go
func (e *SettingEngine) EnableSctpSnap(isEnabled bool)
```

--------------------------------

### Manage SCTP Transport

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods for interacting with the SCTP transport, including state checks, metadata retrieval, and starting the connection.

```go
func (r *SCTPTransport) BufferedAmount() int
```

```go
func (r *SCTPTransport) GetCapabilities() SCTPCapabilities
```

```go
func (r *SCTPTransport) GetSctpInit() []byte
```

```go
func (r *SCTPTransport) MaxChannels() uint16
```

```go
func (r *SCTPTransport) Metadata() (SCTPTransportMetadata, bool)
```

```go
func (r *SCTPTransport) Start(capabilities SCTPCapabilities) error
```

```go
func (r *SCTPTransport) State() SCTPTransportState
```

--------------------------------

### SetDTLSConnectContextMaker

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Sets the context provider for DTLS handshakes to manage timeouts. The provided example demonstrates a 30-second timeout implementation.

```go
func (e *SettingEngine) SetDTLSConnectContextMaker(connectContextMaker func() (context.Context, func()))
```

```go
func ConnectContextMaker() (context.Context, func()) {
	return context.WithTimeout(context.Background(), 30*time.Second)
}
```

--------------------------------

### New IVFWriter constructor

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/ivfwriter

Creates a new IVFWriter instance targeting a file on disk.

```go
func New(fileName string, opts ...Option) (*IVFWriter, error)
```

--------------------------------

### Create IVF file with ffmpeg

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/ortc-media

Generates an IVF file from an input video file for use with the ORTC media example.

```bash
ffmpeg -i $INPUT_FILE -g 30 -b:v 2M output.ivf
```

--------------------------------

### API Configuration Options

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Functions to configure the API with specific components like Interceptors, MediaEngine, or SettingEngine.

```go
func WithInterceptorRegistry(ir *interceptor.Registry) func(a *API)
```

```go
func WithMediaEngine(m *MediaEngine) func(a *API)
```

```go
func WithSettingEngine(s SettingEngine) func(a *API)
```

--------------------------------

### OfferAnswerOptions Structure

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Describes options to control the offer/answer creation process.

```go
type OfferAnswerOptions struct {
	// VoiceActivityDetection allows the application to provide information
	// about whether it wishes voice detection feature to be enabled or disabled.
	VoiceActivityDetection bool
	// ICETricklingSupported indicates whether the ICE agent should use trickle ICE
	// If set, the "a=ice-options:trickle" attribute is added to the generated SDP payload.
	// (See https://datatracker.ietf.org/doc/html/rfc9725#section-4.3.3)
	ICETricklingSupported bool
}
```

--------------------------------

### func NewReader(r io.Reader) (*Reader, Header, error)

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/rtpdump

Opens a new Reader and reads the Header from the start of the input stream.

```APIDOC
## func NewReader(r io.Reader)

### Description
NewReader opens a new Reader and immediately reads the Header from the start of the input stream.

### Parameters
- **r** (io.Reader) - Required - The input stream to read from.

### Returns
- **Reader** (*Reader) - The initialized reader instance.
- **Header** (Header) - The header read from the stream.
- **error** (error) - Error if the operation fails.
```

--------------------------------

### Gracefully close DataChannel

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Closes the channel and waits for started goroutines to complete. Must be called outside of DataChannel callbacks or in a separate goroutine.

```go
func (d *DataChannel) GracefulClose() error
```

--------------------------------

### WithFrameRate configuration

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/ivfwriter

Sets the frame rate using numerator and denominator values.

```go
func WithFrameRate(numerator, denominator uint32) Option
```

--------------------------------

### Analyze streams with ffprobe

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/rtp-forwarder

Use ffprobe to inspect the details of the generated rtp-forwarder.sdp file.

```bash
ffprobe -i rtp-forwarder.sdp -protocol_whitelist file,udp,rtp
```

--------------------------------

### Configure WithRTPHeaders

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/samplebuilder

Enables collection of RTP headers within the resulting Sample.

```go
func WithRTPHeaders(enable bool) Option
```

--------------------------------

### Configure ICE UDP Multiplexing

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Allows ICE traffic to share a single UDP port. The provided UDPMux must be started before creating PeerConnections.

```go
func (e *SettingEngine) SetICEUDPMux(udpMux ice.UDPMux)
```

--------------------------------

### NewWith IVFWriter constructor

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/ivfwriter

Initializes an IVFWriter using an io.Writer interface.

```go
func NewWith(out io.Writer, opts ...Option) (*IVFWriter, error)
```

--------------------------------

### Initialize a New Reader

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/rtpdump

Creates a new reader and reads the header from the provided input stream.

```go
func NewReader(r io.Reader) (*Reader, Header, error)
```

--------------------------------

### Define a media Sample

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media

Represents encoded media along with its timing information and optional RTP headers.

```go
type Sample struct {
	Data               []byte
	Timestamp          time.Time
	Duration           time.Duration
	PacketTimestamp    uint32
	PrevDroppedPackets uint16
	Metadata           any

	// RTP headers of RTP packets forming this Sample. (Optional)
	// Useful for accessing RTP extensions associated to the Sample.
	RTPHeaders []*rtp.Header
}
```

--------------------------------

### SettingEngine Configuration Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods available on the SettingEngine struct to configure various aspects of the WebRTC connection, including ICE, DTLS, SCTP, and network settings.

```APIDOC
## SettingEngine Configuration

### Description
The SettingEngine allows for fine-grained configuration of the PeerConnection. Methods include:
- SetDTLSRetransmissionInterval(interval time.Duration)
- SetEphemeralUDPPortRange(portMin, portMax uint16) error
- SetICECredentials(usernameFragment, password string)
- SetICEUDPMux(udpMux ice.UDPMux)
- SetReceiveMTU(receiveMTU uint)
- SetSCTPMaxMessageSize(maxMessageSize uint32)
- SetSRTPProtectionProfiles(profiles ...dtls.SRTPProtectionProfile)
```

--------------------------------

### Enable Loopback Candidates

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Enables gathering of loopback candidates, useful for environments where public IPs are mapped to loopback interfaces.

```go
func (e *SettingEngine) SetIncludeLoopbackCandidate(include bool)
```

--------------------------------

### ICEServer Configuration and JSON Handling

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Defines a STUN/TURN server configuration and provides methods for JSON serialization.

```go
type ICEServer struct {
	URLs           []string          `json:"urls"`
	Username       string            `json:"username,omitempty"`
	Credential     any               `json:"credential,omitempty"`
	CredentialType ICECredentialType `json:"credentialType,omitempty"`
}
```

```go
func (s ICEServer) MarshalJSON() ([]byte, error)
```

```go
func (s *ICEServer) UnmarshalJSON(b []byte) error
```

--------------------------------

### H265Writer SDK Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/h265writer

Methods for initializing, writing, and closing an H265Writer instance.

```APIDOC
## func New(filename string) (*H265Writer, error)

### Description
Creates a new H265Writer that writes to the specified file.

### Parameters
- **filename** (string) - Required - The path to the file where H.265 data will be written.

## func NewWith(w io.Writer) *H265Writer

### Description
Initializes a new H265Writer using an existing io.Writer interface.

### Parameters
- **w** (io.Writer) - Required - The output destination for the H.265 data.

## func (h *H265Writer) WriteRTP(packet *rtp.Packet) error

### Description
Processes an H.265/HEVC RTP packet and writes the payload to the underlying writer.

### Parameters
- **packet** (*rtp.Packet) - Required - The RTP packet to be processed.

## func (h *H265Writer) Close() error

### Description
Closes the underlying writer and performs any necessary cleanup.
```

--------------------------------

### ICEConnectionState Conversion and String Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods for converting strings to ICEConnectionState and retrieving its string representation.

```go
func NewICEConnectionState(raw string) ICEConnectionState
```

```go
func (c ICEConnectionState) String() string
```

--------------------------------

### Run data-channels-detach-create

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/data-channels-detach-create

Execute the create process and pipe the output to the detach process.

```bash
go run data-channels-detach-create/*.go | go run data-channels-detach/*.go
```

--------------------------------

### CertificateFromPEM

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Creates a fresh certificate based on a string containing PEM blocks for the private key and X509 certificate.

```APIDOC
## func CertificateFromPEM

### Description
Creates a fresh certificate based on a string containing pem blocks for the private key and x509 certificate.

### Signature
`func CertificateFromPEM(pems string) (*Certificate, error)`
```

--------------------------------

### Set Local Description

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Sets the local SessionDescription for the peer connection.

```go
func (pc *PeerConnection) SetLocalDescription(desc SessionDescription) error
```

--------------------------------

### Construct an RTPSender

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Creates a new RTPSender instance.

```go
func (api *API) NewRTPSender(track TrackLocal, transport *DTLSTransport) (*RTPSender, error)
```

--------------------------------

### Define SampleBuilder struct

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/pkg/media/samplebuilder

The primary structure for buffering packets until media frames are complete.

```go
type SampleBuilder struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Run Chrome with SCTP Interleaving Flags

Source: https://pkg.go.dev/github.com/pion/webrtc/v4/examples/sctp-interleaving-inspect

Launch Chrome with specific field trials to enable I-DATA support for testing.

```bash
[chrome] -user-data-dir=/tmp/chrome-sctp-test --force-fieldtrials="WebRTC-DataChannel-Dcsctp/Enabled/WebRTC-DataChannelMessageInterleaving/Enabled/" http://localhost:8080
```

--------------------------------

### Construct an RTPReceiver

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Creates a new RTPReceiver instance.

```go
func (api *API) NewRTPReceiver(kind RTPCodecType, transport *DTLSTransport) (*RTPReceiver, error)
```

--------------------------------

### Manage PeerConnection Configuration

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Retrieves the current configuration. Note that the returned object is a copy; mutations require calling SetConfiguration.

```go
func (pc *PeerConnection) GetConfiguration() Configuration
```

--------------------------------

### SDPSemantics JSON and String Methods

Source: https://pkg.go.dev/github.com/pion/webrtc/v4

Methods for marshaling, unmarshaling, and string representation of SDPSemantics.

```go
func (s SDPSemantics) MarshalJSON() ([]byte, error)
```

```go
func (s SDPSemantics) String() string
```

```go
func (s *SDPSemantics) UnmarshalJSON(b []byte) error
```
Tokens:
Raw