egress

Documentation

Index

• Constants
• Variables
• func BuildEgressToken(egressID, apiKey, secret, roomName string) (string, error)
• func GetOutputType(req interface{}) string
• func GetTypes(request interface{}) (string, string)
• func RedactAutoEncodedOutput(out AutoEncodedOutput)
• func RedactDirectOutputs(out DirectOutput)
• func RedactEncodedOutputs(out EncodedOutput)
• func RedactStreamKeys(stream *livekit.StreamOutput)
• func RedactUpload(req UploadRequest)
• type AutoEncodedOutput
• type DirectOutput
• type EncodedOutput
• type EncodedOutputDeprecated
• type UploadRequest

Constants

const (
	EgressTypeRoomComposite  = "room_composite"
	EgressTypeWeb            = "web"
	EgressTypeParticipant    = "participant"
	EgressTypeTrackComposite = "track_composite"
	EgressTypeTrack          = "track"

	OutputTypeFile     = "file"
	OutputTypeStream   = "stream"
	OutputTypeSegments = "segments"
	OutputTypeImages   = "images"
	OutputTypeMultiple = "multiple"

	Unknown = "unknown"
)

Variables

var (
	ErrNoResponse     = psrpc.NewErrorf(psrpc.Unavailable, "no response from egress service")
	ErrEgressTimedOut = psrpc.NewErrorf(psrpc.DeadlineExceeded, "egress timed out")
)

Functions

func BuildEgressToken

func BuildEgressToken(egressID, apiKey, secret, roomName string) (string, error)

func GetOutputType

func GetOutputType(req interface{}) string

func GetTypes

func GetTypes(request interface{}) (string, string)

func RedactAutoEncodedOutput

func RedactAutoEncodedOutput(out AutoEncodedOutput)

func RedactDirectOutputs

func RedactDirectOutputs(out DirectOutput)

func RedactEncodedOutputs

func RedactEncodedOutputs(out EncodedOutput)

func RedactStreamKeys

func RedactStreamKeys(stream *livekit.StreamOutput)

func RedactUpload

func RedactUpload(req UploadRequest)

Types

type AutoEncodedOutput

type AutoEncodedOutput interface {
	GetFileOutputs() []*livekit.EncodedFileOutput
	GetSegmentOutputs() []*livekit.SegmentedFileOutput
}

Outputs that can be used in egress that are started automatically on room creation

type DirectOutput

type DirectOutput interface {
	GetFile() *livekit.DirectFileOutput
	GetWebsocketUrl() string
}

type EncodedOutput

type EncodedOutput interface {
	AutoEncodedOutput
	GetStreamOutputs() []*livekit.StreamOutput
	GetImageOutputs() []*livekit.ImageOutput
}

type EncodedOutputDeprecated

type EncodedOutputDeprecated interface {
	GetFile() *livekit.EncodedFileOutput
	GetStream() *livekit.StreamOutput
	GetSegments() *livekit.SegmentedFileOutput
}

type UploadRequest

type UploadRequest interface {
	GetS3() *livekit.S3Upload
	GetGcp() *livekit.GCPUpload
	GetAzure() *livekit.AzureBlobUpload
	GetAliOSS() *livekit.AliOSSUpload
}