Documentation
¶
Index ¶
- type CaptureState
- type Event
- type Options
- type QualityProfile
- type Session
- func (session *Session) AddCandidate(connectionID string, candidate *webrtc.ICECandidateInit) error
- func (session *Session) Close() error
- func (session *Session) CloseEdge(connectionID string)
- func (session *Session) ClosePublication(generation, connectionID string)
- func (session *Session) Codec() string
- func (session *Session) Done() <-chan error
- func (session *Session) HasAudio() bool
- func (session *Session) PrepareEdge(connectionID string, iceServers []webrtc.ICEServer) (webrtc.SessionDescription, error)
- func (session *Session) PrepareLocalEdge(connectionID string) (webrtc.SessionDescription, error)
- func (session *Session) PreparePublication(generation, connectionID string, servers []webrtc.ICEServer) (webrtc.SessionDescription, mediaedge.PublicationMedia, error)
- func (session *Session) Publication(generation, connectionID string) (*mediaedge.Publication, error)
- func (session *Session) ReplaceSource(options nativecapture.VideoOptions, audioEnabled bool, ...) error
- func (session *Session) SetAnswer(connectionID string, answer webrtc.SessionDescription) error
- func (session *Session) SetMicrophone(enabled *bool, gain *float64, deviceID *string) error
- func (session *Session) SetPaused(paused bool)
- func (session *Session) ShareID() string
- func (session *Session) SourceAudio() *bool
- func (session *Session) UpdateProfile(profile QualityProfile) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CaptureState ¶
type CaptureState struct {
State string `json:"state"`
HardwareOnly bool `json:"hardwareOnly"`
Codec string `json:"codec"`
AdapterIndex *uint32 `json:"adapterIndex,omitempty"`
AdapterName string `json:"adapterName,omitempty"`
AdapterIdentity string `json:"adapterIdentity,omitempty"`
EncoderIndex *uint32 `json:"encoderIndex,omitempty"`
EncoderName string `json:"encoderName,omitempty"`
EncoderIdentity string `json:"encoderIdentity,omitempty"`
ProfileLevelID string `json:"profileLevelId,omitempty"`
Width uint32 `json:"width,omitempty"`
Height uint32 `json:"height,omitempty"`
FPS uint32 `json:"fps,omitempty"`
RestoreToken string `json:"restoreToken,omitempty"`
Outputs []nativecapture.OutputProfile `json:"outputs"`
// contains filtered or unexported fields
}
type Event ¶
type Event struct {
Current func() bool
SourceAudio bool
Microphone bool
Failed bool
Type string
ConnectionID string
PublicationGeneration string
Candidate *webrtc.ICECandidateInit
State string
LocalType string
RemoteType string
NatTraversalPath string
Quality *mediaedge.QualitySample
PublicationQuality *mediaedge.PublicationQualitySample
}
type Options ¶
type Options struct {
CaptureProcess string
Video nativecapture.VideoOptions
Profile QualityProfile
AudioEnabled bool
ExcludeAudio *nativecapture.CaptureTarget
MicrophoneMixing bool
EdgeCapacity int
BindAddress string
PortMapping bool
Events func(context.Context, Event)
}
type QualityProfile ¶
type QualityProfile struct {
Video nativecapture.VideoProfile
AudioBitrate int
}
func (QualityProfile) Valid ¶
func (profile QualityProfile) Valid() bool
type Session ¶
type Session struct {
// contains filtered or unexported fields
}
func (*Session) AddCandidate ¶
func (session *Session) AddCandidate( connectionID string, candidate *webrtc.ICECandidateInit, ) error
func (*Session) ClosePublication ¶
func (*Session) PrepareEdge ¶
func (*Session) PrepareLocalEdge ¶
func (session *Session) PrepareLocalEdge( connectionID string, ) (webrtc.SessionDescription, error)
func (*Session) PreparePublication ¶
func (session *Session) PreparePublication(generation, connectionID string, servers []webrtc.ICEServer) (webrtc.SessionDescription, mediaedge.PublicationMedia, error)
func (*Session) Publication ¶
func (session *Session) Publication(generation, connectionID string) (*mediaedge.Publication, error)
func (*Session) ReplaceSource ¶
func (session *Session) ReplaceSource( options nativecapture.VideoOptions, audioEnabled bool, excludeAudio *nativecapture.CaptureTarget, ) error
func (*Session) SetAnswer ¶
func (session *Session) SetAnswer(connectionID string, answer webrtc.SessionDescription) error
func (*Session) SetMicrophone ¶ added in v1.6.0
func (*Session) SourceAudio ¶ added in v1.6.0
Optional facts are emitted only to a page which opted into mixed audio.
func (*Session) UpdateProfile ¶
func (session *Session) UpdateProfile(profile QualityProfile) error
Click to show internal directories.
Click to hide internal directories.