ingress

package

v1.15.0 Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 5 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/livekit/protocol

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BuildIngressToken(apiKey, secret, roomName, participantIdentity, participantName, ... string) (string, error)
func ErrInvalidIngress(s string) psrpc.Error
func NewInvalidAudioParamsError(s string) error
func NewInvalidTranscodingBypassError(s string) error
func NewInvalidVideoParamsError(s string) error
func Validate(info *livekit.IngressInfo) error
func ValidateAudioEncodingOptionsConsistency(options *livekit.IngressAudioEncodingOptions) error
func ValidateAudioOptionsConsistency(options *livekit.IngressAudioOptions) error
func ValidateBypassTranscoding(info *livekit.IngressInfo) error
func ValidateEnableTranscoding(info *livekit.IngressInfo) error
func ValidateForSerialization(info *livekit.IngressInfo) error
func ValidateVideoEncodingOptionsConsistency(options *livekit.IngressVideoEncodingOptions) error
func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrIngressOutOfDate        = psrpc.NewErrorf(psrpc.FailedPrecondition, "trying to ovewrite an ingress with an older version")
	ErrIngressTimedOut         = psrpc.NewErrorf(psrpc.DeadlineExceeded, "ingress timed out")
	ErrNoResponse              = psrpc.NewErrorf(psrpc.Unavailable, "no response from ingress service")
	ErrInvalidOutputDimensions = NewInvalidVideoParamsError("invalid output media dimensions")
	ErrInvalidIngressType      = psrpc.NewErrorf(psrpc.InvalidArgument, "invalid ingress type")
)

Functions ¶

func BuildIngressToken ¶ added in v1.0.2

func BuildIngressToken(apiKey, secret, roomName, participantIdentity, participantName, participantMetadata string) (string, error)

func ErrInvalidIngress ¶ added in v1.5.2

func ErrInvalidIngress(s string) psrpc.Error

func NewInvalidAudioParamsError ¶ added in v1.5.1

func NewInvalidAudioParamsError(s string) error

func NewInvalidTranscodingBypassError ¶ added in v1.5.8

func NewInvalidTranscodingBypassError(s string) error

func NewInvalidVideoParamsError ¶ added in v1.2.0

func NewInvalidVideoParamsError(s string) error

func Validate ¶ added in v1.5.2

func Validate(info *livekit.IngressInfo) error

func ValidateAudioEncodingOptionsConsistency ¶ added in v1.5.2

func ValidateAudioEncodingOptionsConsistency(options *livekit.IngressAudioEncodingOptions) error

func ValidateAudioOptionsConsistency ¶ added in v1.5.2

func ValidateAudioOptionsConsistency(options *livekit.IngressAudioOptions) error

func ValidateBypassTranscoding ¶ added in v1.5.8

func ValidateBypassTranscoding(info *livekit.IngressInfo) error

func ValidateEnableTranscoding ¶ added in v1.14.0

func ValidateEnableTranscoding(info *livekit.IngressInfo) error

func ValidateForSerialization ¶ added in v1.5.3

func ValidateForSerialization(info *livekit.IngressInfo) error

Sparse info with not all required fields populated are acceptable for serialization, provided values are consistent

func ValidateVideoEncodingOptionsConsistency ¶ added in v1.5.2

func ValidateVideoEncodingOptionsConsistency(options *livekit.IngressVideoEncodingOptions) error

func ValidateVideoOptionsConsistency ¶ added in v1.2.0

func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error

Types ¶

This section is empty.

Source Files ¶

View all Source files

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