ingress

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 ValidateForSerialization(info *livekit.IngressInfo) error
• func ValidateVideoEncodingOptionsConsistency(options *livekit.IngressVideoEncodingOptions) error
• func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error

Variables

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

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

func ErrInvalidIngress

func ErrInvalidIngress(s string) psrpc.Error

func NewInvalidAudioParamsError

func NewInvalidAudioParamsError(s string) error

func NewInvalidTranscodingBypassError

func NewInvalidTranscodingBypassError(s string) error

func NewInvalidVideoParamsError

func NewInvalidVideoParamsError(s string) error

func Validate

func Validate(info *livekit.IngressInfo) error

func ValidateAudioEncodingOptionsConsistency

func ValidateAudioEncodingOptionsConsistency(options *livekit.IngressAudioEncodingOptions) error

func ValidateAudioOptionsConsistency

func ValidateAudioOptionsConsistency(options *livekit.IngressAudioOptions) error

func ValidateBypassTranscoding

func ValidateBypassTranscoding(info *livekit.IngressInfo) error

func ValidateForSerialization

func ValidateForSerialization(info *livekit.IngressInfo) error

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

func ValidateVideoEncodingOptionsConsistency

func ValidateVideoEncodingOptionsConsistency(options *livekit.IngressVideoEncodingOptions) error

func ValidateVideoOptionsConsistency

func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error