webrtc

package
v0.0.0-...-5b2bcd3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2026 License: MIT Imports: 11 Imported by: 0

README

WebRTC v3 兼容导入路径

保留历史 format/webrtcv3 API 入口;当前后端已切换到 pion/webrtc/v4, 避免继续引入无可用安全修复的 pion/webrtc/v3 / pion/dtls/v2 依赖。

核心 API

类型/函数 说明
Muxer / NewMuxer(options) 兼容路径复用器,底层使用 Pion WebRTC v4
Options 连接配置

说明

新项目建议直接使用 format/webrtc;本包仅用于平滑旧导入路径。

Documentation

Overview

Package webrtc 保留历史 WebRTC v3 兼容导入路径。

当前实现使用 Pion WebRTC v4 后端,避免继续引入已无可用安全修复的 Pion WebRTC v3 / DTLS v2 依赖。新代码应优先使用 format/webrtc。

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrorNotFound 表示当前没有可发布的 WebRTC 流。
	ErrorNotFound = errors.New("WebRTC Stream Not Found")
	// ErrorCodecNotSupported 表示输入 codec 不能映射到当前 WebRTC 发送路径。
	ErrorCodecNotSupported = errors.New("WebRTC Codec Not Supported")
	// ErrorClientOffline 表示客户端连接已关闭或不可写。
	ErrorClientOffline = errors.New("WebRTC Client Offline")
	// ErrorNotTrackAvailable 表示没有成功创建任何可发送的 WebRTC track。
	ErrorNotTrackAvailable = errors.New("WebRTC Not Track Available")
	// ErrorIgnoreAudioTrack 表示音频 track 因 codec 不受支持而被跳过。
	ErrorIgnoreAudioTrack = errors.New("WebRTC Ignore Audio Track codec not supported WebRTC support only PCM_ALAW or PCM_MULAW")
)

Functions

This section is empty.

Types

type Muxer

type Muxer struct {

	// ClientACK 记录客户端数据通道心跳,关闭时会停止。
	ClientACK *time.Timer
	// StreamACK 记录媒体发送侧活跃状态,关闭时会停止。
	StreamACK *time.Timer
	// Options 保存创建 PeerConnection 时使用的 ICE 与端口配置。
	Options Options
	// contains filtered or unexported fields
}

Muxer 将 VDK packet 写入 WebRTC PeerConnection。

该类型保留历史 format/webrtcv3 API 形态,但底层使用 Pion WebRTC v4。 Muxer 不是可复制类型,创建后应通过指针传递。

func NewMuxer

func NewMuxer(options Options) *Muxer

NewMuxer 创建 WebRTC Muxer。

func (*Muxer) Close

func (element *Muxer) Close() error

Close 关闭 PeerConnection 并停止内部计时器。

func (*Muxer) NewPeerConnection

func (element *Muxer) NewPeerConnection(configuration webrtc.Configuration) (*webrtc.PeerConnection, error)

NewPeerConnection 基于 Options 创建并配置 PeerConnection。

func (*Muxer) WriteHeader

func (element *Muxer) WriteHeader(streams []av.CodecData, sdp64 string) (string, error)

WriteHeader 根据 VDK codec 列表与 base64 SDP offer 创建 WebRTC answer。

func (*Muxer) WritePacket

func (element *Muxer) WritePacket(pkt av.Packet) (err error)

WritePacket 将 VDK packet 写入对应的 WebRTC track。

type Options

type Options struct {
	// ICEServers 是 STUN/TURN 服务器 URL 列表;为空时使用默认 STUN。
	ICEServers []string
	// ICEUsername 是 ICE server 认证用户名。
	ICEUsername string
	// ICECredential 是 ICE server 认证凭据。
	ICECredential string
	// ICECandidates 是 1:1 NAT 场景下暴露给对端的外部 IP 列表。
	ICECandidates []string
	// PortMin 是 UDP 临时端口范围下界,0 表示不限制。
	PortMin uint16
	// PortMax 是 UDP 临时端口范围上界,必须大于 PortMin 才生效。
	PortMax uint16
}

Options 描述 WebRTC Muxer 的 ICE 与网络约束。

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

Stream 绑定单路 VDK codec 与 WebRTC track。

Source Files

  • adapter.go
  • doc.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址