config

Documentation

Index

• func PeerOptsFromInitOpts(config *PeerInitOptions) peerjs.Options
• func PeerServerOptsFromInitOpts(config *PeerInitOptions) peerjsServer.Options
• func StringToLogLevel(s string) (log.Level, error)
• type MediaSourceConfig
• type PeerInitOptions
  • func GetLocalServerPeerInitOptions() PeerInitOptions
  • func GetPeerjsCloudPeerInitOptions() PeerInitOptions
• type WebrtcRelayConfig
  • func GetDefaultRelayConfig() WebrtcRelayConfig
  • func ReadConfigFile(configFilePath string) (WebrtcRelayConfig, error)

Functions

func PeerOptsFromInitOpts

func PeerOptsFromInitOpts(config *PeerInitOptions) peerjs.Options

func PeerServerOptsFromInitOpts

func PeerServerOptsFromInitOpts(config *PeerInitOptions) peerjsServer.Options

func StringToLogLevel

func StringToLogLevel(s string) (log.Level, error)

Types

type MediaSourceConfig

type MediaSourceConfig struct {
	// kind is video or audio (or screen, camera, vnc, microphone to attempt to get system default media devices with Pion MediaDevices)
	Kind string
	// SourceLabel is the id/label to use to refer to this media source later
	SourceLabel string
	// SourceCmd is the command to run to get the media stream (for video and audio only)
	SourceCmd string `json:"SourceCmd,omitempty"`

	// width is the width of the video stream (video formats only)
	Width int `json:"Width,omitempty"`
	// height is the height of the video stream  (video formats only)
	Height int `json:"Height,omitempty"`
	// frameRate is the frame rate of the video stream (video formats only)
	FrameRate float32 `json:"FrameRate,omitempty"`
	// PixelFormat is the pixel format of each frame of the video stream (video formats only, and only raw pixel formats are supported)
	PixelFormat frame.Format `json:"PixelFormat,omitempty"`

	// sampleRate is the sample rate of the audio stream (audio formats only)
	SampleRate int `json:"SampleRate,omitempty"`
	// sampleSize is the number of bytes per sample [Eg: for a 32bit int value samples this would be 4 because 4*8 = 32 bits] (audio formats only)
	SampleSize int `json:"SampleSize,omitempty"`
	// isFloat is whether or not the audio stream samples are represented as float or int (audio formats only)
	IsFloat bool `json:"IsFloat,omitempty"`
	// IsBigEndian is whether or not the audio stream samples use big (BE) or little endian (LE) numbers (audio formats only)
	IsBigEndian bool `json:"IsBigEndian,omitempty"`
	// channelCount is the number of channels in the audio stream (audio formats only)
	ChannelCount int `json:"ChannelCount,omitempty"`
	// isInterleaved is whether or not the audio stream channels are interleaved (audio formats only)
	IsInterleaved bool `json:"IsInterleaved,omitempty"`
}

type PeerInitOptions

type PeerInitOptions struct {
	// RelayPeerNumber (required): A unique number you must provide that identifies this relay peer within webrtc-relay and grpc calls. Whenever some event happens, like a message recived, you will recive this number to indicate which Relay peer the event originated from)
	// This number is *NOT* the peer id of the peerjs peer. It is only used between the relay go code & grpc-backend side.
	RelayPeerNumber uint32

	// Server host. Defaults to 0.peerjs.com. Also accepts '/' to signify relative hostname.
	Host string

	//Port Server port. Defaults to 443.
	Port int

	//Key: API key for the cloud PeerServer. This is not used for servers other than peerjs cloud (0.peerjs.com).
	Key string

	//PingInterval: Heartbeat ping interval in ms  to check /ensure the socket connection to the peer server is still open. Defaults to 5000.
	PingInterval int

	//Path The path where your self-hosted PeerServer is running. Defaults to '/'.
	Path string

	//Secure: true if the server supports using SSL (and you want to use it).
	Secure bool

	//Configuration: struct passed to pion RTCPeerConnection. This contains any custom ICE/TURN server configuration. Defaults to { 'iceServers': [{ 'urls': 'stun:stun.l.google.com:19302' }], 'sdpSemantics': 'unified-plan' }
	Configuration webrtc.Configuration

	// Debug: Prints log messages depending on the debug level passed in. Defaults to 0.
	// 0 Prints no logs.
	// 1 Prints only errors.
	// 2 Prints errors and warnings.
	// 3 Prints all logs (verbose).
	Debug int8

	// ----------- (local peerjs server options) --------------
	// StartLocalServer - if true, the peerjs-go module will start a local peerjs Server with the same config, and then connect to it.
	StartLocalServer bool

	// (local peerjs Server only) Prints log messages from the local peer js server depending on the debug level passed in. Defaults to 0.
	// Options: critical, error, warn, info, debug. (in order of verbosity least to greatest)
	ServerLogLevel string

	// (local peerjs server only) How long to hold onto disconnected peer connections before releasing them & their peer ids.
	ExpireTimeout int64

	// (local peerjs server only) How long to untill disconeected peer connections are marked as not alive.
	AliveTimeout int64

	// (local peerjs server only) How many peers are allowed to be connected to this peer server at the same time.
	ConcurrentLimit int

	// (local peerjs server only) Allow peerjs clients to get a list of connected peers from this server
	AllowDiscovery bool

	// (local peerjs server only) How long the outgoing server websocket message queue can grow before dropping messages.
	CleanupOutMsgs int
}

func GetLocalServerPeerInitOptions

func GetLocalServerPeerInitOptions() PeerInitOptions

func GetPeerjsCloudPeerInitOptions

func GetPeerjsCloudPeerInitOptions() PeerInitOptions

type WebrtcRelayConfig

type WebrtcRelayConfig struct {

	// a list of peer servers to attempt to connect to in parallel when the relay starts up (see PeerInitOptions type for details)
	// Default: !!empty list!!
	PeerInitConfigs []*PeerInitOptions

	// MediaSources: a list of media sources to use for the relay (see MediaSourceConfig type for details)
	// Default: !!empty list!!
	MediaSources []*MediaSourceConfig

	// Automatically stream these media sources to peers when they connect to the relay, based on the label of the media source.
	AutoStreamMediaSources []string

	// the webrtc-relay will try to aquire a peerjs peer id that is this string with an int tacked on the end.
	// if that peer id is taken, it will increment the ending int and try again.
	// Default: "go-relay-"
	BasePeerId string

	// Use a longer but more memorable name in place of the ending number to distiguish webrtc-relay peer ids (name is deterministically based on the end number and MemorablePeerIdOffset, see uid_generation.go).
	// Default: false
	UseMemorablePeerIds bool

	// if UseMemorablePeerIds is true, this number rotates the name indecies for a given peer end number to make name collisions even less likely. Choose any random number that fits in the positive int range.
	// Default: 0
	MemorablePeerIdOffset uint32

	// File path to use for temporarilly storing the token used by peerjs server to verify this client (webrtc-relay) really is the peer id it says it is.
	TokenPersistanceFile string

	// Whether or not the webrtc-relay should attempt to create the named pipes for data communication (set to false if you wish to send messages directly from go code)
	// (note that regardless of this value, the datachannel message string format is the same also media channel named pipes will always be created).
	// Default: true
	StartGRPCServer bool

	// GRPCServerAddress is the address to listen on for GRPC connections
	// To connect over http/2 (default) use the format: "http://host:port"
	// To connect over a unix socket use the format: "unix://path/to/socket" ("unix:///path/to/socket" would be an absolute path)
	GRPCServerAddress string

	// LogLevel: The log verbosity to use for the webrtc-relay. Must be one of: critical, error, warn, info, debug. (debug is most verbose)
	// Default: "warn"
	LogLevel string

	// IncludeMessagesInLogs: If true, messages sent and recived from the backend will be included in the logs, careful with using this in production.
	// Default: "warn"
	IncludeMessagesInLogs bool

	// Go Profiling Server Enabled: If true, the webrtc-relay will start a go pprof profiling server on port 6060, careful with using this in production.
	// see: https://go.dev/blog/pprof
	// Default: false
	GoProfilingServerEnabled bool
	// contains filtered or unexported fields
}

configuration for webrtc-relay

func GetDefaultRelayConfig

func GetDefaultRelayConfig() WebrtcRelayConfig

func ReadConfigFile

func ReadConfigFile(configFilePath string) (WebrtcRelayConfig, error)