Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

webrtc

package module

Go to main page

Versions in this module

v1

v1.1.0

Oct 1, 2018

Changes in this version

+ const DefaultPayloadTypeH264

+ const DefaultPayloadTypeOpus

+ const DefaultPayloadTypeVP8

+ const DefaultPayloadTypeVP9

+ const H264

+ const Unknown

+ var DefaultMediaEngine = NewMediaEngine()

+ var ErrCertificateExpired = errors.New("x509Cert expired")

+ var ErrConnectionClosed = errors.New("connection closed")

+ var ErrExistingTrack = errors.New("track aready exists")

+ var ErrMaxDataChannelID = errors.New("maximum number ID for datachannel specified")

+ var ErrModifyingBundlePolicy = errors.New("bundle policy cannot be modified")

+ var ErrModifyingCertificates = errors.New("certificates cannot be modified")

+ var ErrModifyingIceCandidatePoolSize = errors.New("ice candidate pool size cannot be modified")

+ var ErrModifyingPeerIdentity = errors.New("peerIdentity cannot be modified")

+ var ErrModifyingRtcpMuxPolicy = errors.New("rtcp mux policy cannot be modified")

+ var ErrNegotiatedWithoutID = errors.New("negotiated set without channel id")

+ var ErrNoTurnCredencials = errors.New("turn server credentials required")

+ var ErrPrivateKeyType = errors.New("private key type not supported")

+ var ErrRetransmitsOrPacketLifeTime = errors.New("both MaxPacketLifeTime and MaxRetransmits was set")

+ var ErrStringSizeLimit = errors.New("data channel label exceeds size limit")

+ var ErrTurnCredencials = errors.New("invalid turn server credentials")

+ var ErrUnknownType = errors.New("unknown")

+ func RegisterCodec(codec *RTCRtpCodec)

+ func RegisterDefaultCodecs()

+ type MediaEngine struct

+ func NewMediaEngine() *MediaEngine

+ func (m *MediaEngine) RegisterCodec(codec *RTCRtpCodec) uint8

+ type RTCAnswerOptions struct

+ type RTCBundlePolicy int

+ const RTCBundlePolicyBalanced

+ const RTCBundlePolicyMaxBundle

+ const RTCBundlePolicyMaxCompat

+ func (t RTCBundlePolicy) String() string

+ type RTCCertificate struct

+ func GenerateCertificate(secretKey crypto.PrivateKey) (*RTCCertificate, error)

+ func NewRTCCertificate(key crypto.PrivateKey, tpl x509.Certificate) (*RTCCertificate, error)

+ func (c RTCCertificate) Equals(o RTCCertificate) bool

+ func (c RTCCertificate) Expires() time.Time

+ func (c RTCCertificate) GetFingerprints()

+ type RTCConfiguration struct

+ BundlePolicy RTCBundlePolicy

+ Certificates []RTCCertificate

+ IceCandidatePoolSize uint8

+ IceServers []RTCIceServer

+ IceTransportPolicy RTCIceTransportPolicy

+ PeerIdentity string

+ RtcpMuxPolicy RTCRtcpMuxPolicy

+ type RTCDataChannel struct

+ BufferedAmount uint64

+ BufferedAmountLowThreshold uint64

+ ID *uint16

+ Label string

+ MaxPacketLifeTime *uint16

+ MaxRetransmits *uint16

+ Negotiated bool

+ OnMessage func(datachannel.Payload)

+ OnOpen func()

+ Onmessage func(datachannel.Payload)

+ Ordered bool

+ Priority RTCPriorityType

+ Protocol string

+ ReadyState RTCDataChannelState

+ Transport *RTCSctpTransport

+ func (d *RTCDataChannel) Send(p datachannel.Payload) error

+ type RTCDataChannelInit struct

+ ID *uint16

+ MaxPacketLifeTime *uint16

+ MaxRetransmits *uint16

+ Negotiated *bool

+ Ordered *bool

+ Priority *RTCPriorityType

+ Protocol *string

+ type RTCDataChannelState int

+ const RTCDataChannelStateClosed

+ const RTCDataChannelStateClosing

+ const RTCDataChannelStateConnecting

+ const RTCDataChannelStateOpen

+ func (t RTCDataChannelState) String() string

+ type RTCDtlsFingerprint struct

+ Algorithm string

+ Value string

+ type RTCDtlsTransport struct

+ type RTCDtlsTransportState int

+ const RTCDtlsTransportStateClosed

+ const RTCDtlsTransportStateConnected

+ const RTCDtlsTransportStateConnecting

+ const RTCDtlsTransportStateFailed

+ const RTCDtlsTransportStateNew

+ func (t RTCDtlsTransportState) String() string

+ type RTCIceCandidateType int

+ const RTCIceCandidateTypeHost

+ const RTCIceCandidateTypePrflx

+ const RTCIceCandidateTypeRelay

+ const RTCIceCandidateTypeSrflx

+ func (t RTCIceCandidateType) String() string

+ type RTCIceComponent int

+ const RTCIceComponentRtcp

+ const RTCIceComponentRtp

+ func (t RTCIceComponent) String() string

+ type RTCIceConnectionState int

+ const RTCIceConnectionStateChecking

+ const RTCIceConnectionStateClosed

+ const RTCIceConnectionStateCompleted

+ const RTCIceConnectionStateConnected

+ const RTCIceConnectionStateDisconnected

+ const RTCIceConnectionStateFailed

+ const RTCIceConnectionStateNew

+ func (c RTCIceConnectionState) String() string

+ type RTCIceCredentialType int

+ const RTCIceCredentialTypeOauth

+ const RTCIceCredentialTypePassword

+ func (t RTCIceCredentialType) String() string

+ type RTCIceGatheringState int

+ const RTCIceGatheringStateComplete

+ const RTCIceGatheringStateGathering

+ const RTCIceGatheringStateNew

+ func (t RTCIceGatheringState) String() string

+ type RTCIceProtocol int

+ const RTCIceProtocolTCP

+ const RTCIceProtocolUDP

+ func (t RTCIceProtocol) String() string

+ type RTCIceRole int

+ const RTCIceRoleControlled

+ const RTCIceRoleControlling

+ func (t RTCIceRole) String() string

+ type RTCIceServer struct

+ Credential interface{}

+ CredentialType RTCIceCredentialType

+ URLs []string

+ Username string

+ type RTCIceTransport struct

+ type RTCIceTransportPolicy int

+ const RTCIceTransportPolicyAll

+ const RTCIceTransportPolicyRelay

+ func (t RTCIceTransportPolicy) String() string

+ type RTCOAuthCredential struct

+ AccessToken string

+ MacKey string

+ type RTCOfferAnswerOptions struct

+ VoiceActivityDetection bool

+ type RTCOfferOptions struct

+ IceRestart bool

type RTCPeerConnection

+ ConnectionState RTCPeerConnectionState

+ CurrentLocalDescription *RTCSessionDescription

+ CurrentRemoteDescription *RTCSessionDescription

+ IceConnectionState ice.ConnectionState

+ IceGatheringState RTCIceGatheringState

+ OnDataChannel func(*RTCDataChannel)

+ OnTrack func(*RTCTrack)

+ PendingLocalDescription *RTCSessionDescription

+ PendingRemoteDescription *RTCSessionDescription

+ SignalingState RTCSignalingState

+ func New(configuration RTCConfiguration) (*RTCPeerConnection, error)

+ func (pc *RTCPeerConnection) CreateAnswer(options *RTCAnswerOptions) (RTCSessionDescription, error)

+ func (pc *RTCPeerConnection) CreateDataChannel(label string, options *RTCDataChannelInit) (*RTCDataChannel, error)

+ func (pc *RTCPeerConnection) GetConfiguration() RTCConfiguration

+ func (pc *RTCPeerConnection) GetReceivers() []RTCRtpReceiver

+ func (pc *RTCPeerConnection) GetSenders() []RTCRtpSender

+ func (pc *RTCPeerConnection) GetTransceivers() []RTCRtpTransceiver

+ func (pc *RTCPeerConnection) NewRTCTrack(payloadType uint8, id, label string) (*RTCTrack, error)

+ func (pc *RTCPeerConnection) RemoteDescription() *RTCSessionDescription

+ func (pc *RTCPeerConnection) SendRTCP(pkt rtcp.Packet) error

+ func (pc *RTCPeerConnection) SetConfiguration(configuration RTCConfiguration) error

+ func (pc *RTCPeerConnection) SetIdentityProvider(provider string) error

+ func (pc *RTCPeerConnection) SetMediaEngine(m *MediaEngine)

+ type RTCPeerConnectionState int

+ const RTCPeerConnectionStateClosed

+ const RTCPeerConnectionStateConnected

+ const RTCPeerConnectionStateConnecting

+ const RTCPeerConnectionStateDisconnected

+ const RTCPeerConnectionStateFailed

+ const RTCPeerConnectionStateNew

+ func (t RTCPeerConnectionState) String() string

+ type RTCPriorityType int

+ const RTCPriorityTypeHigh

+ const RTCPriorityTypeLow

+ const RTCPriorityTypeMedium

+ const RTCPriorityTypeVeryLow

+ func (p RTCPriorityType) String() string

+ type RTCRtcpMuxPolicy int

+ const RTCRtcpMuxPolicyNegotiate

+ const RTCRtcpMuxPolicyRequire

+ func (t RTCRtcpMuxPolicy) String() string

+ type RTCRtpCapabilities struct

+ Codecs []RTCRtpCodecCapability

+ HeaderExtensions []RTCRtpHeaderExtensionCapability

+ type RTCRtpCodec struct

+ Name string

+ PayloadType uint8

+ Payloader rtp.Payloader

+ Type RTCRtpCodecType

+ func NewRTCRtpCodec(codecType RTCRtpCodecType, name string, clockrate uint32, channels uint16, ...) *RTCRtpCodec

+ func NewRTCRtpH264Codec(payloadType uint8, clockrate uint32) *RTCRtpCodec

+ func NewRTCRtpOpusCodec(payloadType uint8, clockrate uint32, channels uint16) *RTCRtpCodec

+ func NewRTCRtpVP8Codec(payloadType uint8, clockrate uint32) *RTCRtpCodec

+ func NewRTCRtpVP9Codec(payloadType uint8, clockrate uint32) *RTCRtpCodec

+ type RTCRtpCodecCapability struct

+ Channels uint16

+ ClockRate uint32

+ MimeType string

+ SdpFmtpLine string

+ type RTCRtpCodecType int

+ const RTCRtpCodecTypeAudio

+ const RTCRtpCodecTypeVideo

+ func (t RTCRtpCodecType) String() string

+ type RTCRtpHeaderExtensionCapability struct

+ URI string

+ type RTCRtpReceiver struct

+ Track *RTCTrack

+ type RTCRtpSender struct

+ Track *RTCTrack

+ type RTCRtpTransceiver struct

+ Direction RTCRtpTransceiverDirection

+ Mid string

+ Receiver *RTCRtpReceiver

+ Sender *RTCRtpSender

+ func (t *RTCRtpTransceiver) Stop() error

+ type RTCRtpTransceiverDirection int

+ const RTCRtpTransceiverDirectionInactive

+ const RTCRtpTransceiverDirectionRecvonly

+ const RTCRtpTransceiverDirectionSendonly

+ const RTCRtpTransceiverDirectionSendrecv

+ func NewRTCRtpTransceiverDirection(raw string) RTCRtpTransceiverDirection

+ func (t RTCRtpTransceiverDirection) String() string

+ type RTCSctpTransport struct

+ MaxChannels *uint16

+ MaxMessageSize float64

+ State RTCSctpTransportState

+ Transport *RTCDtlsTransport

+ type RTCSctpTransportState int

+ const RTCSctpTransportStateClosed

+ const RTCSctpTransportStateConnected

+ const RTCSctpTransportStateConnecting

+ func (s RTCSctpTransportState) String() string

+ type RTCSdpType int

+ const RTCSdpTypeAnswer

+ const RTCSdpTypeOffer

+ const RTCSdpTypePranswer

+ const RTCSdpTypeRollback

+ func (t *RTCSdpType) UnmarshalJSON(b []byte) error

+ func (t RTCSdpType) MarshalJSON() ([]byte, error)

+ func (t RTCSdpType) String() string

+ type RTCSessionDescription struct

+ Sdp string

+ Type RTCSdpType

+ type RTCSignalingState int

+ const RTCSignalingStateClosed

+ const RTCSignalingStateHaveLocalOffer

+ const RTCSignalingStateHaveLocalPranswer

+ const RTCSignalingStateHaveRemoteOffer

+ const RTCSignalingStateHaveRemotePranswer

+ const RTCSignalingStateStable

+ func (t RTCSignalingState) String() string

+ type RTCTrack struct

+ Codec *RTCRtpCodec

+ ID string

+ Kind RTCRtpCodecType

+ Label string

+ Packets <-chan *rtp.Packet

+ PayloadType uint8

+ Samples chan<- media.RTCSample

+ Ssrc uint32

v1.0.0

Jul 4, 2018

Changes in this version

+ type RTCPeerConnection struct

+ LocalDescription *sdp.SessionDescription

+ OnICEConnectionStateChange func(iceConnectionState ice.ConnectionState)

+ Ontrack func(mediaType TrackType, buffers <-chan *rtp.Packet)

+ func (r *RTCPeerConnection) AddTrack(mediaType TrackType, clockRate uint32) (samples chan<- RTCSample, err error)

+ func (r *RTCPeerConnection) Close() error

+ func (r *RTCPeerConnection) CreateOffer() error

+ func (r *RTCPeerConnection) SetRemoteDescription(rawSessionDescription string) error

+ type RTCSample struct

+ Data []byte

+ Samples uint32

+ type TrackType int

+ const Opus

+ const VP8

+ const VP9

+ func (t TrackType) String() string