Documentation
¶
Index ¶
Constants ¶
View Source
const ( ProtocolVersion = 9 ServiceName = "piik-client" ControlSubprotocol = "piik-client-v9" MaxControlMessageBytes = 256 << 10 DefaultPortStart = 39721 DefaultPortEnd = 39730 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ControlEvent ¶ added in v1.5.6
ControlEvent retains a physical owner's validity through asynchronous queues. Current must only inspect ownership; it runs under the WebSocket write lock.
type ControlSession ¶
type ControlSession interface {
// Errors reject protocol violations and close this control connection.
// Valid operation failures return a response instead of ending the session.
// A nil response with no error is completed later through Events, using the request ID.
Handle(context.Context, []byte) (any, error)
Events() <-chan any
Close() error
}
type Health ¶
type Health struct {
Protocol int `json:"protocol"`
Service string `json:"service"`
Port int `json:"port"`
InstanceToken string `json:"instanceToken"`
NativeMedia NativeMediaCapabilities `json:"nativeMedia"`
}
type NativeMediaCapabilities ¶
type NativeMediaCapabilities struct {
ReceiverReuse bool `json:"receiverReuse,omitempty"`
Video bool `json:"video"`
CaptureBorderControl bool `json:"captureBorderControl,omitempty"`
Microphone bool `json:"microphone,omitempty"`
ProcessAudio bool `json:"processAudio"`
ProcessAudioExclusion bool `json:"processAudioExclusion,omitempty"`
SystemAudio bool `json:"systemAudio"`
HardwareH264 bool `json:"hardwareH264"`
SoftwareVP8 bool `json:"softwareVP8"`
}
type Options ¶
type Options struct {
PortStart int
PortEnd int
AllowedOrigins []string
NativeMedia NativeMediaCapabilities
NewControl func() ControlSession
Presentation func(language string)
}
Click to show internal directories.
Click to hide internal directories.